ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
ilPCPlaceHolder Class Reference

Class ilPlaceHolder. More...

+ Inheritance diagram for ilPCPlaceHolder:
+ Collaboration diagram for ilPCPlaceHolder:

Public Member Functions

 init ()
 Init page content component. More...
 
 setNode (&$a_node)
 Set node. More...
 
 create (&$a_pg_obj, $a_hier_id)
 Create PlaceHolder Element. More...
 
 setContentClass ($a_class)
 Set Content Class. More...
 
 getContentClass ()
 Get Content Class. More...
 
 setHeight ($a_height)
 Set Height. More...
 
 getHeight ()
 Get Height. More...
 
 getClass ()
 Get characteristic of PlaceHolder. More...
 
- Public Member Functions inherited from ilPageContent
 __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 ()
 Get Javascript files. More...
 
 getCssFiles ()
 Get css files. More...
 
 getOnloadCode ()
 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...
 
 readPCId ()
 Read PC Id. More...
 
 writePCId ($a_pc_id)
 Write pc id. More...
 
 isGreaterHierId ($a, $b)
 Check whether Hier ID $a is greater than Hier ID $b. 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)
 Modify page content after xsl. More...
 

Static Public Member Functions

static getLangVars ()
 Get lang vars needed for editing. More...
 
- Static Public Member Functions inherited from ilPageContent
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 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

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

Additional Inherited Members

- Protected Member Functions inherited from ilPageContent
 setType ($a_type)
 Set Type. More...
 

Detailed Description

Class ilPlaceHolder.

List content object (see ILIAS DTD)

Version
$Id$

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

Member Function Documentation

◆ create()

ilPCPlaceHolder::create ( $a_pg_obj,
  $a_hier_id 
)

Create PlaceHolder Element.

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

References ilPageContent\createPageContentNode(), and IL_INSERT_AFTER.

47  {
48  $this->createPageContentNode();
49  $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER);
50  $this->q_node = $this->dom->create_element("PlaceHolder");
51  $this->q_node = $this->node->append_child($this->q_node);
52  }
const IL_INSERT_AFTER
createPageContentNode($a_set_this_node=true)
Create page content node (always use this method first when adding a new element) ...
+ Here is the call graph for this function:

◆ getClass()

ilPCPlaceHolder::getClass ( )

Get characteristic of PlaceHolder.

Returns
string characteristic

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

115  {
116  return "";
117  }

◆ getContentClass()

ilPCPlaceHolder::getContentClass ( )

Get Content Class.

Returns
string Content Class

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

73  {
74  if (is_object($this->q_node))
75  {
76  return $this->q_node->get_attribute("ContentClass", $a_class);
77  }
78  return false;
79  }

◆ getHeight()

ilPCPlaceHolder::getHeight ( )

Get Height.

Returns
string Content Class

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

101  {
102  if (is_object($this->q_node))
103  {
104  return $this->q_node->get_attribute("Height", $a_class);
105  }
106  return false;
107  }

◆ getLangVars()

static ilPCPlaceHolder::getLangVars ( )
static

Get lang vars needed for editing.

Returns
array array of lang var keys

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

124  {
125  return array("question_placeh","media_placeh","text_placeh",
126  "ed_insert_plach","question_placehl","media_placehl","text_placehl",
127  "verification_placeh", "verification_placehl");
128  }

◆ init()

ilPCPlaceHolder::init ( )

Init page content component.

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

References ilPageContent\setType().

29  {
30  $this->setType("plach");
31  }
setType($a_type)
Set Type.
+ Here is the call graph for this function:

◆ setContentClass()

ilPCPlaceHolder::setContentClass (   $a_class)

Set Content Class.

Parameters
string$a_classContent Class

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

60  {
61  if (is_object($this->q_node))
62  {
63  $this->q_node->set_attribute("ContentClass", $a_class);
64  }
65  }

◆ setHeight()

ilPCPlaceHolder::setHeight (   $a_height)

Set Height.

Parameters
string$a_heightHeight

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

87  {
88  if (is_object($this->q_node))
89  {
90  $this->q_node->set_attribute("Height", $a_height);
91  }
92  }

◆ setNode()

ilPCPlaceHolder::setNode ( $a_node)

Set node.

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

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

Field Documentation

◆ $content_class

ilPCPlaceHolder::$content_class

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

◆ $height

ilPCPlaceHolder::$height

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

◆ $q_node

ilPCPlaceHolder::$q_node

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


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