ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilPageConfig Class Reference

Config class for page editing. More...

+ Inheritance diagram for ilPageConfig:
+ Collaboration diagram for ilPageConfig:

Public Member Functions

 __construct ()
 Constructor.
 init ()
 Init.
 setEnablePCType ($a_pc_type, $a_val)
 Set enable pc type.
 getEnablePCType ($a_pc_type)
 Get enable pc type.
 setEnableKeywords ($a_val)
 Set enable keywords handling.
 getEnableKeywords ()
 Get enable keywords handling.
 setEnableAnchors ($a_val)
 Set enable anchors.
 getEnableAnchors ()
 Get enable anchors.
 setEnableInternalLinks ($a_enabledinternallinks)
 Set Enable internal links.
 getEnableInternalLinks ()
 Get Enable internal links.
 setEnableWikiLinks ($a_enablewikilinks)
 Set Enable Wiki Links.
 getEnableWikiLinks ()
 Get Enable Wiki Links.
 addIntLinkFilter ($a_val)
 Add internal links filter.
 removeIntLinkFilter ($a_val)
 Remove int link filter.
 getIntLinkFilters ()
 Get internal links filter.
 setIntLinkFilterWhiteList ($a_white_list)
 Set internal links filter type list to white list.
 getIntLinkFilterWhiteList ()
 Get internal links filter type list to white list.
 setPreventRteUsage ($a_val)
 Set prevent rte usage.
 getPreventRteUsage ()
 Get prevent rte usage.
 setLocalizationLanguage ($a_val)
 Set localizazion language.
 getLocalizationLanguage ()
 Get localizazion language.
 setUseAttachedContent ($a_val)
 Set use attached content.
 getUseAttachedContent ()
 Get use attached content.
 setIntLinkHelpDefaultType ($a_val)
 Set internal link default type.
 getIntLinkHelpDefaultType ()
 Get internal link default type.
 setIntLinkHelpDefaultId ($a_val)
 Set internal link default id.
 getIntLinkHelpDefaultId ()
 Get internal link default id.
 setEnableActivation ($a_val)
 Set enabled actication.
 getEnableActivation ()
 Get enabled actication.
 setEnableScheduledActivation ($a_val)
 Set enable scheduled page activation.
 getEnableScheduledActivation ()
 Get enable scheduled page activation.
 setEnablePageToc ($a_val)
 Set enable page toc.
 getEnablePageToc ()
 Get enable page toc.
 setPreventHTMLUnmasking ($a_preventhtmlunmasking)
 Set Prevent HTML Unmasking (true/false).
 getPreventHTMLUnmasking ()
 Get Prevent HTML Unmasking (true/false).
 setEnableSelfAssessment ($a_enabledselfassessment, $a_scorm=true)
 Set Enable Self Assessment Questions.
 getEnableSelfAssessment ()
 Get Enable Self Assessment Questions.
 getEnableSelfAssessmentScorm ()
 Is self assessment used in SCORM mode?
 setDisableDefaultQuestionFeedback ($a_val)
 Set disable default question feedback.
 getDisableDefaultQuestionFeedback ()
 Get disable default question feedback.
 setMultiLangSupport ($a_val)
 Set multi language support.
 getMultiLangSupport ()
 Get multi language support.
 setSinglePageMode ($a_val)
 Set single page mode.
 getSinglePageMode ()
 Get single page mode.
 setQuestionHTML ($question_html)
 getQuestionHTML ()
 setUseStoredQuestionTries ($a_val)
 Set use stored answers/tries.
 getUseStoredQuestionTries ()
 Get use stored answers/tries.

Protected Attributes

 $int_link_filter = array("File")
 $prevent_rte_usage = false
 $use_attached_content = false
 $pc_defs = array()
 $pc_enabled = array()
 $enabledinternallinks = false
 $enable_keywords = false
 $enable_anchors = false
 $enablewikilinks = false
 $page_toc = false
 $activation = false
 $scheduled_activation = false
 $preventhtmlunmasking = false
 $enabledselfassessment = false
 $enabledselfassessment_scorm = false
 $int_link_def_type = ""
 $int_link_def_id = 0
 $multi_lang_support = false
 $single_page_mode = false
 $disable_default_qfeedback = false
 $question_html = array()
 $use_stored_tries = false

Detailed Description

Config class for page editing.

Author
Alex Killing <alex.killing.gmx.de>
Version
$Id$

Definition at line 12 of file class.ilPageConfig.php.

Constructor & Destructor Documentation

ilPageConfig::__construct ( )
final

Constructor.

Parameters
@return

Definition at line 44 of file class.ilPageConfig.php.

References ilCOPagePCDef\getPCDefinitions(), init(), and setEnablePCType().

{
// load pc_defs
include_once("./Services/COPage/classes/class.ilCOPagePCDef.php");
$this->pc_defs = ilCOPagePCDef::getPCDefinitions();
foreach ($this->pc_defs as $def)
{
$this->setEnablePCType($def["name"], (bool) $def["def_enabled"]);
}
$this->init();
}

+ Here is the call graph for this function:

Member Function Documentation

ilPageConfig::addIntLinkFilter (   $a_val)

Add internal links filter.

Parameters
stringinternal links filter

Definition at line 173 of file class.ilPageConfig.php.

References $lng, and setLocalizationLanguage().

Referenced by ilSCORM2004PageConfig\configureByObjectId(), ilWikiPageConfig\init(), and ilSCORM2004PageConfig\init().

{
global $lng;
$this->setLocalizationLanguage($lng->getLangKey());
if (is_array($a_val))
{
$this->int_link_filter =
array_merge($a_val, $this->int_link_filter);
}
else
{
$this->int_link_filter[] = $a_val;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilPageConfig::getDisableDefaultQuestionFeedback ( )

Get disable default question feedback.

Returns
bool disable feedback

Definition at line 464 of file class.ilPageConfig.php.

References $disable_default_qfeedback.

ilPageConfig::getEnableActivation ( )

Get enabled actication.

Returns
bool page activation enabled?

Definition at line 351 of file class.ilPageConfig.php.

References $activation.

{
}
ilPageConfig::getEnableAnchors ( )

Get enable anchors.

Returns
boolean anchors

Definition at line 123 of file class.ilPageConfig.php.

References $enable_anchors.

{
}
ilPageConfig::getEnableInternalLinks ( )

Get Enable internal links.

Returns
boolean Enable internal links

Definition at line 143 of file class.ilPageConfig.php.

References $enabledinternallinks.

ilPageConfig::getEnableKeywords ( )

Get enable keywords handling.

Returns
boolean keywords handling

Definition at line 103 of file class.ilPageConfig.php.

References $enable_keywords.

ilPageConfig::getEnablePageToc ( )

Get enable page toc.

Returns
bool enable page toc?

Definition at line 391 of file class.ilPageConfig.php.

References $page_toc.

{
}
ilPageConfig::getEnablePCType (   $a_pc_type)

Get enable pc type.

Returns
boolean enable pc type true/false

Definition at line 83 of file class.ilPageConfig.php.

{
return $this->pc_enabled[$a_pc_type];
}
ilPageConfig::getEnableScheduledActivation ( )

Get enable scheduled page activation.

Returns
bool scheduled activated enabled?

Definition at line 371 of file class.ilPageConfig.php.

References $scheduled_activation.

ilPageConfig::getEnableSelfAssessment ( )

Get Enable Self Assessment Questions.

Returns
boolean Enable Self Assessment Questions

Definition at line 434 of file class.ilPageConfig.php.

References $enabledselfassessment.

ilPageConfig::getEnableSelfAssessmentScorm ( )

Is self assessment used in SCORM mode?

Returns
boolean Enable Self Assessment Questions

Definition at line 444 of file class.ilPageConfig.php.

References $enabledselfassessment_scorm.

ilPageConfig::getEnableWikiLinks ( )

Get Enable Wiki Links.

Returns
boolean Enable Wiki Links

Definition at line 163 of file class.ilPageConfig.php.

References $enablewikilinks.

ilPageConfig::getIntLinkFilters ( )

Get internal links filter.

Returns
string internal links filter

Definition at line 211 of file class.ilPageConfig.php.

References $int_link_filter.

ilPageConfig::getIntLinkFilterWhiteList ( )

Get internal links filter type list to white list.

Returns
boolean white list

Definition at line 231 of file class.ilPageConfig.php.

{
return $this->link_filter_white_list;
}
ilPageConfig::getIntLinkHelpDefaultId ( )

Get internal link default id.

Returns
int default object if

Definition at line 331 of file class.ilPageConfig.php.

References $int_link_def_id.

ilPageConfig::getIntLinkHelpDefaultType ( )

Get internal link default type.

Returns
string type

Definition at line 311 of file class.ilPageConfig.php.

References $int_link_def_type.

ilPageConfig::getLocalizationLanguage ( )

Get localizazion language.

Returns
string lang key

Definition at line 271 of file class.ilPageConfig.php.

{
return $this->localization_lang;
}
ilPageConfig::getMultiLangSupport ( )

Get multi language support.

Returns
bool general multi language support?

Definition at line 484 of file class.ilPageConfig.php.

References $multi_lang_support.

ilPageConfig::getPreventHTMLUnmasking ( )

Get Prevent HTML Unmasking (true/false).

Returns
boolean Prevent HTML Unmasking (true/false)

Definition at line 411 of file class.ilPageConfig.php.

References $preventhtmlunmasking.

ilPageConfig::getPreventRteUsage ( )

Get prevent rte usage.

Returns
boolean prevent rte usage

Definition at line 251 of file class.ilPageConfig.php.

References $prevent_rte_usage.

ilPageConfig::getQuestionHTML ( )

Definition at line 514 of file class.ilPageConfig.php.

References $question_html.

{
}
ilPageConfig::getSinglePageMode ( )

Get single page mode.

Returns
bool single page mode (only one page per parent_id)

Definition at line 504 of file class.ilPageConfig.php.

References $single_page_mode.

ilPageConfig::getUseAttachedContent ( )

Get use attached content.

Returns
string use initial attached content

Definition at line 291 of file class.ilPageConfig.php.

References $use_attached_content.

ilPageConfig::getUseStoredQuestionTries ( )

Get use stored answers/tries.

Returns
bool use stored number of tries and given (correct) answers

Definition at line 534 of file class.ilPageConfig.php.

References $use_stored_tries.

ilPageConfig::removeIntLinkFilter (   $a_val)

Remove int link filter.

Parameters
string$a_valinternal link filter

Definition at line 194 of file class.ilPageConfig.php.

Referenced by ilLMPageConfig\init().

{
foreach ($this->int_link_filter as $k => $v)
{
if ($v == $a_val)
{
unset($this->int_link_filter[$k]);
}
}
}

+ Here is the caller graph for this function:

ilPageConfig::setDisableDefaultQuestionFeedback (   $a_val)

Set disable default question feedback.

Parameters
bool$a_valdisable feedback

Definition at line 454 of file class.ilPageConfig.php.

Referenced by ilLMPageConfig\configureByObjectId().

{
$this->disable_default_qfeedback = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setEnableActivation (   $a_val)

Set enabled actication.

Parameters
bool$a_valpage activation enabled?

Definition at line 341 of file class.ilPageConfig.php.

Referenced by ilBlogPostingConfig\init(), ilImprintConfig\init(), ilLMPageConfig\init(), and ilDataCollectionRecordViewViewdefinitionConfig\init().

{
$this->activation = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setEnableAnchors (   $a_val)

Set enable anchors.

Parameters
booleananchors

Definition at line 113 of file class.ilPageConfig.php.

Referenced by ilLMPageConfig\init(), and ilWikiPageConfig\init().

{
$this->enable_anchors = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setEnableInternalLinks (   $a_enabledinternallinks)
ilPageConfig::setEnableKeywords (   $a_val)

Set enable keywords handling.

Parameters
booleankeywords handling

Definition at line 93 of file class.ilPageConfig.php.

Referenced by ilGlossaryDefPageConfig\init(), and ilLMPageConfig\init().

{
$this->enable_keywords = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setEnablePageToc (   $a_val)

Set enable page toc.

Parameters
bool$a_valenable page toc?

Definition at line 381 of file class.ilPageConfig.php.

Referenced by ilWikiPageConfig\configureByObjectId().

{
$this->page_toc = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setEnablePCType (   $a_pc_type,
  $a_val 
)
ilPageConfig::setEnableScheduledActivation (   $a_val)

Set enable scheduled page activation.

Parameters
bool$a_valscheduled activated enabled?

Definition at line 361 of file class.ilPageConfig.php.

Referenced by ilLMPageConfig\init().

{
$this->scheduled_activation = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setEnableSelfAssessment (   $a_enabledselfassessment,
  $a_scorm = true 
)

Set Enable Self Assessment Questions.

Parameters
boolean$a_enabledselfassessmentEnable Self Assessment Questions

Definition at line 421 of file class.ilPageConfig.php.

References setEnablePCType().

Referenced by ilLMPageConfig\configureByObjectId(), ilSCORM2004PageConfig\init(), and ilLMPageConfig\init().

{
$this->setEnablePCType("Question", (bool) $a_enabledselfassessment);
$this->enabledselfassessment = $a_enabledselfassessment;
$this->enabledselfassessment_scorm = $a_scorm;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilPageConfig::setEnableWikiLinks (   $a_enablewikilinks)

Set Enable Wiki Links.

Parameters
boolean$a_enablewikilinksEnable Wiki Links

Definition at line 153 of file class.ilPageConfig.php.

Referenced by ilDataCollectionRecordViewViewdefinitionConfig\init(), ilImprintConfig\init(), and ilWikiPageConfig\init().

{
$this->enablewikilinks = $a_enablewikilinks;
}

+ Here is the caller graph for this function:

ilPageConfig::setIntLinkFilterWhiteList (   $a_white_list)

Set internal links filter type list to white list.

Parameters
booleanwhite list

Definition at line 221 of file class.ilPageConfig.php.

Referenced by ilSCORM2004PageConfig\init(), and ilWikiPageConfig\init().

{
$this->link_filter_white_list = $a_white_list;
}

+ Here is the caller graph for this function:

ilPageConfig::setIntLinkHelpDefaultId (   $a_val)

Set internal link default id.

Parameters
int$a_valdefault object if

Definition at line 321 of file class.ilPageConfig.php.

Referenced by ilGlossaryDefPageConfig\init(), and ilLMPageConfig\init().

{
$this->int_link_def_id = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setIntLinkHelpDefaultType (   $a_val)

Set internal link default type.

Parameters
string$a_valtype

Definition at line 301 of file class.ilPageConfig.php.

Referenced by ilLOPageConfig\init(), ilContainerStartObjectsPageConfig\init(), ilContainerPageConfig\init(), ilWikiPageConfig\init(), ilSCORM2004PageConfig\init(), ilLMPageConfig\init(), and ilGlossaryDefPageConfig\init().

{
$this->int_link_def_type = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setLocalizationLanguage (   $a_val)

Set localizazion language.

Parameters
string$a_vallang key

Definition at line 261 of file class.ilPageConfig.php.

Referenced by addIntLinkFilter(), and ilSCORM2004PageConfig\configureByObjectId().

{
$this->localization_lang = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setMultiLangSupport (   $a_val)

Set multi language support.

Parameters
bool$a_valgeneral multi language support?

Definition at line 474 of file class.ilPageConfig.php.

Referenced by ilLOPageConfig\init(), ilContainerStartObjectsPageConfig\init(), ilContainerPageConfig\init(), and ilLMPageConfig\init().

{
$this->multi_lang_support = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setPreventHTMLUnmasking (   $a_preventhtmlunmasking)

Set Prevent HTML Unmasking (true/false).

Parameters
boolean$a_preventhtmlunmaskingPrevent HTML Unmasking (true/false)

Definition at line 401 of file class.ilPageConfig.php.

Referenced by ilBlogPostingConfig\init(), ilPageLayoutPageConfig\init(), ilImprintConfig\init(), ilWikiPageConfig\init(), ilSCORM2004PageConfig\init(), ilPortfolioPageConfig\init(), ilMediaPoolPageConfig\init(), ilLMPageConfig\init(), and ilDataCollectionRecordViewViewdefinitionConfig\init().

{
$this->preventhtmlunmasking = $a_preventhtmlunmasking;
}

+ Here is the caller graph for this function:

ilPageConfig::setPreventRteUsage (   $a_val)

Set prevent rte usage.

Parameters
booleanprevent rte usage

Definition at line 241 of file class.ilPageConfig.php.

Referenced by ilLMPageConfig\init().

{
$this->prevent_rte_usage = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setQuestionHTML (   $question_html)

Definition at line 509 of file class.ilPageConfig.php.

References $question_html.

{
$this->question_html = $question_html;
}
ilPageConfig::setSinglePageMode (   $a_val)

Set single page mode.

Parameters
bool$a_valsingle page mode (only one page per parent_id)

Definition at line 494 of file class.ilPageConfig.php.

Referenced by ilLOPageConfig\init(), ilContainerStartObjectsPageConfig\init(), and ilContainerPageConfig\init().

{
$this->single_page_mode = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setUseAttachedContent (   $a_val)

Set use attached content.

Parameters
string$a_valuse initial attached content

Definition at line 281 of file class.ilPageConfig.php.

Referenced by ilLMPageConfig\init().

{
$this->use_attached_content = $a_val;
}

+ Here is the caller graph for this function:

ilPageConfig::setUseStoredQuestionTries (   $a_val)

Set use stored answers/tries.

Parameters
bool$a_valuse stored number of tries and given (correct) answers

Definition at line 524 of file class.ilPageConfig.php.

{
$this->use_stored_tries = $a_val;
}

Field Documentation

ilPageConfig::$activation = false
protected

Definition at line 24 of file class.ilPageConfig.php.

Referenced by getEnableActivation().

ilPageConfig::$disable_default_qfeedback = false
protected

Definition at line 34 of file class.ilPageConfig.php.

Referenced by getDisableDefaultQuestionFeedback().

ilPageConfig::$enable_anchors = false
protected

Definition at line 21 of file class.ilPageConfig.php.

Referenced by getEnableAnchors().

ilPageConfig::$enable_keywords = false
protected

Definition at line 20 of file class.ilPageConfig.php.

Referenced by getEnableKeywords().

ilPageConfig::$enabledinternallinks = false
protected

Definition at line 19 of file class.ilPageConfig.php.

Referenced by getEnableInternalLinks().

ilPageConfig::$enabledselfassessment = false
protected

Definition at line 27 of file class.ilPageConfig.php.

Referenced by getEnableSelfAssessment().

ilPageConfig::$enabledselfassessment_scorm = false
protected

Definition at line 28 of file class.ilPageConfig.php.

Referenced by getEnableSelfAssessmentScorm().

ilPageConfig::$enablewikilinks = false
protected

Definition at line 22 of file class.ilPageConfig.php.

Referenced by getEnableWikiLinks().

ilPageConfig::$int_link_def_id = 0
protected

Definition at line 30 of file class.ilPageConfig.php.

Referenced by getIntLinkHelpDefaultId().

ilPageConfig::$int_link_def_type = ""
protected

Definition at line 29 of file class.ilPageConfig.php.

Referenced by getIntLinkHelpDefaultType().

ilPageConfig::$int_link_filter = array("File")
protected

Definition at line 14 of file class.ilPageConfig.php.

Referenced by getIntLinkFilters().

ilPageConfig::$multi_lang_support = false
protected

Definition at line 31 of file class.ilPageConfig.php.

Referenced by getMultiLangSupport().

ilPageConfig::$page_toc = false
protected

Definition at line 23 of file class.ilPageConfig.php.

Referenced by getEnablePageToc().

ilPageConfig::$pc_defs = array()
protected

Definition at line 17 of file class.ilPageConfig.php.

ilPageConfig::$pc_enabled = array()
protected

Definition at line 18 of file class.ilPageConfig.php.

ilPageConfig::$prevent_rte_usage = false
protected

Definition at line 15 of file class.ilPageConfig.php.

Referenced by getPreventRteUsage().

ilPageConfig::$preventhtmlunmasking = false
protected

Definition at line 26 of file class.ilPageConfig.php.

Referenced by getPreventHTMLUnmasking().

ilPageConfig::$question_html = array()
protected

Definition at line 35 of file class.ilPageConfig.php.

Referenced by getQuestionHTML(), and setQuestionHTML().

ilPageConfig::$scheduled_activation = false
protected

Definition at line 25 of file class.ilPageConfig.php.

Referenced by getEnableScheduledActivation().

ilPageConfig::$single_page_mode = false
protected

Definition at line 32 of file class.ilPageConfig.php.

Referenced by getSinglePageMode().

ilPageConfig::$use_attached_content = false
protected

Definition at line 16 of file class.ilPageConfig.php.

Referenced by getUseAttachedContent().

ilPageConfig::$use_stored_tries = false
protected

Definition at line 36 of file class.ilPageConfig.php.

Referenced by getUseStoredQuestionTries().


The documentation for this class was generated from the following file: