Inheritance diagram for ilPCTabs:

Collaboration diagram for ilPCTabs:

Public Member Functions
	init ()
	Init page content component. More...

	setNode (&$a_node)
	Set content node. More...

	create (&$a_pg_obj, $a_hier_id, $a_pc_id="")
	Create new Tabs node. More...

	setTabType ($a_type="HorizontalTabs")
	Set type of tabs. More...

	getTabType ()
	Get type of tabs. More...

	setContentWidth ($a_val)
	Set content width. More...

	getContentWidth ()
	Get content width. More...

	setContentHeight ($a_val)
	Set content height. More...

	getContentHeight ()
	Get content height. More...

	setHorizontalAlign ($a_val)
	Set horizontal align. More...

	getHorizontalAlign ()
	Get horizontal align. More...

	setBehavior ($a_val)
	Set behavior. More...

	getBehavior ()
	Get behavior. More...

	getCaptions ()
	Get captions. More...

	getCaption ($a_hier_id, $a_pc_id)
	Get caption. More...

	savePositions ($a_pos)
	Save positions of tabs. More...

	saveCaptions ($a_captions)
	Add Tab items. More...

	deleteTab ($a_hier_id, $a_pc_id)
	Save positions of tabs. More...

	addTab ($a_caption)
	Add a tab. More...

	setTemplate ($a_template)
	Set template. More...

	getTemplate ()
	Get template. 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
	$tabs_node

const	ACCORDION_HOR = "HorizontalAccordion"

const	ACCORDION_VER = "VerticalAccordion"

Data Fields inherited from ilPageContent
	$hier_id

	$node

	$dom

Protected Member Functions
	setTabsAttribute ($a_attr, $a_value)
	Set attribute of tabs tag. More...

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

Detailed Description

Class ilPCTabs.

Tabbed contents (see ILIAS DTD)

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

Version: $Id$

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

Member Function Documentation

◆ addTab()

ilPCTabs::addTab ( $a_caption )

Add a tab.

Definition at line 340 of file class.ilPCTabs.php.

References ilDOMUtil\setFirstOptionalElement().

         {
                 $new_item = $this->dom->create_element("Tab");
                 $new_item = $this->tabs_node->append_child($new_item);
                 ilDOMUtil::setFirstOptionalElement($this->dom, $new_item, "TabCaption",
                         array(), $a_caption, array());
         }

Here is the call graph for this function:

◆ create()

ilPCTabs::create	(	&	$a_pg_obj,
			$a_hier_id,
			$a_pc_id = `""`
	)

Create new Tabs node.

Definition at line 62 of file class.ilPCTabs.php.

References ilPageContent\createPageContentNode(), and IL_INSERT_AFTER.

         {
                 $this->node = $this->createPageContentNode();
                 $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
                 $this->tabs_node =& $this->dom->create_element("Tabs");
                 $this->tabs_node =& $this->node->append_child($this->tabs_node);
         }

Here is the call graph for this function:

◆ deleteTab()

ilPCTabs::deleteTab	(	$a_hier_id,
		$a_pc_id
	)

Save positions of tabs.

Definition at line 319 of file class.ilPCTabs.php.

         {
                 // File Item
                 $childs = $this->tabs_node->child_nodes();
                 $nodes = array();
                 for ($i=0; $i<count($childs); $i++)
                 {
                         if ($childs[$i]->node_name() == "Tab")
                         {
                                 if ($a_pc_id == $childs[$i]->get_attribute("PCID") &&
                                         $a_hier_id == $childs[$i]->get_attribute("HierId"))
                                 {
                                         $childs[$i]->unlink($childs[$i]);
                                 }
                         }
                 }
         }

◆ getBehavior()

ilPCTabs::getBehavior ( )

Get behavior.

Returns: string behavior

Definition at line 190 of file class.ilPCTabs.php.

         {
                 return $this->tabs_node->get_attribute("Behavior");
         }

◆ getCaption()

ilPCTabs::getCaption	(	$a_hier_id,
		$a_pc_id
	)

Get caption.

Definition at line 231 of file class.ilPCTabs.php.

         {
                 $captions = array();
                 $tab_nodes = $this->tabs_node->child_nodes();
                 $k = 0;
                 for($i = 0; $i < count($tab_nodes); $i++)
                 {
                         if ($tab_nodes[$i]->node_name() == "Tab")
                         {
                                 if ($a_pc_id == $tab_nodes[$i]->get_attribute("PCID") &&
                                         ($a_hier_id == $tab_nodes[$i]->get_attribute("HierId")))
                                 {
                                         $tab_node_childs = $tab_nodes[$i]->child_nodes();
                                         for($j = 0; $j < count($tab_node_childs); $j++)
                                         {
                                                 if ($tab_node_childs[$j]->node_name() == "TabCaption")
                                                 {
                                                         return $tab_node_childs[$j]->get_content();
                                                 }
                                         }
                                 }
                         }
                 }
                 
                 return "";
         }

◆ getCaptions()

ilPCTabs::getCaptions ( )

Get captions.

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

References ilPageContent\$hier_id.

         {
                 $captions = array();
                 $tab_nodes = $this->tabs_node->child_nodes();
                 $k = 0;
                 for($i = 0; $i < count($tab_nodes); $i++)
                 {
                         if ($tab_nodes[$i]->node_name() == "Tab")
                         {
                                 $pc_id = $tab_nodes[$i]->get_attribute("PCID");
                                 $hier_id = $tab_nodes[$i]->get_attribute("HierId");
 
                                 $tab_node_childs = $tab_nodes[$i]->child_nodes();
                                 $current_caption = "";
                                 for($j = 0; $j < count($tab_node_childs); $j++)
                                 {
                                         if ($tab_node_childs[$j]->node_name() == "TabCaption")
                                         {
                                                 $current_caption = $tab_node_childs[$j]->get_content();
                                         }
                                 }
                                 $captions[] = array("pos" => $k,
                                         "caption" => $current_caption, "pc_id" => $pc_id, "hier_id" => $hier_id);
                                 $k++;
                         }
                 }
                 
                 return $captions;
         }

◆ getContentHeight()

ilPCTabs::getContentHeight ( )

Get content height.

Returns: int content height

Definition at line 150 of file class.ilPCTabs.php.

         {
                 return $this->tabs_node->get_attribute("ContentHeight");
         }

◆ getContentWidth()

ilPCTabs::getContentWidth ( )

Get content width.

Returns: int content width

Definition at line 130 of file class.ilPCTabs.php.

         {
                 return $this->tabs_node->get_attribute("ContentWidth");
         }

◆ getHorizontalAlign()

ilPCTabs::getHorizontalAlign ( )

Get horizontal align.

Returns: string horizontal align

Definition at line 170 of file class.ilPCTabs.php.

         {
                 return $this->tabs_node->get_attribute("HorizontalAlign");
         }

◆ getLangVars()

static ilPCTabs::getLangVars ( )

static

Get lang vars needed for editing.

Returns: array array of lang var keys

Definition at line 372 of file class.ilPCTabs.php.

         {
                 return array("pc_vacc", "pc_hacc");
         }

◆ getTabType()

ilPCTabs::getTabType ( )

Get type of tabs.

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

         {
                 return $this->tabs_node->get_attribute("Type");
         }

◆ getTemplate()

ilPCTabs::getTemplate ( )

Get template.

Returns: string template

Definition at line 363 of file class.ilPCTabs.php.

         {
                 return $this->tabs_node->get_attribute("Template");
         }

◆ init()

ilPCTabs::init ( )

Init page content component.

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

References ilPageContent\setType().

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

Here is the call graph for this function:

◆ saveCaptions()

ilPCTabs::saveCaptions ( $a_captions )

Add Tab items.

Definition at line 291 of file class.ilPCTabs.php.

References ilPageContent\$hier_id, ilDOMUtil\deleteAllChildsByName(), and ilDOMUtil\setFirstOptionalElement().

         {
                 // iterate all tab nodes
                 $tab_nodes = $this->tabs_node->child_nodes();
                 for($i = 0; $i < count($tab_nodes); $i++)
                 {
                         if ($tab_nodes[$i]->node_name() == "Tab")
                         {
                                 $pc_id = $tab_nodes[$i]->get_attribute("PCID");
                                 $hier_id = $tab_nodes[$i]->get_attribute("HierId");
                                 $k = $hier_id.":".$pc_id;
                                 // if caption given, set it, otherwise delete caption subitem
                                 if ($a_captions[$k] != "")
                                 {
                                         ilDOMUtil::setFirstOptionalElement($this->dom, $tab_nodes[$i], "TabCaption",
                                                 array(), $a_captions[$k], array());
                                 }
                                 else
                                 {
                                         ilDOMUtil::deleteAllChildsByName($tab_nodes[$i], array("TabCaption"));
                                 }
                         }
                 }
         }

Here is the call graph for this function:

◆ savePositions()

ilPCTabs::savePositions ( $a_pos )

Save positions of tabs.

Definition at line 261 of file class.ilPCTabs.php.

References ilPageContent\$hier_id.

         {
                 asort($a_pos);
                 
                 // File Item
                 $childs = $this->tabs_node->child_nodes();
                 $nodes = array();
                 for ($i=0; $i<count($childs); $i++)
                 {
                         if ($childs[$i]->node_name() == "Tab")
                         {
                                 $pc_id = $childs[$i]->get_attribute("PCID");
                                 $hier_id = $childs[$i]->get_attribute("HierId");
                                 $nodes[$hier_id.":".$pc_id] = $childs[$i];
                                 $childs[$i]->unlink($childs[$i]);
                         }
                 }
                 
                 foreach($a_pos as $k => $v)
                 {
                         if (is_object($nodes[$k]))
                         {
                                 $nodes[$k] = $this->tabs_node->append_child($nodes[$k]);
                         }
                 }
         }

◆ setBehavior()

ilPCTabs::setBehavior ( $a_val )

Set behavior.

Parameters

string behavior

Definition at line 180 of file class.ilPCTabs.php.

References setTabsAttribute().

         {
                 $this->setTabsAttribute("Behavior", $a_val);
         }

Here is the call graph for this function:

◆ setContentHeight()

ilPCTabs::setContentHeight ( $a_val )

Set content height.

Parameters

int	content height

Definition at line 140 of file class.ilPCTabs.php.

References setTabsAttribute().

         {
                 $this->setTabsAttribute("ContentHeight", $a_val);
         }

Here is the call graph for this function:

◆ setContentWidth()

ilPCTabs::setContentWidth ( $a_val )

Set content width.

Parameters

int	content width

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

References setTabsAttribute().

         {
                 $this->setTabsAttribute("ContentWidth", $a_val);
         }

Here is the call graph for this function:

◆ setHorizontalAlign()

ilPCTabs::setHorizontalAlign ( $a_val )

Set horizontal align.

Parameters

string horizontal align

Definition at line 160 of file class.ilPCTabs.php.

References setTabsAttribute().

         {
                 $this->setTabsAttribute("HorizontalAlign", $a_val);
         }

Here is the call graph for this function:

◆ setNode()

ilPCTabs::setNode ( & $a_node )

Set content node.

Definition at line 53 of file class.ilPCTabs.php.

         {
                 parent::setNode($a_node);               // this is the PageContent node
                 $this->tabs_node =& $a_node->first_child();             // this is the Tabs node
         }

◆ setTabsAttribute()

ilPCTabs::setTabsAttribute	(	$a_attr,
		$a_value
	)

protected

Set attribute of tabs tag.

Parameters

string	attribute name
string	attribute value

Definition at line 76 of file class.ilPCTabs.php.

Referenced by setBehavior(), setContentHeight(), setContentWidth(), setHorizontalAlign(), and setTemplate().

         {
                 if (!empty($a_value))
                 {
                         $this->tabs_node->set_attribute($a_attr, $a_value);
                 }
                 else
                 {
                         if ($this->tabs_node->has_attribute($a_attr))
                         {
                                 $this->tabs_node->remove_attribute($a_attr);
                         }
                 }
         }

Here is the caller graph for this function:

◆ setTabType()

ilPCTabs::setTabType ( $a_type = "HorizontalTabs" )

Set type of tabs.

Parameters

string $a_type ("HorizontalTabs" | "Accordion")

Definition at line 96 of file class.ilPCTabs.php.

References ACCORDION_HOR, and ACCORDION_VER.

         {
                 switch ($a_type)
                 {
                         case ilPCTabs::ACCORDION_VER:
                         case ilPCTabs::ACCORDION_HOR:
                                 $this->tabs_node->set_attribute("Type", $a_type);
                                 break;
                 }
         }

◆ setTemplate()

ilPCTabs::setTemplate ( $a_template )

Set template.

Parameters

string $a_template template

Definition at line 353 of file class.ilPCTabs.php.

References setTabsAttribute().

         {
                 $this->setTabsAttribute("Template", $a_template);
         }

Here is the call graph for this function:

Field Documentation

◆ $tabs_node

ilPCTabs::$tabs_node

Definition at line 38 of file class.ilPCTabs.php.

◆ ACCORDION_HOR

const ilPCTabs::ACCORDION_HOR = "HorizontalAccordion"

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

Referenced by ilPCTabsGUI\create(), ilPCTabsGUI\getFormValues(), ilPCTabsGUI\initForm(), setTabType(), and ilPCTabsGUI\update().

◆ ACCORDION_VER

const ilPCTabs::ACCORDION_VER = "VerticalAccordion"

Definition at line 40 of file class.ilPCTabs.php.

Referenced by ilPCTabsGUI\create(), ilPCTabsGUI\getFormValues(), ilPCTabsGUI\initForm(), setTabType(), and ilPCTabsGUI\update().

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

Services/COPage/classes/class.ilPCTabs.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addTab()

◆ create()

◆ deleteTab()

◆ getBehavior()

◆ getCaption()

◆ getCaptions()

◆ getContentHeight()

◆ getContentWidth()

◆ getHorizontalAlign()

◆ getLangVars()

◆ getTabType()

◆ getTemplate()

◆ init()

◆ saveCaptions()

◆ savePositions()

◆ setBehavior()

◆ setContentHeight()

◆ setContentWidth()

◆ setHorizontalAlign()

◆ setNode()

◆ setTabsAttribute()

◆ setTabType()

◆ setTemplate()

Field Documentation

◆ $tabs_node

◆ ACCORDION_HOR

◆ ACCORDION_VER