Inheritance diagram for ilPCSection:

Collaboration diagram for ilPCSection:

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

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

	create (&$a_pg_obj, $a_hier_id, $a_pc_id="")
	Create section node in xml. More...

	setCharacteristic ($a_char)
	Set Characteristic of section. More...

	getCharacteristic ()
	Get characteristic of section. More...

	modifyPageContentPostXsl ($a_output, $a_mode)
	Modify page content after xsl. More...

	setActiveFrom ($a_unix_ts)
	Set activation from. More...

	getActiveFrom ()
	Get activation from. More...

	setActiveTo ($a_unix_ts)
	Set activation to. More...

	getActiveTo ()
	Get activation to. More...

	insertTimings ($a_html)
	Insert timings (in edit mode) 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	afterPageUpdate ($a_page, DOMDocument $a_domdoc, $a_xml, $a_creation)
	After page has been updated (or created) More...

static	saveTimings ($a_page)
	Save timings. More...

static	getCacheTriggerString ($a_page)
	Get page cache update trigger string. 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
	$dom

	$sec_node

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 ilPCSection.

Section content object (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 17 of file class.ilPCSection.php.

Member Function Documentation

◆ afterPageUpdate()

static ilPCSection::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 109 of file class.ilPCSection.php.

         {
                 include_once("./Services/COPage/classes/class.ilPCSection.php");
                 self::saveTimings($a_page);
         }

◆ create()

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

Create section node in xml.

Parameters

object	$a_pg_obj	Page Object
string	$a_hier_id	Hierarchical ID

Definition at line 45 of file class.ilPCSection.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->sec_node =& $this->dom->create_element("Section");
                 $this->sec_node =& $this->node->append_child($this->sec_node);
                 $this->sec_node->set_attribute("Characteristic", "Block");
         }

Here is the call graph for this function:

◆ getActiveFrom()

ilPCSection::getActiveFrom ( )

Get activation from.

Returns: string unix ts activation from

Definition at line 153 of file class.ilPCSection.php.

         {
                 if (is_object($this->sec_node))
                 {
                         return $this->sec_node->get_attribute("ActiveFrom");
                 }
 
                 return "";
         }

◆ getActiveTo()

ilPCSection::getActiveTo ( )

Get activation to.

Returns: string unix ts activation to

Definition at line 188 of file class.ilPCSection.php.

         {
                 if (is_object($this->sec_node))
                 {
                         return $this->sec_node->get_attribute("ActiveTo");
                 }
 
                 return "";
         }

◆ getCacheTriggerString()

static ilPCSection::getCacheTriggerString ( $a_page )

static

Get page cache update trigger string.

Parameters

ilPageObject $a_page

Returns: string trigger string

Definition at line 251 of file class.ilPCSection.php.

References $ilDB, and IL_CAL_UNIX.

Referenced by ilPageObjectGUI\showPage().

         {
                 global $ilDB;
 
                 $set = $ilDB->query("SELECT * FROM copg_section_timings ".
                         " WHERE page_id = ".$ilDB->quote($a_page->getId(), "integer").
                         " AND parent_type = ".$ilDB->quote($a_page->getParentType(), "text")
                 );
                 $str = "";
                 $current_ts = new ilDateTime(time(),IL_CAL_UNIX);
                 $current_ts = $current_ts->get(IL_CAL_UNIX);
                 while ($rec = $ilDB->fetchAssoc($set))
                 {
                         $unix_ts = $rec["unix_ts"];
                         if ($unix_ts < $current_ts)
                         {
                                 $unix_ts.= "a";
                         }
                         $str.= "-".$unix_ts;
                 }
 
                 return $str;
         }

Here is the caller graph for this function:

◆ getCharacteristic()

ilPCSection::getCharacteristic ( )

Get characteristic of section.

Returns: string characteristic

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

         {
                 if (is_object($this->sec_node))
                 {
                         $char =  $this->sec_node->get_attribute("Characteristic");
                         if (substr($char, 0, 4) == "ilc_")
                         {
                                 $char = substr($char, 4);
                         }
                         return $char;
                 }
         }

◆ getLangVars()

static ilPCSection::getLangVars ( )

static

Get lang vars needed for editing.

Returns: array array of lang var keys

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

         {
                 return array("ed_insert_section");
         }

◆ init()

ilPCSection::init ( )

Init page content component.

Definition at line 25 of file class.ilPCSection.php.

References ilPageContent\setType().

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

Here is the call graph for this function:

◆ insertTimings()

ilPCSection::insertTimings ( $a_html )

Insert timings (in edit mode)

Parameters

string $a_html html

Returns: string htmls

Definition at line 281 of file class.ilPCSection.php.

References $html, $ilCtrl, $lng, ilDatePresentation\formatDate(), IL_CAL_UNIX, and ilDatePresentation\setUseRelativeDates().

         {
                 global $ilCtrl, $lng;
 
                 $c_pos = 0;
                 $start = strpos($a_html, "{{{{{Section;ActiveFrom");
                 if (is_int($start))
                 {
                         $end = strpos($a_html, "}}}}}", $start);
                 }
                 $i = 1;
                 while ($end > 0)
                 {
                         $param = substr($a_html, $start + 13, $end - $start - 13);
                         $param = explode(";", $param);
                         $from = $param[1];
                         $to = $param[3];
                         $html = "";
                         if ($from != "")
                         {
                                 ilDatePresentation::setUseRelativeDates(false);
                                 $from = new ilDateTime($from, IL_CAL_UNIX);
                                 $html.= $lng->txt("cont_active_from").": ".ilDatePresentation::formatDate($from);
                         }
                         if ($to != "")
                         {
                                 $to = new ilDateTime($to, IL_CAL_UNIX);
                                 $html.= " ".$lng->txt("cont_active_to").": ".ilDatePresentation::formatDate($to);
                         }
 
                         $h2 = substr($a_html, 0, $start).
                                 $html.
                                 substr($a_html, $end + 5);
                         $a_html = $h2;
                         $i++;
 
                         $start = strpos($a_html, "{{{{{Section;ActiveFrom;", $start + 5);
                         $end = 0;
                         if (is_int($start))
                         {
                                 $end = strpos($a_html, "}}}}}", $start);
                         }
                 }
                 return $a_html;
         }

Here is the call graph for this function:

◆ modifyPageContentPostXsl()

ilPCSection::modifyPageContentPostXsl	(	$a_output,
		$a_mode
	)

Modify page content after xsl.

Parameters

string $a_output

Returns: string

Definition at line 121 of file class.ilPCSection.php.

         {
                 $a_output = self::insertTimings($a_output);
 
                 return $a_output;
         }

◆ saveTimings()

static ilPCSection::saveTimings ( $a_page )

static

Save timings.

Parameters

ilPageObject $a_page page object

Definition at line 203 of file class.ilPCSection.php.

References $ilDB, $path, $res, domxml_open_mem(), xpath_eval(), and xpath_new_context().

         {
                 global $ilDB;
 
                 $ilDB->manipulate("DELETE FROM copg_section_timings WHERE ".
                         " page_id = ".$ilDB->quote($a_page->getId(), "integer").
                         " AND parent_type = ".$ilDB->quote($a_page->getParentType(), "text")
                 );
 
                 $xml = $a_page->getXMLFromDom();
 
                 $doc = domxml_open_mem($xml);
 
                 // media aliases
                 $xpc = xpath_new_context($doc);
                 $path = "//Section";
                 $res = xpath_eval($xpc, $path);
                 for ($i=0; $i < count($res->nodeset); $i++)
                 {
                         $from = $res->nodeset[$i]->get_attribute("ActiveFrom");
                         if ($from != "")
                         {
                                 $ilDB->manipulate("INSERT INTO copg_section_timings ".
                                         "(page_id, parent_type, unix_ts) VALUES (".
                                         $ilDB->quote($a_page->getId(), "integer").",".
                                         $ilDB->quote($a_page->getParentType(), "text").",".
                                         $ilDB->quote($from, "text").
                                         ")");
                         }
                         $to = $res->nodeset[$i]->get_attribute("ActiveTo");
                         if ($to != "")
                         {
                                 $ilDB->manipulate("INSERT INTO copg_section_timings ".
                                         "(page_id, parent_type, unix_ts) VALUES (".
                                         $ilDB->quote($a_page->getId(), "integer").",".
                                         $ilDB->quote($a_page->getParentType(), "text").",".
                                         $ilDB->quote($to, "text").
                                         ")");
                         }
                 }
         }

Here is the call graph for this function:

◆ setActiveFrom()

ilPCSection::setActiveFrom ( $a_unix_ts )

Set activation from.

Parameters

string $a_unix_ts unix ts activation from

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

         {
                 if ($a_unix_ts > 0)
                 {
                         $this->sec_node->set_attribute("ActiveFrom", $a_unix_ts);
                 }
                 else
                 {
                         if ($this->sec_node->has_attribute("ActiveFrom"))
                         {
                                 $this->sec_node->remove_attribute("ActiveFrom");
                         }
                 }
         }

◆ setActiveTo()

ilPCSection::setActiveTo ( $a_unix_ts )

Set activation to.

Parameters

string $a_unix_ts unix ts activation to

Definition at line 168 of file class.ilPCSection.php.

         {
                 if ($a_unix_ts > 0)
                 {
                         $this->sec_node->set_attribute("ActiveTo", $a_unix_ts);
                 }
                 else
                 {
                         if ($this->sec_node->has_attribute("ActiveTo"))
                         {
                                 $this->sec_node->remove_attribute("ActiveTo");
                         }
                 }
         }

◆ setCharacteristic()

ilPCSection::setCharacteristic ( $a_char )

Set Characteristic of section.

Parameters

string $a_char Characteristic

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

         {
                 if (!empty($a_char))
                 {
                         $this->sec_node->set_attribute("Characteristic", $a_char);
                 }
                 else
                 {
                         if ($this->sec_node->has_attribute("Characteristic"))
                         {
                                 $this->sec_node->remove_attribute("Characteristic");
                         }
                 }
         }

◆ setNode()

ilPCSection::setNode ( & $a_node )

Set node.

Definition at line 33 of file class.ilPCSection.php.

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

Field Documentation

◆ $dom

ilPCSection::$dom

Definition at line 19 of file class.ilPCSection.php.

◆ $sec_node

ilPCSection::$sec_node

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

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

Services/COPage/classes/class.ilPCSection.php

Public Member Functions

Static Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ afterPageUpdate()

◆ create()

◆ getActiveFrom()

◆ getActiveTo()

◆ getCacheTriggerString()

◆ getCharacteristic()

◆ getLangVars()

◆ init()

◆ insertTimings()

◆ modifyPageContentPostXsl()

◆ saveTimings()

◆ setActiveFrom()

◆ setActiveTo()

◆ setCharacteristic()

◆ setNode()

Field Documentation

◆ $dom

◆ $sec_node