ilPCPlaceHolder Class Reference

Class ilPlaceHolder. More...

Inheritance diagram for ilPCPlaceHolder:

Collaboration diagram for ilPCPlaceHolder:

Public Member Functions
	init ()
	Init page content component.
	setNode (&$a_node)
	Set node.
	create (&$a_pg_obj, $a_hier_id)
	Create PlaceHolder Element.
	setContentClass ($a_class)
	Set Content Class.
	getContentClass ()
	Get Content Class.
	setHeight ($a_height)
	Set Height.
	getHeight ()
	Get Height.
	getClass ()
	Get characteristic of PlaceHolder.
Public Member Functions inherited from ilPageContent
	__construct ($a_dom)
	Constructor.
	getType ()
	Get type 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.
	writePCId ($a_pc_id)
	Write 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)

Data Fields
	$q_node
	$content_class
	$height
Data Fields inherited from ilPageContent
	$hier_id
	$node
	$dom

Additional Inherited Members
Static Public Member Functions inherited from ilPageContent
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.
Protected Member Functions inherited from ilPageContent
	setType ($a_type)
	Set Type.

Detailed Description

Class ilPlaceHolder.

List content object (see ILIAS DTD)

Version

$Id$

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

Member Function Documentation

ilPCPlaceHolder::create	(	&	$a_pg_obj,
			$a_hier_id
	)

Create PlaceHolder Element.

Definition at line 66 of file class.ilPCPlaceHolder.php.

References ilPageContent\createPageContentNode(), and IL_INSERT_AFTER.

        {
                $this->createPageContentNode();
                $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER);
                $this->q_node = $this->dom->create_element("PlaceHolder");
                $this->q_node = $this->node->append_child($this->q_node);
        }

Here is the call graph for this function:

ilPCPlaceHolder::getClass

(

)

Get characteristic of PlaceHolder.

Returns

string characteristic

Definition at line 134 of file class.ilPCPlaceHolder.php.

        {
                return "";
        }

ilPCPlaceHolder::getContentClass

(

)

Get Content Class.

Returns

string Content Class

Definition at line 92 of file class.ilPCPlaceHolder.php.

        {
                if (is_object($this->q_node))
                {
                        return $this->q_node->get_attribute("ContentClass", $a_class);
                }
                return false;
        }

ilPCPlaceHolder::getHeight

(

)

Get Height.

Returns

string Content Class

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

        {
                if (is_object($this->q_node))
                {
                        return $this->q_node->get_attribute("Height", $a_class);
                }
                return false;
        }

ilPCPlaceHolder::init

(

)

Init page content component.

Reimplemented from ilPageContent.

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

References ilPageContent\setType().

        {
                $this->setType("plach");
        }

Here is the call graph for this function:

ilPCPlaceHolder::setContentClass

(

$a_class

)

Set Content Class.

Parameters

string

$a_class

Content Class

Definition at line 79 of file class.ilPCPlaceHolder.php.

        {
                if (is_object($this->q_node))
                {
                        $this->q_node->set_attribute("ContentClass", $a_class);
                }
        }

ilPCPlaceHolder::setHeight

(

$a_height

)

Set Height.

Parameters

string

$a_height

Height

Definition at line 106 of file class.ilPCPlaceHolder.php.

        {
                if (is_object($this->q_node))
                {
                        $this->q_node->set_attribute("Height", $a_height);
                }
        }

ilPCPlaceHolder::setNode

(

&

$a_node

)

Set node.

Reimplemented from ilPageContent.

Definition at line 57 of file class.ilPCPlaceHolder.php.

        {
                parent::setNode($a_node);               // this is the PageContent node
                $this->q_node =& $a_node->first_child();                //... and this the PlaceHolder
        }

Field Documentation

ilPCPlaceHolder::$content_class

Definition at line 42 of file class.ilPCPlaceHolder.php.

ilPCPlaceHolder::$height

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

ilPCPlaceHolder::$q_node

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

---

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

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