ilPageContent Class Reference

Class ilPageContent. More...

Inheritance diagram for ilPageContent:

Collaboration diagram for ilPageContent:

Public Member Functions
	__construct ($a_pg_obj)
	Constructor. More...
	setPage ($a_val)
	Set page. More...
	getPage ()
	Get page. More...
	init ()
	Init object. More...
	getType ()
	Get type of page content. More...
	setNode ($a_node)
	Set xml node of page content. More...
&	getNode ()
	Get xml node of page content. More...
	getJavascriptFiles ($a_mode)
	Get Javascript files. More...
	getCssFiles ($a_mode)
	Get css files. More...
	getOnloadCode ($a_mode)
	Get on load code. More...
	setHierId ($a_hier_id)
	Set hierarchical ID in xml structure. More...
	getHierId ()
	Get hierarchical id. More...
	lookupHierId ()
	Get hierarchical id from dom. More...
	readHierId ()
	Read PC Id. More...
	setPcId ($a_pcid)
	Set PC Id. More...
	getPCId ()
	Get PC Id. More...
	setFileDownloadLink ($a_download_link)
	Set file download link. More...
	getFileDownloadLink ()
	Get file download link. More...
	setProfileBackUrl ($url)
	getProfileBackUrl ()
	setFullscreenLink ($a_fullscreen_link)
	Set fullscreen link. More...
	getFullscreenLink ()
	Get fullscreen link. More...
	setSourcecodeDownloadScript ($script_name)
	Set sourcecode download script. More...
	getSourcecodeDownloadScript ()
	Get sourcecode download script. More...
	readPCId ()
	Read PC Id. More...
	writePCId ($a_pc_id)
	Write pc id. More...
	setEnabled ($value)
	Set Enabled value for page content component. More...
	enable ()
	Enable page content. More...
	disable ()
	Disable page content. More...
	isEnabled ()
	Check whether page content is enabled. More...
	createPageContentNode ($a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...
	modifyPageContentPostXsl ($a_output, $a_mode, $a_abstract_only=false)
	Modify page content after xsl. More...

Static Public Member Functions
static	incEdId ($ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...
static	decEdId ($ed_id)
	Decreases an hierarchical editing id at lowest level (last number) More...
static	haveSameContainer ($ed_id1, $ed_id2)
	Check, if two ids are in same container. More...
static	sortHierIds ($a_array)
	Sort an array of Hier IDS in ascending order. More...
static	isGreaterHierId ($a, $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, $a_self_ass=true, $a_clone_mobs=false)
	Handle copied content. More...
static	afterPageUpdate ($a_page, DOMDocument $a_domdoc, $a_xml, $a_creation)
	After page has been updated (or created) More...
static	beforePageDelete ($a_page)
	Before page is being deleted. More...
static	afterPageHistoryEntry ($a_page, DOMDocument $a_old_domdoc, $a_old_xml, $a_old_nr)
	After page history entry has been created. More...

Data Fields
	$hier_id
	$node
	$dom
	$page_lang

Protected Member Functions
	setType ($a_type)
	Set Type. More...

Protected Attributes
	$profile_back_url
	$file_download_link
	$fullscreen_link
	$sourcecode_download_script
	$log

Detailed Description

Class ilPageContent.

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

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilPageContent::__construct (   $a_pg_obj )

final

Constructor.

All initialisation in derived classes should go to the init() function

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

References ilLoggerFactory\getLogger(), getType(), init(), and setPage().

    {
        $this->log = ilLoggerFactory::getLogger('copg');
        $this->setPage($a_pg_obj);
        $this->dom = $a_pg_obj->getDom();
        $this->init();
        if ($this->getType() == "") {
            die("Error: ilPageContent::init() did not set type");
        }
    }

Here is the call graph for this function:

Member Function Documentation

afterPageHistoryEntry()

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

static

After page history entry has been created.

Parameters

object	$a_page	page object
DOMDocument	$a_old_domdoc	old dom document
string	$a_old_xml	old xml
integer	$a_old_nr	history number

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

    {
    }

afterPageUpdate()

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

static

After page has been updated (or created)

Parameters

object	$a_page	page object
DOMDocument	$a_domdoc	dom document
string	$a_xml	xml
bool	$a_creation	true on creation, otherwise false

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

    {
    }

beforePageDelete()

static ilPageContent::beforePageDelete (   $a_page )

static

Before page is being deleted.

Parameters

object

$a_page

page object

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

    {
    }

createPageContentNode()

ilPageContent::createPageContentNode

(

$a_set_this_node = true

)

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

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

References $node.

Referenced by ilPCTable\addCell(), ilPCFileList\create(), ilPCTable\create(), ilPCList\create(), ilPCQuestionOverview\create(), ilPCMap\create(), ilPCResources\create(), ilPCLearningHistory\create(), ilPCVerification\create(), ilPCProfile\create(), ilPCSkills\create(), ilPCMyCourses\create(), ilPCConsultationHours\create(), ilPCDataTable\create(), ilPCPlugged\create(), ilPCContentInclude\create(), ilPCPlaceHolder\create(), ilPCLoginPageElement\create(), ilPCTabs\create(), ilPCSection\create(), ilPCAMDPageList\create(), ilPCBlog\create(), ilPCGrid\create(), ilPCQuestion\create(), ilPCMediaObject\create(), ilPCInteractiveImage\create(), ilPCParagraph\createAfter(), ilPCParagraph\createAtNode(), ilPCParagraph\createBeforeNode(), ilPCDataTable\getCellNode(), and ilPCDataTable\makeEmptyCell().

    {
        $node = $this->dom->create_element("PageContent");
        if ($a_set_this_node) {
            $this->node = $node;
        }
        return $node;
    }

Here is the caller graph for this function:

decEdId()

static ilPageContent::decEdId (   $ed_id )

staticfinal

Decreases an hierarchical editing id at lowest level (last number)

Parameters

string

$ed_id

hierarchical ID

Returns

string hierarchical ID (decreased)

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

    {
        $id = explode("_", $ed_id);
        $id[count($id) - 1]--;

        return implode("_", $id);
    }

disable()

ilPageContent::disable

(

)

Disable page content.

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

References setEnabled().

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

Here is the call graph for this function:

enable()

ilPageContent::enable

(

)

Enable page content.

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

References setEnabled().

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

Here is the call graph for this function:

getCssFiles()

ilPageContent::getCssFiles

(

$a_mode

)

Get css files.

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

    {
        return [];
    }

getFileDownloadLink()

ilPageContent::getFileDownloadLink

(

)

Get file download link.

Returns

string

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

References $file_download_link.

Referenced by ilPCContentInclude\modifyPageContentPostXsl().

    {
        return $this->file_download_link;
    }

Here is the caller graph for this function:

getFullscreenLink()

ilPageContent::getFullscreenLink

(

)

Get fullscreen link.

Returns

string

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

References $fullscreen_link.

Referenced by ilPCContentInclude\modifyPageContentPostXsl().

    {
        return $this->fullscreen_link;
    }

Here is the caller graph for this function:

getHierId()

ilPageContent::getHierId

(

)

Get hierarchical id.

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

References $hier_id.

Referenced by ilPCTableData\deleteCol(), ilPCTable\getCaption(), ilPCTable\getCaptionAlign(), ilPCDataTable\getCellNode(), ilPCTableData\moveColLeft(), ilPCTableData\moveColRight(), ilPCTableData\newColAfter(), and ilPCTableData\newColBefore().

    {
        return $this->hier_id;
    }

Here is the caller graph for this function:

getJavascriptFiles()

ilPageContent::getJavascriptFiles

(

$a_mode

)

Get Javascript files.

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

    {
        return array();
    }

getLangVars()

static ilPageContent::getLangVars ( )

static

Get lang vars needed for editing.

Returns

array array of lang var keys

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

    {
        return array();
    }

getNode()

& ilPageContent::getNode

(

)

Get xml node of page content.

Returns

object node object

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

References $node.

Referenced by ilPCGridCell\deleteCell(), ilPCTableData\deleteCol(), ilPCListItem\deleteItem(), ilPCTab\deleteItem(), ilPCFileItem\deleteItem(), ilPCTableData\deleteRow(), ilPCTableData\initTablePCNode(), 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(), ilPCTab\newItemAfter(), ilPCListItem\newItemAfter(), ilPCTab\newItemBefore(), ilPCListItem\newItemBefore(), ilPCFileItem\newItemBefore(), ilPCTableData\newRowAfter(), and ilPCTableData\newRowBefore().

    {
        return $this->node;
    }

Here is the caller graph for this function:

getOnloadCode()

ilPageContent::getOnloadCode

(

$a_mode

)

Get on load code.

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

    {
        return array();
    }

getPage()

ilPageContent::getPage

(

)

Get page.

Returns

object page object

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

References init().

Referenced by ilPCContentTemplate\create(), ilPCAMDPageList\findPages(), ilPCTableData\fixHideAndSpans(), ilPCPlugged\getCssFiles(), ilPCQuestion\getCssFiles(), ilPCPlugged\getJavascriptFiles(), ilPCQuestion\getJavascriptFiles(), ilPCQuestion\getOnloadCode(), ilPCLearningHistory\getPresentation(), ilPCQuestion\getQuestionJsOfPage(), ilPCTable\importCell(), ilPCSourceCode\modifyPageContentPostXsl(), ilPCAMDPageList\modifyPageContentPostXsl(), ilPCContentInclude\modifyPageContentPostXsl(), ilPCPlugged\modifyPageContentPostXsl(), ilPCQuestion\modifyPageContentPostXsl(), ilPCMediaObject\modifyPageContentPostXsl(), ilPCParagraph\saveJS(), and ilPCParagraph\setText().

    {
        return $this->pg_obj;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPCId()

ilPageContent::getPCId

(

)

Get PC Id.

Returns

string PC Id

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

    {
        return $this->pcid;
    }

getProfileBackUrl()

ilPageContent::getProfileBackUrl

(

)

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

References $profile_back_url.

Referenced by ilPCContentInclude\modifyPageContentPostXsl().

    {
        return $this->profile_back_url;
    }

Here is the caller graph for this function:

getSourcecodeDownloadScript()

ilPageContent::getSourcecodeDownloadScript

(

)

Get sourcecode download script.

Returns

string

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

References $sourcecode_download_script.

Referenced by ilPCContentInclude\modifyPageContentPostXsl().

    {
        return $this->sourcecode_download_script;
    }

Here is the caller graph for this function:

getType()

ilPageContent::getType

(

)

Get type of page content.

Returns

string Type as defined by the page content component

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

References $type.

Referenced by __construct().

    {
        return $this->type;
    }

Here is the caller graph for this function:

handleCopiedContent()

static ilPageContent::handleCopiedContent ( DOMDocument  $a_domdoc,   $a_self_ass = true,   $a_clone_mobs = false  )

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

dom document

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

    {
    }

haveSameContainer()

static ilPageContent::haveSameContainer (   $ed_id1,   $ed_id2  )

staticfinal

Check, if two ids are in same container.

Parameters

string	$ed_id1	hierachical ID 1
string	$ed_id2	hierachical ID 2

Returns

boolean true/false

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

    {
        $id1 = explode("_", $ed_id1);
        $id2 = explode("_", $ed_id1);
        if (count($id1) == count($id2)) {
            array_pop($id1);
            array_pop($id2);
            foreach ($id1 as $key => $id) {
                if ($id != $id2[$key]) {
                    return false;
                }
            }
            return true;
        }
        return false;
    }

incEdId()

static ilPageContent::incEdId (   $ed_id )

staticfinal

Increases an hierarchical editing id at lowest level (last number)

Parameters

string

$ed_id

hierarchical ID

Returns

string hierarchical ID (increased)

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

Referenced by ilPageObject\addHierIDs().

    {
        $id = explode("_", $ed_id);
        $id[count($id) - 1]++;
        
        return implode("_", $id);
    }

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

Check whether page content is enabled.

Returns

boolean true/false

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

    {
        if (is_object($this->node) && $this->node->has_attribute("Enabled")) {
            $compare = $this->node->get_attribute("Enabled");
        } else {
            $compare = "True";
        }
        
        return strcasecmp($compare, "true") == 0;
    }

isGreaterHierId()

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

static

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

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

References Vendor\Package\$a, Vendor\Package\$b, and $i.

    {
        $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 true;
            } elseif ((int) $a_arr[$i] < (int) $b_arr[$i]) {
                return false;
            }
        }
        return false;
    }

lookupHierId()

ilPageContent::lookupHierId

(

)

Get hierarchical id from dom.

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

    {
        return $this->node->get_attribute("HierId");
    }

modifyPageContentPostXsl()

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

Modify page content after xsl.

Parameters

	$a_output
	$a_mode
bool	$a_abstract_only

Returns

string

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

    {
        return $a_output;
    }

readHierId()

ilPageContent::readHierId

(

)

Read PC Id.

Returns

string PC Id

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

Referenced by ilPCParagraph\getParagraphSequenceContent(), and ilPCInteractiveImage\setNode().

    {
        if (is_object($this->node)) {
            return $this->node->get_attribute("HierId");
        }
    }

Here is the caller graph for this function:

readPCId()

ilPageContent::readPCId

(

)

Read PC Id.

Returns

string PC Id

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

Referenced by ilPCParagraph\getParagraphSequenceContent(), and ilPCInteractiveImage\setNode().

    {
        if (is_object($this->node)) {
            return $this->node->get_attribute("PCID");
        }
    }

Here is the caller graph for this function:

setEnabled()

ilPageContent::setEnabled

(

$value

)

Set Enabled value for page content component.

Parameters

string

$value

"True" | "False"

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

Referenced by disable(), and enable().

    {
        if (is_object($this->node)) {
            $this->node->set_attribute("Enabled", $value);
        }
    }

Here is the caller graph for this function:

setFileDownloadLink()

ilPageContent::setFileDownloadLink

(

$a_download_link

)

Set file download link.

Parameters

string

$a_download_link

download link

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

    {
        $this->file_download_link = $a_download_link;
    }

setFullscreenLink()

ilPageContent::setFullscreenLink

(

$a_fullscreen_link

)

Set fullscreen link.

Parameters

string

$a_download_link

download link

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

    {
        $this->fullscreen_link = $a_fullscreen_link;
    }

setHierId()

ilPageContent::setHierId

(

$a_hier_id

)

Set hierarchical ID in xml structure.

Parameters

string

$a_hier_id

Hierarchical ID.

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

    {
        $this->hier_id = $a_hier_id;
    }

setNode()

ilPageContent::setNode

(

$a_node

)

Set xml node of page content.

Parameters

object

$a_node

node object

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

    {
        $this->node = $a_node;
    }

setPage()

ilPageContent::setPage

(

$a_val

)

Set page.

Parameters

object

$a_val

page object

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

Referenced by __construct().

    {
        $this->pg_obj = $a_val;
    }

Here is the caller graph for this function:

setPcId()

ilPageContent::setPcId

(

$a_pcid

)

Set PC Id.

Parameters

string

$a_pcid

PC Id

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

    {
        $this->pcid = $a_pcid;
    }

setProfileBackUrl()

ilPageContent::setProfileBackUrl

(

$url

)

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

References $url.

    {
        $this->profile_back_url = $url;
    }

setSourcecodeDownloadScript()

ilPageContent::setSourcecodeDownloadScript

(

$script_name

)

Set sourcecode download script.

Parameters

string

$script_name

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

    {
        $this->sourcecode_download_script = $script_name;
    }

setType()

ilPageContent::setType (   $a_type )

finalprotected

Set Type.

Must be called in constructor.

Parameters

string

$a_type

type of page content component

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

References $a_type.

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

    {
        $this->type = $a_type;
    }

Here is the caller graph for this function:

sortHierIds()

static ilPageContent::sortHierIds (   $a_array )

static

Sort an array of Hier IDS in ascending order.

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

Referenced by ilPageObject\copyContents().

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

Here is the caller graph for this function:

writePCId()

ilPageContent::writePCId

(

$a_pc_id

)

Write pc id.

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

    {
        if (is_object($this->node)) {
            $this->node->set_attribute("PCID", $a_pc_id);
        }
    }

Field Documentation

$dom

ilPageContent::$dom

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

$file_download_link

ilPageContent::$file_download_link

protected

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

Referenced by getFileDownloadLink().

$fullscreen_link

ilPageContent::$fullscreen_link

protected

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

Referenced by getFullscreenLink().

$hier_id

ilPageContent::$hier_id

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

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

$log

ilPageContent::$log

protected

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

$node

ilPageContent::$node

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

Referenced by ilPCQuestion\afterPageUpdate(), ilPCContentInclude\collectContentIncludes(), ilPCFileList\collectFileItems(), ilPCSkills\collectSkills(), ilPCParagraph\createAfter(), ilPCParagraph\createAtNode(), ilPCParagraph\createBeforeNode(), createPageContentNode(), ilPCTable\extractText(), ilPCParagraph\fixTextArray(), getNode(), ilPCPlugged\getPluginName(), ilPCAMDPageList\handleCopiedContent(), ilPCTable\handleCopiedContent(), ilPCTable\importCellAttributes(), ilPCTable\importHtml(), ilPCTable\importRow(), ilPCTable\importTableAttributes(), ilPCVerification\isInPortfolioPage(), ilPCParagraph\linkTermsInDom(), ilPCParagraph\saveAnchors(), ilPCParagraph\saveMetaKeywords(), ilPCMediaObject\saveMobUsage(), and ilPCParagraph\setText().

$page_lang

ilPageContent::$page_lang

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

$profile_back_url

ilPageContent::$profile_back_url

protected

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

Referenced by getProfileBackUrl().

$sourcecode_download_script

ilPageContent::$sourcecode_download_script

protected

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

Referenced by getSourcecodeDownloadScript().

---

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

• Services/COPage/classes/class.ilPageContent.php