ilPageContent Class Reference

Content object of ilPageObject (see ILIAS DTD). More...

Inheritance diagram for ilPageContent:

Collaboration diagram for ilPageContent:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?PageManagerInterface $page_manager=null, ?ObjectAdapterInterface $object_adapter=null)
	setPage (ilPageObject $a_val)
	getPage ()
	init ()
	Init object. More...
	getType ()
	getDomNode ()
	getDomDoc ()
	setDomNode (DOMNode $node)
	getChildNode ()
	getJavascriptFiles (string $a_mode)
	getCssFiles (string $a_mode)
	getOnloadCode (string $a_mode)
	setHierId (string $a_hier_id)
	getHierId ()
	lookupHierId ()
	readHierId ()
	setPcId (string $a_pcid)
	getPCId ()
	setFileDownloadLink (string $a_download_link)
	getFileDownloadLink ()
	setProfileBackUrl (string $url)
	getProfileBackUrl ()
	setFullscreenLink (string $a_fullscreen_link)
	getFullscreenLink ()
	setSourcecodeDownloadScript (string $script_name)
	getSourcecodeDownloadScript ()
	readPCId ()
	writePCId (string $a_pc_id)
	setEnabled (string $value)
	Set Enabled value for page content component. More...
	enable ()
	disable ()
	isEnabled ()
	createPageContentNode (bool $a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...
	getNewPageContentNode ()
	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...
	getModel ()
	Get model as needed for the front-end editor. More...

Static Public Member Functions
static	sortHierIds (array $a_array)
	Sort an array of Hier IDS in ascending order. More...
static	isGreaterHierId (string $a, string $b)
	Check whether Hier ID $a is greater than Hier ID $b. More...
static	getLangVars ()
	Get lang vars needed for editing. More...
static	handleCopiedContent (DOMDocument $a_domdoc, bool $a_self_ass=true, bool $a_clone_mobs=false, int $new_parent_id=0, int $obj_copy_id=0)
	Handle copied content. More...
static	afterPageUpdate (ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
	After page has been updated (or created) More...
static	beforePageDelete (ilPageObject $a_page)
	Before page is being deleted. More...
static	afterRepositoryCopy (ilPageObject $page, array $mapping, int $source_ref_id)
	After repository (container) copy action. More...
static	afterPageHistoryEntry (ilPageObject $a_page, DOMDocument $a_old_domdoc, string $a_old_xml, int $a_old_nr)
	After page history entry has been created. More...
static	deleteHistoryLowerEqualThan (string $parent_type, int $page_id, string $lang, int $delete_lower_than_nr)
	Overwrite in derived classes, if old history entries are being deleted. More...

Data Fields
string	$hier_id = ""
DOMNode	$dom_node = null
string	$page_lang = ""

Protected Member Functions
	getPageManager ()
	setType (string $a_type)
	Set Type. More...
	hasNode ()
	createInitialChildNode (string $hier_id, string $pc_id, string $child, array $child_attributes=[])

Protected Attributes
DOMDocument	$dom_doc
ILIAS COPage InternalDomainService	$domain
string	$pcid
string	$type = ""
ilPageObject	$pg_obj
string	$file_download_link
string	$fullscreen_link
string	$sourcecode_download_script
ilLogger	$log
string	$profile_back_url = ""
ILIAS COPage Dom DomUtil	$dom_util
PageManagerInterface	$page_manager = null
ObjectAdapterInterface	$object = null

Detailed Description

Content object of ilPageObject (see ILIAS DTD).

Every concrete object should be an instance of a class derived from ilPageContent (e.g. ilParagraph, ilMediaObject, ...)

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilPageContent::__construct ( ilPageObject  $a_pg_obj, ?PageManagerInterface  $page_manager = null, ?ObjectAdapterInterface  $object_adapter = null  )

final

Definition at line 51 of file class.ilPageContent.php.

References $DIC, ilPageObject\getDomDoc(), ilLoggerFactory\getLogger(), getType(), init(), and setPage().

      {
        global $DIC;

        $this->log = ilLoggerFactory::getLogger('copg');
        $this->setPage($a_pg_obj);
        $this->dom_doc = $a_pg_obj->getDomDoc();
        //$this->dom = $a_pg_obj->getDom();
        $this->domain = $DIC->copage()->internal()->domain();
        $this->init();
        if ($this->getType() == "") {
            die("Error: ilPageContent::init() did not set type");
        }
        $this->page_manager = $page_manager ?? $DIC->copage()
                                                   ->internal()
                                                   ->domain()
                                                   ->page();
        $this->object = $object_adapter ?? $DIC->copage()
                                                   ->internal()
                                                   ->domain()
                                                   ->object();
        $this->dom_util = $DIC->copage()->internal()->domain()->domUtil();
    }

Here is the call graph for this function:

Member Function Documentation

afterPageHistoryEntry()

static ilPageContent::afterPageHistoryEntry ( ilPageObject  $a_page, DOMDocument  $a_old_domdoc, string  $a_old_xml, int  $a_old_nr  )

static

After page history entry has been created.

Definition at line 400 of file class.ilPageContent.php.

     : void {
    }

afterPageUpdate()

static ilPageContent::afterPageUpdate ( ilPageObject  $a_page, DOMDocument  $a_domdoc, string  $a_xml, bool  $a_creation  )

static

After page has been updated (or created)

Definition at line 373 of file class.ilPageContent.php.

     : void {
    }

afterRepositoryCopy()

static ilPageContent::afterRepositoryCopy ( ilPageObject  $page, array  $mapping, int  $source_ref_id  )

static

After repository (container) copy action.

Definition at line 393 of file class.ilPageContent.php.

Referenced by ilPCPlugged\getPluginName().

                                                                                                      : void
    {
    }

Here is the caller graph for this function:

beforePageDelete()

static ilPageContent::beforePageDelete ( ilPageObject  $a_page )

static

Before page is being deleted.

Parameters

ilPageObject

$a_page

page object

Definition at line 385 of file class.ilPageContent.php.

     : void {
    }

createInitialChildNode()

ilPageContent::createInitialChildNode ( string  $hier_id, string  $pc_id, string  $child, array  $child_attributes = []  )

protected

Definition at line 317 of file class.ilPageContent.php.

References createPageContentNode(), getDomNode(), getPage(), and IL_INSERT_AFTER.

Referenced by ilPCFileList\create(), ilPCTable\create(), ilPCMap\create(), ilPCResources\create(), ilPCList\create(), ilPCTabs\create(), ilPCProfile\create(), ilPCSkills\create(), ilPCDataTable\create(), ilPCVerification\create(), ilPCBlog\create(), ilPCPlaceHolder\create(), ilPCSection\create(), ilPCPlugged\create(), ilPCContentInclude\create(), ilPCLoginPageElement\create(), ilPCGrid\create(), and ilPCQuestion\create().

     : void {
        $this->createPageContentNode();
        $node = $this->dom_doc->createElement($child);
        $node = $this->getDomNode()->appendChild($node);
        foreach ($child_attributes as $att => $value) {
            $node->setAttribute($att, $value);
        }
        $this->getPage()->insertContent($this, $hier_id, IL_INSERT_AFTER, $pc_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createPageContentNode()

ilPageContent::createPageContentNode

(

bool

$a_set_this_node = true

)

Create page content node (always use this method first when adding a new element)

Definition at line 303 of file class.ilPageContent.php.

References setDomNode().

Referenced by ilPCCurriculum\create(), ilPCLauncher\create(), ilPCLearningHistory\create(), ilPCPRGActionNote\create(), ilPCConsultationHours\create(), ilPCMyCourses\create(), ilPCPRGStatusInfo\create(), ilPCAMDPageList\create(), ilPCAMDForm\create(), ilPCMediaObject\create(), ilPCInteractiveImage\create(), ilPCParagraph\create(), and createInitialChildNode().

                                                                       : DomNode
    {
        $node = $this->dom_doc->createElement("PageContent");
        if ($a_set_this_node) {
            $this->setDomNode($node);
        }
        return $node;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteHistoryLowerEqualThan()

static ilPageContent::deleteHistoryLowerEqualThan ( string  $parent_type, int  $page_id, string  $lang, int  $delete_lower_than_nr  )

static

Overwrite in derived classes, if old history entries are being deleted.

Definition at line 419 of file class.ilPageContent.php.

     : void {
    }

disable()

ilPageContent::disable

(

)

Definition at line 284 of file class.ilPageContent.php.

References setEnabled().

Referenced by ilPageContentGUI\deactivate().

                             : void
    {
        $this->setEnabled("False");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

enable()

ilPageContent::enable

(

)

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

References setEnabled().

                            : void
    {
        $this->setEnabled("True");
    }

Here is the call graph for this function:

getChildNode()

ilPageContent::getChildNode

(

)

Definition at line 128 of file class.ilPageContent.php.

References getDomNode().

Referenced by ilPCGrid\addCell(), ilPCGrid\addGridCell(), ilPCList\addItems(), ilPCTable\addRow(), ilPCTabs\addTab(), ilPCFileList\appendItem(), ilPCParagraph\autoLinkGlossaries(), ilPCQuestion\copyPoolQuestionIntoPage(), ilPCFileList\deleteFileItems(), ilPCGrid\deleteGridCell(), ilPCTabs\deleteTab(), ilPCTable\fixHideAndSpans(), ilPCSection\getActiveFrom(), ilPCSection\getActiveTo(), ilPCLoginPageElement\getAlignment(), ilPCTable\getAllCellAlignments(), ilPCTable\getAllCellClasses(), ilPCTable\getAllCellSpans(), ilPCTable\getAllCellWidths(), ilPCFileList\getAllClasses(), ilPCParagraph\getAutoIndent(), ilPCTabs\getAutoTime(), ilPCTabs\getBehavior(), ilPCBlog\getBlogId(), ilPCMap\getCaption(), ilPCTabs\getCaptions(), ilPCGrid\getCellData(), ilPCSection\getCharacteristic(), ilPCParagraph\getCharacteristic(), ilPCLearningHistory\getClasses(), ilPCPlaceHolder\getContentClass(), ilPCTabs\getContentHeight(), ilPCContentInclude\getContentIncludeAttribute(), ilPCTabs\getContentWidth(), ilPCVerification\getData(), ilPCParagraph\getDownloadTitle(), ilPCProfile\getFields(), ilPCAMDPageList\getFieldValues(), ilPCFileList\getFileList(), ilPCLearningHistory\getFrom(), ilPCConsultationHours\getGroupIds(), ilPCPlaceHolder\getHeight(), ilPCMap\getHeight(), ilPCTabs\getHorizontalAlign(), ilPCMap\getHorizontalAlign(), ilPCResources\getItemGroupRefId(), ilPCList\getItemStyleClass(), ilPCFileList\getLanguage(), ilPCParagraph\getLanguage(), ilPCMap\getLatitude(), ilPCSection\getLink(), ilPCFileList\getListTitle(), ilPCList\getListType(), ilPCLoginPageElement\getLoginPageElementType(), ilPCMap\getLongitude(), ilPCResources\getMainType(), ilPCMediaObject\getMediaAliasNode(), ilPCProfile\getMode(), ilPCAMDPageList\getMode(), ilPCSection\getModel(), ilPCTable\getModel(), ilPCList\getNumberingType(), ilPCList\getOrderType(), ilPCSection\getPermission(), ilPCSection\getPermissionRefId(), ilPCPlugged\getPluginName(), ilPCPlugged\getPluginVersion(), ilPCBlog\getPostings(), ilPCPlugged\getProperties(), ilPCSection\getProtected(), ilPCQuestion\getQuestionReference(), ilPCTabs\getRandomStart(), ilPCAMDForm\getRecordIds(), ilPCResources\getResourceListType(), ilPCParagraph\getShowLineNumbers(), ilPCSkills\getSkillId(), ilPCMyCourses\getSorting(), ilPCList\getStartValue(), ilPCList\getStyleClass(), ilPCParagraph\getSubCharacteristic(), ilPCTable\getTableAttribute(), ilPCTabs\getTabType(), ilPCTabs\getTemplate(), ilPCParagraph\getText(), ilPCLearningHistory\getTo(), ilPCMap\getWidth(), ilPCMap\getZoom(), ilPCTabs\saveCaption(), ilPCTabs\saveCaptions(), ilPCGrid\savePositions(), ilPCTabs\savePositions(), ilPCFileList\savePositions(), ilPCFileList\saveStyleClasses(), ilPCGrid\saveWidths(), ilPCSection\setActiveFrom(), ilPCSection\setActiveTo(), ilPCLoginPageElement\setAlignment(), ilPCParagraph\setAutoIndent(), ilPCMap\setCaption(), ilPCTable\setCaption(), ilPCSection\setCharacteristic(), ilPCParagraph\setCharacteristic(), ilPCLearningHistory\setClasses(), ilPCPlaceHolder\setContentClass(), ilPCContentInclude\setContentIncludeAttribute(), ilPCSkills\setData(), ilPCVerification\setData(), ilPCBlog\setData(), ilPCConsultationHours\setData(), ilPCMyCourses\setData(), ilPCAMDPageList\setData(), ilPCParagraph\setDownloadTitle(), ilPCSection\setExtLink(), ilPCProfile\setFields(), ilPCTable\setFirstRowStyle(), ilPCLearningHistory\setFrom(), ilPCPlaceHolder\setHeight(), ilPCTable\setHorizontalAlign(), ilPCSection\setIntLink(), ilPCResources\setItemGroupRefId(), ilPCList\setItemStyleClass(), ilPCParagraph\setLanguage(), ilPCMap\setLatitude(), ilPCMap\setLayout(), ilPCFileList\setListTitle(), ilPCList\setListType(), ilPCLoginPageElement\setLoginPageElementType(), ilPCMap\setLongitude(), ilPCSection\setNoLink(), ilPCList\setNumberingType(), ilPCSection\setPermission(), ilPCSection\setPermissionRefId(), ilPCPlugged\setPluginName(), ilPCPlugged\setPluginVersion(), ilPCPlugged\setProperties(), ilPCSection\setProtected(), ilPCQuestion\setQuestionReference(), ilPCAMDForm\setRecordIds(), ilPCResources\setResourceListType(), ilPCParagraph\setShowLineNumbers(), ilPCList\setStartValue(), ilPCList\setStyleClass(), ilPCParagraph\setSubCharacteristic(), ilPCTable\setTableAttribute(), ilPCTabs\setTabsAttribute(), ilPCTable\setTDSpans(), ilPCParagraph\setText(), ilPCLearningHistory\setTo(), and ilPCMap\setZoom().

                                  : ?DOMNode
    {
        return $this->getDomNode()?->firstChild;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCssFiles()

ilPageContent::getCssFiles

(

string

$a_mode

)

Definition at line 138 of file class.ilPageContent.php.

                                               : array
    {
        return [];
    }

getDomDoc()

ilPageContent::getDomDoc

(

)

Definition at line 118 of file class.ilPageContent.php.

References $dom_doc.

Referenced by ilPCLayoutTemplate\create(), ilPCContentTemplate\create(), ilPCMediaObject\getFullscreenMediaAliasItem(), ilPCMediaObject\getStandardMediaAliasItem(), and ilPCInteractiveImage\setDomNode().

                               : DOMDocument
    {
        return $this->dom_doc;
    }

Here is the caller graph for this function:

getDomNode()

ilPageContent::getDomNode

(

)

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

References $dom_node.

Referenced by ilPCCurriculum\create(), ilPCLauncher\create(), ilPCLearningHistory\create(), ilPCConsultationHours\create(), ilPCMyCourses\create(), ilPCAMDPageList\create(), ilPCAMDForm\create(), ilPCParagraph\create(), ilPCMediaObject\createAlias(), ilPCInteractiveImage\createAlias(), createInitialChildNode(), ilPCGridCell\deleteCell(), ilPCTableData\deleteCol(), ilPCTab\deleteItem(), ilPCListItem\deleteItem(), ilPCFileItem\deleteItem(), ilPCTableData\deleteRow(), ilPCInteractiveImage\dumpXML(), ilPCMediaObject\dumpXML(), getChildNode(), ilPCFileItem\getListPCId(), ilPCTableData\initTablePCNode(), ILIAS\UI\Implementation\Component\Layout\Page\PageContentManager\insertContent(), isEnabled(), lookupHierId(), ilPCGridCell\moveCellLeft(), ilPCGridCell\moveCellRight(), ilPCTableData\moveColLeft(), ilPCTableData\moveColRight(), ilPCTab\moveItemDown(), ilPCListItem\moveItemDown(), ilPCFileItem\moveItemDown(), ilPCTab\moveItemUp(), ilPCListItem\moveItemUp(), ilPCFileItem\moveItemUp(), ilPCTableData\moveRowDown(), ilPCTableData\moveRowUp(), ilPCTableData\newColAfter(), ilPCTableData\newColBefore(), ilPCFileItem\newItemAfter(), ilPCListItem\newItemAfter(), ilPCTab\newItemAfter(), ilPCTab\newItemBefore(), ilPCListItem\newItemBefore(), ilPCFileItem\newItemBefore(), ilPCTableData\newRowAfter(), ilPCTableData\newRowBefore(), readHierId(), readPCId(), setEnabled(), ilPCParagraph\setText(), and writePCId().

                                : ?DOMNode
    {
        return $this->dom_node;
    }

Here is the caller graph for this function:

getFileDownloadLink()

ilPageContent::getFileDownloadLink

(

)

Definition at line 192 of file class.ilPageContent.php.

References $file_download_link.

Referenced by ilPCContentInclude\modifyPageContentPostXsl().

                                         : string
    {
        return $this->file_download_link;
    }

Here is the caller graph for this function:

getFullscreenLink()

ilPageContent::getFullscreenLink

(

)

Definition at line 212 of file class.ilPageContent.php.

References $fullscreen_link.

Referenced by ilPCContentInclude\modifyPageContentPostXsl().

                                       : string
    {
        return $this->fullscreen_link;
    }

Here is the caller graph for this function:

getHierId()

ilPageContent::getHierId

(

)

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

References $hier_id.

Referenced by ilPCTableData\deleteCol(), ilPCTable\getCaption(), ilPCTable\getCaptionAlign(), ilPCTable\getCellNode(), ilPCMediaObject\getFullscreenMediaAliasItem(), ilPCMediaObject\getStandardMediaAliasItem(), ilPCTable\getTableDataNode(), ilPCTableData\moveColLeft(), ilPCTableData\moveColRight(), ilPCTableData\newColAfter(), and ilPCTableData\newColBefore().

                               : string
    {
        return $this->hier_id;
    }

Here is the caller graph for this function:

getJavascriptFiles()

ilPageContent::getJavascriptFiles

(

string

$a_mode

)

Definition at line 133 of file class.ilPageContent.php.

                                                      : array
    {
        return array();
    }

getLangVars()

static ilPageContent::getLangVars ( )

static

Get lang vars needed for editing.

Returns

string[] array of lang var keys

Definition at line 336 of file class.ilPageContent.php.

                                        : array
    {
        return array();
    }

getModel()

ilPageContent::getModel

(

)

Get model as needed for the front-end editor.

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

References null.

                              : ?stdClass
    {
        return null;
    }

getNewPageContentNode()

ilPageContent::getNewPageContentNode

(

)

Definition at line 312 of file class.ilPageContent.php.

Referenced by ilPCTable\addCell(), ilPCParagraph\createAfter(), ilPCTable\getCellNode(), and ilPCDataTable\makeEmptyCell().

                                           : DOMNode
    {
        return $this->dom_doc->createElement("PageContent");
    }

Here is the caller graph for this function:

getOnloadCode()

ilPageContent::getOnloadCode

(

string

$a_mode

)

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

                                                 : array
    {
        return array();
    }

getPage()

ilPageContent::getPage

(

)

Definition at line 88 of file class.ilPageContent.php.

References $pg_obj, and init().

Referenced by ilPCTabs\addAbove(), ilPCTabs\addBelow(), ilPCLayoutTemplate\create(), ilPCContentTemplate\create(), createInitialChildNode(), ilPCTabs\deletePanel(), ilPCTableData\fixHideAndSpans(), ilPCQuestion\getCssFiles(), ilPCPlugged\getCssFiles(), ilPCMediaObject\getFullscreenMediaAliasItem(), ilPCQuestion\getJavascriptFiles(), ilPCPlugged\getJavascriptFiles(), ilPCTabs\getNodeXml(), ilPCQuestion\getOnloadCode(), ilPCLearningHistory\getPresentation(), ilPCQuestion\getQuestionIds(), ilPCQuestion\getQuestionJsOfPage(), ilPCAMDPageList\handleCopiedContent(), ilPCParagraph\insert(), ilPCAMDForm\isTemplate(), ilPCSourceCode\modifyPageContentPostXsl(), ilPCLauncher\modifyPageContentPostXsl(), ilPCCurriculum\modifyPageContentPostXsl(), ilPCPRGActionNote\modifyPageContentPostXsl(), ilPCPRGStatusInfo\modifyPageContentPostXsl(), ilPCAMDForm\modifyPageContentPostXsl(), ilPCTab\modifyPageContentPostXsl(), ilPCQuestion\modifyPageContentPostXsl(), ilPCAMDPageList\modifyPageContentPostXsl(), ilPCContentInclude\modifyPageContentPostXsl(), ilPCPlugged\modifyPageContentPostXsl(), ilPCMediaObject\modifyPageContentPostXsl(), ilPCTabs\moveBottom(), ilPCTabs\moveDown(), ilPCTabs\moveTop(), ilPCTabs\moveUp(), ilPCParagraph\saveJS(), and ilPCParagraph\setText().

                             : ilPageObject
    {
        return $this->pg_obj;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPageManager()

ilPageContent::getPageManager ( )

protected

Definition at line 78 of file class.ilPageContent.php.

References $page_manager.

Referenced by ilPCContentTemplate\getTemplatePage().

                                       : PageManagerInterface
    {
        return $this->page_manager;
    }

Here is the caller graph for this function:

getPCId()

ilPageContent::getPCId

(

)

Definition at line 182 of file class.ilPageContent.php.

References $pcid.

Referenced by ilPCInteractiveImage\deleteOverlay(), ilPCInteractiveImage\deletePopupByNr(), ilPCMediaObject\getFullscreenMediaAliasItem(), ilPCMediaObject\getStandardMediaAliasItem(), ilPCInteractiveImage\getTriggerNode(), ilPCInteractiveImage\getTriggers(), ilPCInteractiveImage\setExtLinkTitle(), ilPCInteractiveImage\setTriggerMarkerPositions(), ilPCInteractiveImage\setTriggerOverlayPositions(), ilPCInteractiveImage\setTriggerOverlays(), ilPCInteractiveImage\setTriggerPopupPositions(), ilPCInteractiveImage\setTriggerPopups(), ilPCInteractiveImage\setTriggerPopupSize(), and ilPCInteractiveImage\setTriggerTitles().

                             : string
    {
        return $this->pcid;
    }

Here is the caller graph for this function:

getProfileBackUrl()

ilPageContent::getProfileBackUrl

(

)

Definition at line 202 of file class.ilPageContent.php.

References $profile_back_url.

Referenced by ilPCContentInclude\modifyPageContentPostXsl().

                                       : string
    {
        return $this->profile_back_url;
    }

Here is the caller graph for this function:

getSourcecodeDownloadScript()

ilPageContent::getSourcecodeDownloadScript

(

)

Definition at line 222 of file class.ilPageContent.php.

References $sourcecode_download_script.

Referenced by ilPCContentInclude\modifyPageContentPostXsl().

                                                 : string
    {
        return $this->sourcecode_download_script;
    }

Here is the caller graph for this function:

getType()

ilPageContent::getType

(

)

Definition at line 108 of file class.ilPageContent.php.

References $type.

Referenced by __construct(), ilGlossaryDefPage\beforePageContentUpdate(), ilLMPage\beforePageContentUpdate(), ilPageEditorGUI\characteristic(), and ilPageEditorGUI\executeCommand().

                             : string
    {
        return $this->type;
    }

Here is the caller graph for this function:

handleCopiedContent()

static ilPageContent::handleCopiedContent ( DOMDocument  $a_domdoc, bool  $a_self_ass = true, bool  $a_clone_mobs = false, int  $new_parent_id = 0, int  $obj_copy_id = 0  )

static

Handle copied content.

This function must, e.g. create copies of objects referenced within the content (e.g. question objects)

Parameters

DOMDocument	$a_domdoc
bool	$a_self_ass
bool	$a_clone_mobs
int	$new_parent_id
int	$obj_copy_id

Definition at line 350 of file class.ilPageContent.php.

     : void {
    }

hasNode()

ilPageContent::hasNode ( )

protected

Definition at line 164 of file class.ilPageContent.php.

Referenced by isEnabled(), readHierId(), readPCId(), setEnabled(), and writePCId().

                                : bool
    {
        return is_object($this->dom_node);
    }

Here is the caller graph for this function:

init()

ilPageContent::init ( )

abstract

Init object.

This function must be overwritten and at least set the content type.

Referenced by __construct(), and getPage().

Here is the caller graph for this function:

isEnabled()

ilPageContent::isEnabled ( )

final

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

References getDomNode(), and hasNode().

                                     : bool
    {
        if ($this->hasNode() && $this->getDomNode()->hasAttribute("Enabled")) {
            $compare = $this->getDomNode()->getAttribute("Enabled");
        } else {
            $compare = "True";
        }

        return strcasecmp($compare, "true") == 0;
    }

Here is the call graph for this function:

isGreaterHierId()

static ilPageContent::isGreaterHierId ( string  $a, string  $b  )

static

Check whether Hier ID $a is greater than Hier ID $b.

Definition at line 254 of file class.ilPageContent.php.

References ILIAS\Repository\int().

                                                                : int
    {
        $a_arr = explode("_", $a);
        $b_arr = explode("_", $b);
        for ($i = 0; $i < count($a_arr); $i++) {
            if ((int) $a_arr[$i] > (int) $b_arr[$i]) {
                return +1;
            } elseif ((int) $a_arr[$i] < (int) $b_arr[$i]) {
                return -1;
            }
        }
        return 0;
    }

Here is the call graph for this function:

lookupHierId()

ilPageContent::lookupHierId

(

)

Definition at line 159 of file class.ilPageContent.php.

References getDomNode().

                                  : string
    {
        return $this->getDomNode()->getAttribute("HierId");
    }

Here is the call graph for this function:

modifyPageContentPostXsl()

ilPageContent::modifyPageContentPostXsl	(	string	$a_output,
		string	$a_mode,
		bool	$a_abstract_only = false
	)

Modify page content after xsl.

Definition at line 362 of file class.ilPageContent.php.

     : string {
        return $a_output;
    }

readHierId()

ilPageContent::readHierId

(

)

Definition at line 169 of file class.ilPageContent.php.

References getDomNode(), and hasNode().

Referenced by ilPCInteractiveImage\setDomNode().

                                : string
    {
        if ($this->hasNode()) {
            return $this->getDomNode()->getAttribute("HierId");
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readPCId()

ilPageContent::readPCId

(

)

Definition at line 227 of file class.ilPageContent.php.

References getDomNode(), and hasNode().

Referenced by ilPCInteractiveImage\setDomNode().

                              : string
    {
        if ($this->hasNode()) {
            return $this->getDomNode()->getAttribute("PCID");
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDomNode()

ilPageContent::setDomNode

(

DOMNode

$node

)

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

Referenced by ilPCParagraph\createAfter(), ilPCMediaObject\createAlias(), createPageContentNode(), and ILIAS\UI\Implementation\Component\Layout\Page\PageContentManager\insertContent().

                                             : void
    {
        $this->dom_node = $node;
    }

Here is the caller graph for this function:

setEnabled()

ilPageContent::setEnabled

(

string

$value

)

Set Enabled value for page content component.

Parameters

string

$value

"True" | "False"

Definition at line 272 of file class.ilPageContent.php.

References getDomNode(), and hasNode().

Referenced by disable(), and enable().

                                             : void
    {
        if ($this->hasNode()) {
            $this->getDomNode()->setAttribute("Enabled", $value);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setFileDownloadLink()

ilPageContent::setFileDownloadLink

(

string

$a_download_link

)

Definition at line 187 of file class.ilPageContent.php.

                                                                : void
    {
        $this->file_download_link = $a_download_link;
    }

setFullscreenLink()

ilPageContent::setFullscreenLink

(

string

$a_fullscreen_link

)

Definition at line 207 of file class.ilPageContent.php.

                                                                : void
    {
        $this->fullscreen_link = $a_fullscreen_link;
    }

setHierId()

ilPageContent::setHierId

(

string

$a_hier_id

)

Definition at line 148 of file class.ilPageContent.php.

                                                : void
    {
        $this->hier_id = $a_hier_id;
    }

setPage()

ilPageContent::setPage

(

ilPageObject

$a_val

)

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

Referenced by __construct().

                                                : void
    {
        $this->pg_obj = $a_val;
    }

Here is the caller graph for this function:

setPcId()

ilPageContent::setPcId

(

string

$a_pcid

)

Definition at line 177 of file class.ilPageContent.php.

                                           : void
    {
        $this->pcid = $a_pcid;
    }

setProfileBackUrl()

ilPageContent::setProfileBackUrl

(

string

$url

)

Definition at line 197 of file class.ilPageContent.php.

References $url.

                                                  : void
    {
        $this->profile_back_url = $url;
    }

setSourcecodeDownloadScript()

ilPageContent::setSourcecodeDownloadScript

(

string

$script_name

)

Definition at line 217 of file class.ilPageContent.php.

                                                                    : void
    {
        $this->sourcecode_download_script = $script_name;
    }

setType()

ilPageContent::setType ( string  $a_type )

finalprotected

Set Type.

Must be called in constructor.

Parameters

string

$a_type

type of page content component

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

Referenced by ilPCFileList\init(), ilPCListItem\init(), ilPCTable\init(), ilPCMap\init(), ilPCContentTemplate\init(), ilPCFileItem\init(), ilPCResources\init(), ilPCTableData\init(), ilPCLearningHistory\init(), ilPCProfile\init(), ilPCConsultationHours\init(), ilPCMyCourses\init(), ilPCList\init(), ilPCSkills\init(), ilPCGridCell\init(), ilPCTab\init(), ilPCAMDForm\init(), ilPCContentPopup\init(), ilPCLayoutTemplate\init(), ilPCSourceCode\init(), ilPCGrid\init(), ilPCTabs\init(), ilPCSection\init(), ilPCVerification\init(), ilPCCurriculum\init(), ilPCPlugged\init(), ilPCLauncher\init(), ilPCPlaceHolder\init(), ilPCDataTable\init(), ilPCBlog\init(), ilPCAMDPageList\init(), ilPCPRGStatusInfo\init(), ilPCPRGActionNote\init(), ilPCQuestion\init(), ilPCContentInclude\init(), ilPCMediaObject\init(), ilPCInteractiveImage\init(), ilPCLoginPageElement\init(), and ilPCParagraph\init().

                                                    : void
    {
        $this->type = $a_type;
    }

Here is the caller graph for this function:

sortHierIds()

static ilPageContent::sortHierIds ( array  $a_array )

static

Sort an array of Hier IDS in ascending order.

Definition at line 245 of file class.ilPageContent.php.

Referenced by ILIAS\UI\Implementation\Component\Layout\Page\PageContentManager\copyContents().

                                                      : array
    {
        uasort($a_array, array("ilPageContent", "isGreaterHierId"));
        return $a_array;
    }

Here is the caller graph for this function:

writePCId()

ilPageContent::writePCId

(

string

$a_pc_id

)

Definition at line 235 of file class.ilPageContent.php.

References getDomNode(), and hasNode().

                                              : void
    {
        if ($this->hasNode()) {
            $this->getDomNode()->setAttribute("PCID", $a_pc_id);
        }
    }

Here is the call graph for this function:

Field Documentation

$dom_doc

DOMDocument ilPageContent::$dom_doc

protected

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

Referenced by getDomDoc().

$dom_node

DOMNode ilPageContent::$dom_node = null

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

Referenced by getDomNode().

$dom_util

ILIAS COPage Dom DomUtil ilPageContent::$dom_util

protected

Definition at line 47 of file class.ilPageContent.php.

Referenced by ilPCTabs\addAbove(), ilPCTabs\addBelow(), ilPCPlugged\getPluginName(), ilPCQuestion\handleCopiedContent(), ilPCInteractiveImage\handleCopiedContent(), ilPCMediaObject\handleCopiedContent(), and ilPCSection\saveTimings().

$domain

ILIAS COPage InternalDomainService ilPageContent::$domain

protected

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

$file_download_link

string ilPageContent::$file_download_link

protected

Definition at line 39 of file class.ilPageContent.php.

Referenced by getFileDownloadLink().

$fullscreen_link

string ilPageContent::$fullscreen_link

protected

Definition at line 41 of file class.ilPageContent.php.

Referenced by getFullscreenLink().

$hier_id

string ilPageContent::$hier_id = ""

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

Referenced by ilPCLayoutTemplate\create(), ilPCContentTemplate\create(), ilPCTableData\deleteCol(), ilPCFileList\deleteFileItems(), ilPCTable\getCaption(), ilPCTable\getCaptionAlign(), ilPCTabs\getCaptions(), ilPCGrid\getCellData(), ilPCFileList\getFileList(), getHierId(), ilPCParagraph\getLastSavedPCId(), ilPCInteractiveImage\getPopups(), ilPCTableData\moveColLeft(), ilPCTableData\moveColRight(), ilPCTableData\newColAfter(), ilPCTableData\newColBefore(), ilPCTabs\saveCaptions(), ilPCInteractiveImage\savePopups(), ilPCGrid\savePositions(), ilPCTabs\savePositions(), ilPCFileList\savePositions(), and ilPCGrid\saveWidths().

$log

ilLogger ilPageContent::$log

protected

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

Referenced by ilPCParagraph\_input2xml(), ilPCMediaObject\deleteHistoryLowerEqualThan(), and ilPCResources\modifyItemGroupRefIdsByMapping().

$object

ObjectAdapterInterface ilPageContent::$object = null

protected

Definition at line 49 of file class.ilPageContent.php.

$page_lang

string ilPageContent::$page_lang = ""

Definition at line 37 of file class.ilPageContent.php.

$page_manager

PageManagerInterface ilPageContent::$page_manager = null

protected

Definition at line 48 of file class.ilPageContent.php.

Referenced by getPageManager().

$pcid

string ilPageContent::$pcid

protected

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

Referenced by getPCId().

$pg_obj

ilPageObject ilPageContent::$pg_obj

protected

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

Referenced by getPage().

$profile_back_url

string ilPageContent::$profile_back_url = ""

protected

Definition at line 45 of file class.ilPageContent.php.

Referenced by getProfileBackUrl().

$sourcecode_download_script

string ilPageContent::$sourcecode_download_script

protected

Definition at line 43 of file class.ilPageContent.php.

Referenced by getSourcecodeDownloadScript().

$type

string ilPageContent::$type = ""

protected

Definition at line 33 of file class.ilPageContent.php.

Referenced by ilPCContentInclude\collectContentIncludes(), and getType().

---

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

• components/ILIAS/COPage/classes/class.ilPageContent.php