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.

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

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 42 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

string internal links filter

Definition at line 171 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 462 of file class.ilPageConfig.php.

References $disable_default_qfeedback.

        {
                return $this->disable_default_qfeedback;
        }

ilPageConfig::getEnableActivation ( )

Get enabled actication.

Returns: bool page activation enabled?

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

References $activation.

        {
                return $this->activation;
        }

ilPageConfig::getEnableAnchors ( )

Get enable anchors.

Returns: boolean anchors

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

References $enable_anchors.

        {
                return $this->enable_anchors;
        }

ilPageConfig::getEnableInternalLinks ( )

Get Enable internal links.

Returns: boolean Enable internal links

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

References $enabledinternallinks.

        {
                return $this->enabledinternallinks;
        }

ilPageConfig::getEnableKeywords ( )

Get enable keywords handling.

Returns: boolean keywords handling

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

References $enable_keywords.

        {
                return $this->enable_keywords;
        }

ilPageConfig::getEnablePageToc ( )

Get enable page toc.

Returns: bool enable page toc?

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

References $page_toc.

        {
                return $this->page_toc;
        }

ilPageConfig::getEnablePCType ( $a_pc_type )

Get enable pc type.

Returns: boolean enable pc type true/false

Definition at line 81 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 369 of file class.ilPageConfig.php.

References $scheduled_activation.

        {
                return $this->scheduled_activation;
        }

ilPageConfig::getEnableSelfAssessment ( )

Get Enable Self Assessment Questions.

Returns: boolean Enable Self Assessment Questions

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

References $enabledselfassessment.

        {
                return $this->enabledselfassessment;
        }

ilPageConfig::getEnableSelfAssessmentScorm ( )

Is self assessment used in SCORM mode?

Returns: boolean Enable Self Assessment Questions

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

References $enabledselfassessment_scorm.

        {
                return $this->enabledselfassessment_scorm;
        }

ilPageConfig::getEnableWikiLinks ( )

Get Enable Wiki Links.

Returns: boolean Enable Wiki Links

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

References $enablewikilinks.

        {
                return $this->enablewikilinks;
        }

ilPageConfig::getIntLinkFilters ( )

Get internal links filter.

Returns: string internal links filter

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

References $int_link_filter.

        {
                return $this->int_link_filter;
        }

ilPageConfig::getIntLinkFilterWhiteList ( )

Get internal links filter type list to white list.

Returns: boolean white list

Definition at line 229 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 329 of file class.ilPageConfig.php.

References $int_link_def_id.

        {
                return $this->int_link_def_id;
        }

ilPageConfig::getIntLinkHelpDefaultType ( )

Get internal link default type.

Returns: string type

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

References $int_link_def_type.

        {
                return $this->int_link_def_type;
        }

ilPageConfig::getLocalizationLanguage ( )

Get localizazion language.

Returns: string lang key

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

        {
                return $this->localization_lang;
        }

ilPageConfig::getMultiLangSupport ( )

Get multi language support.

Returns: bool general multi language support?

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

References $multi_lang_support.

        {
                return $this->multi_lang_support;
        }

ilPageConfig::getPreventHTMLUnmasking ( )

Get Prevent HTML Unmasking (true/false).

Returns: boolean Prevent HTML Unmasking (true/false)

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

References $preventhtmlunmasking.

        {
                return $this->preventhtmlunmasking;
        }

ilPageConfig::getPreventRteUsage ( )

Get prevent rte usage.

Returns: boolean prevent rte usage

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

References $prevent_rte_usage.

        {
                return $this->prevent_rte_usage;
        }

ilPageConfig::getSinglePageMode ( )

Get single page mode.

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

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

References $single_page_mode.

        {
                return $this->single_page_mode;
        }

ilPageConfig::getUseAttachedContent ( )

Get use attached content.

Returns: string use initial attached content

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

References $use_attached_content.

        {
                return $this->use_attached_content;
        }

ilPageConfig::init ( )

Init.

Parameters

@return

Reimplemented in ilAssQuestionPageConfig, ilBlogPostingConfig, ilDataCollectionRecordViewViewdefinitionConfig, ilGlossaryDefPageConfig, ilLMPageConfig, ilMediaPoolPageConfig, ilPortfolioPageConfig, ilSCORM2004PageConfig, ilWikiPageConfig, ilLoginPageConfig, ilContainerPageConfig, ilImprintConfig, ilShopPageConfig, ilPageLayoutPageConfig, ilAssHintPageConfig, ilAssGenFeedbackPageConfig, ilAssSpecFeedbackPageConfig, and ilPortfolioTemplatePageConfig.

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

Referenced by __construct().

{

}

Here is the caller graph for this function:

ilPageConfig::removeIntLinkFilter ( $a_val )

Remove int link filter.

Parameters

string $a_val internal link filter

Definition at line 192 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_val disable feedback

Definition at line 452 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_val page activation enabled?

Definition at line 339 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

boolean anchors

Definition at line 111 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 )

Set Enable internal links.

Parameters

boolean $a_enabledinternallinks Enable internal links

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

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

        {
                $this->enabledinternallinks = $a_enabledinternallinks;
        }

Here is the caller graph for this function:

ilPageConfig::setEnableKeywords ( $a_val )

Set enable keywords handling.

Parameters

boolean keywords handling

Definition at line 91 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_val enable page toc?

Definition at line 379 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
	)

Set enable pc type.

Parameters

boolean $a_val enable pc type true/false

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

Referenced by __construct(), ilPortfolioTemplatePageConfig\init(), ilPageLayoutPageConfig\init(), ilLMPageConfig\init(), ilSCORM2004PageConfig\init(), ilLoginPageConfig\init(), ilContainerPageConfig\init(), ilWikiPageConfig\init(), ilShopPageConfig\init(), ilBlogPostingConfig\init(), ilPortfolioPageConfig\init(), ilAssQuestionPageConfig\init(), and setEnableSelfAssessment().

        {
                $this->pc_enabled[$a_pc_type] = $a_val;
        }

Here is the caller graph for this function:

ilPageConfig::setEnableScheduledActivation ( $a_val )

Set enable scheduled page activation.

Parameters

bool $a_val scheduled activated enabled?

Definition at line 359 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_enabledselfassessment Enable Self Assessment Questions

Definition at line 419 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_enablewikilinks Enable Wiki Links

Definition at line 151 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

boolean white list

Definition at line 219 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_val default object if

Definition at line 319 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_val type

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

Referenced by ilGlossaryDefPageConfig\init(), ilContainerPageConfig\init(), ilWikiPageConfig\init(), ilSCORM2004PageConfig\init(), and ilLMPageConfig\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_val lang key

Definition at line 259 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_val general multi language support?

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

Referenced by ilLMPageConfig\init(), and ilContainerPageConfig\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_preventhtmlunmasking Prevent HTML Unmasking (true/false)

Definition at line 399 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

boolean prevent rte usage

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

Referenced by ilLMPageConfig\init().

        {
                $this->prevent_rte_usage = $a_val;
        }

Here is the caller graph for this function:

ilPageConfig::setSinglePageMode ( $a_val )

Set single page mode.

Parameters

bool $a_val single page mode (only one page per parent_id)

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

Referenced by 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_val use initial attached content

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

Referenced by ilLMPageConfig\init().

        {
                $this->use_attached_content = $a_val;
        }

Here is the caller graph for this function:

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::$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().

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

Services/COPage/classes/class.ilPageConfig.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation