Inheritance diagram for ilPageContent:

Collaboration diagram for ilPageContent:

Public Member Functions
	__construct ($a_dom)
	Constructor.
	init ()
	Init object.
	getType ()
	Get type of page content.
	setNode (&$a_node)
	Set xml node of page content.
&	getNode ()
	Get xml node of page content.
	setHierId ($a_hier_id)
	Set hierarchical ID in xml structure.
	getHierId ()
	Get hierarchical id.
	lookupHierId ()
	Get hierarchical id from dom.
	readHierId ()
	Read PC Id.
	setPcId ($a_pcid)
	Set PC Id.
	getPCId ()
	Get PC Id.
	readPCId ()
	Read PC Id.
	isGreaterHierId ($a, $b)
	Check whether Hier ID $a is greater than Hier ID $b.
	setEnabled ($value)
	Set Enabled value for page content component.
	enable ()
	Enable page content.
	disable ()
	Disable page content.
	isEnabled ()
	Check whether page content is enabled.
	createPageContentNode ($a_set_this_node=true)
	Create page content node (always use this method first when adding a new element)

Static Public Member Functions
static	incEdId ($ed_id)
	Increases an hierarchical editing id at lowest level (last number)
static	decEdId ($ed_id)
	Decreases an hierarchical editing id at lowest level (last number)
static	haveSameContainer ($ed_id1, $ed_id2)
	Check, if two ids are in same container.
static	sortHierIds ($a_array)
	Sort an array of Hier IDS in ascending order.

Data Fields
	$hier_id
	$node
	$dom

Protected Member Functions
	setType ($a_type)
	Set Type.

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:: class.ilPageContent.php 25624 2010-09-09 10:52:01Z akill

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

Constructor & Destructor Documentation

ilPageContent::__construct ( $a_dom )

final

Constructor.

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

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

References getType(), and init().

        {
                $this->dom = $a_dom;
                $this->init();
                if ($this->getType() == "")
                {
                        die ("Error: ilPageContent::init() did not set type");
                }
        }

Here is the call graph for this function:

Member Function Documentation

ilPageContent::createPageContentNode ( $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 $node.

Referenced by ilPCTable\addCell(), ilPCTable\create(), ilPCList\create(), ilPCContentInclude\create(), ilPCResources\create(), ilPCFileList\create(), ilPCDataTable\create(), ilPCTabs\create(), ilPCSection\create(), ilPCPlugged\create(), ilPCMap\create(), ilPCPlaceHolder\create(), ilPCQuestion\create(), ilPCMediaObject\create(), ilPCParagraph\createAfter(), ilPCParagraph\createAtNode(), 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:

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 184 of file class.ilPageContent.php.

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

ilPageContent::disable ( )

Disable page content.

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

References setEnabled().

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

Here is the call graph for this function:

ilPageContent::enable ( )

Enable page content.

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

References setEnabled().

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

Here is the call graph for this function:

ilPageContent::getHierId ( )

Get hierarchical id.

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

References $hier_id.

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

        {
                return $this->hier_id;
        }

Here is the caller graph for this function:

& ilPageContent::getNode ( )

Get xml node of page content.

Returns: object node object

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

References $node.

Referenced by ilPCTableData\deleteCol(), ilPCListItem\deleteItem(), ilPCTab\deleteItem(), ilPCFileItem\deleteItem(), ilPCTableData\deleteRow(), ilPCTableData\initTablePCNode(), ilPCTableData\moveColLeft(), ilPCTableData\moveColRight(), ilPCTab\moveItemDown(), ilPCListItem\moveItemDown(), ilPCFileItem\moveItemDown(), ilPCTab\moveItemUp(), ilPCListItem\moveItemUp(), ilPCFileItem\moveItemUp(), ilPCTableData\moveRowDown(), ilPCTableData\moveRowUp(), ilPCTableData\newColAfter(), ilPCTableData\newColBefore(), ilPCTab\newItemAfter(), ilPCFileItem\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:

ilPageContent::getPCId ( )

Get PC Id.

Returns: string PC Id

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

        {
                return $this->pcid;
        }

ilPageContent::getType ( )

Get type of page content.

Returns: string Type as defined by the page content component

Reimplemented in ilPCParagraph.

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

Referenced by __construct().

        {
                return $this->type;
        }

Here is the caller graph for this function:

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 200 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;
        }

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 169 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:

ilPageContent::init ( )

abstract

Init object.

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

Reimplemented in ilPCPlaceHolder, ilPCDataTable, ilPCTabs, ilPCMap, ilPCQuestion, ilPCSection, ilPCFileItem, ilPCFileList, ilPCListItem, ilPCPlugged, ilPCTab, ilPCTableData, ilPCTable, ilPCContentInclude, ilPCParagraph, ilPCResources, ilPCMediaObject, and ilPCList.

Referenced by __construct().

Here is the caller graph for this function:

ilPageContent::isEnabled ( )

final

Check whether page content is enabled.

Returns: boolean true/false

Definition at line 286 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;
        }

ilPageContent::isGreaterHierId	(	$a,
		$b
	)

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

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

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

ilPageContent::lookupHierId ( )

Get hierarchical id from dom.

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

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

ilPageContent::readHierId ( )

Read PC Id.

Returns: string PC Id

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

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

ilPageContent::readPCId ( )

Read PC Id.

Returns: string PC Id

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

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

ilPageContent::setEnabled ( $value )

Set Enabled value for page content component.

Parameters

string $value "True" | "False"

Definition at line 257 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:

ilPageContent::setHierId ( $a_hier_id )

Set hierarchical ID in xml structure.

Parameters

string $a_hier_id Hierarchical ID.

Reimplemented in ilPCMediaObject.

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

        {
                $this->hier_id = $a_hier_id;
        }

ilPageContent::setNode ( & $a_node )

Set xml node of page content.

Parameters

object $a_node node object

Reimplemented in ilPCPlaceHolder, ilPCTabs, ilPCMap, ilPCQuestion, ilPCSection, ilPCDataTable, ilPCPlugged, ilPCFileList, ilPCMediaObject, ilPCParagraph, ilPCContentInclude, ilPCResources, ilPCList, and ilPCTable.

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

        {
                $this->node =& $a_node;
        }

ilPageContent::setPcId ( $a_pcid )

Set PC Id.

Parameters

string $a_pcid PC Id

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

        {
                $this->pcid = $a_pcid;
        }

ilPageContent::setType ( $a_type )

finalprotected

Set Type.

Must be called in constructor.

Parameters

string $a_type type of page content component

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

Referenced by ilPCList\init(), ilPCMediaObject\init(), ilPCContentInclude\init(), ilPCParagraph\init(), ilPCResources\init(), ilPCTable\init(), ilPCTableData\init(), ilPCFileList\init(), ilPCPlugged\init(), ilPCFileItem\init(), ilPCListItem\init(), ilPCTab\init(), ilPCMap\init(), ilPCSection\init(), ilPCQuestion\init(), ilPCTabs\init(), ilPCDataTable\init(), and ilPCPlaceHolder\init().

        {
                $this->type = $a_type;
        }

Here is the caller graph for this function:

static ilPageContent::sortHierIds ( $a_array )

static

Sort an array of Hier IDS in ascending order.

Definition at line 223 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:

Field Documentation

ilPageContent::$dom

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

ilPageContent::$hier_id

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

Referenced by ilPCTableData\deleteCol(), ilPCFileList\deleteFileItems(), ilPCTable\getCaption(), ilPCTable\getCaptionAlign(), ilPCTabs\getCaptions(), ilPCFileList\getFileList(), getHierId(), ilPCTableData\moveColLeft(), ilPCTableData\moveColRight(), ilPCTableData\newColAfter(), ilPCTableData\newColBefore(), ilPCTabs\saveCaptions(), ilPCFileList\savePositions(), and ilPCTabs\savePositions().

ilPageContent::$node

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

Referenced by ilPCParagraph\createAfter(), ilPCParagraph\createAtNode(), createPageContentNode(), ilPCTable\extractText(), getNode(), ilPCTable\importCellAttributes(), ilPCTable\importHtml(), ilPCTable\importRow(), ilPCTable\importTableAttributes(), and ilPCParagraph\setText().

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

Services/COPage/classes/class.ilPageContent.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation