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

	getAttribute ($a_attr)
	Get attribute. More...

	setPermission ($a_val)
	Set permission. More...

	getPermission ()
	Get permission. More...

	setPermissionRefId ($a_ref_id)
	Set permission ref id. More...

	getPermissionRefId ()
	Get permission ref id. More...

	setNoLink ()
	Set no link. More...

	setExtLink ($a_href)
	Set link of area to an external one. More...

	setIntLink ($a_type, $a_target, $a_target_frame)
	Set link of area to an internal one. More...

	getLink ()
	Get link. More...

	handleAccess ($a_html, $a_mode)

	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 ($a_mode)
	Get Javascript files. More...

	getCssFiles ($a_mode)
	Get css files. More...

	getOnloadCode ($a_mode)
	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...

	setFileDownloadLink ($a_download_link)
	Set file download link. More...

	getFileDownloadLink ()
	Get file download link. More...

	setFullscreenLink ($a_fullscreen_link)
	Set fullscreen link. More...

	getFullscreenLink ()
	Get fullscreen link. More...

	setSourcecodeDownloadScript ($script_name)
	Set sourcecode download script. More...

	getSourcecodeDownloadScript ()
	Get sourcecode download script. More...

	readPCId ()
	Read PC Id. More...

	writePCId ($a_pc_id)
	Write pc id. 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	isGreaterHierId ($a, $b)
	Check whether Hier ID $a is greater than Hier ID $b. 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

	$page_lang

Protected Member Functions
	setAttribute ($a_attr, $a_val)
	Set attribute. More...

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

Protected Attributes
	$access

	$ctrl

	$lng

Protected Attributes inherited from ilPageContent
	$file_download_link

	$fullscreen_link

	$sourcecode_download_script

	$log

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 123 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 65 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 164 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 194 of file class.ilPCSection.php.

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

◆ getAttribute()

ilPCSection::getAttribute ( $a_attr )

Get attribute.

Parameters

string $a_attr attribute

Returns: string attribute value

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

Referenced by getPermission(), and getPermissionRefId().

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

Here is the caller graph for this function:

◆ getCacheTriggerString()

static ilPCSection::getCacheTriggerString ( $a_page )

static

Get page cache update trigger string.

Parameters

ilPageObject $a_page

Returns: string trigger string

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

References $DIC, $ilDB, IL_CAL_UNIX, and time.

Referenced by ilPageObjectGUI\showPage().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $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 95 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 110 of file class.ilPCSection.php.

References array.

     {
         return array("ed_insert_section");
     }

◆ getLink()

ilPCSection::getLink ( )

Get link.

Parameters

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

References array.

     {
         $childs = $this->sec_node->child_nodes();
         foreach ($childs as $child) {
             if ($child->node_name() == "ExtLink") {
                 return array("LinkType" => "ExtLink",
                     "Href" => $child->get_attribute("Href"));
             }
             if ($child->node_name() == "IntLink") {
                 return array("LinkType" => "IntLink",
                     "Target" => $child->get_attribute("Target"),
                     "Type" => $child->get_attribute("Type"),
                     "TargetFrame" => $child->get_attribute("TargetFrame"));
             }
         }
         return array("LinkType" => "NoLink");
     }

◆ getPermission()

ilPCSection::getPermission ( )

Get permission.

Returns: string

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

References getAttribute().

     {
         return $this->getAttribute("Permission");
     }

Here is the call graph for this function:

◆ getPermissionRefId()

ilPCSection::getPermissionRefId ( )

Get permission ref id.

Returns: int ref id

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

References $id, array, and getAttribute().

     {
         $id = explode("_", $this->getAttribute("PermissionRefId"));
         if (in_array($id[1], array("", 0, IL_INST_ID))) {
             return $id[3];
         }
         return "";
     }

Here is the call graph for this function:

◆ handleAccess()

ilPCSection::handleAccess	(	$a_html,
		$a_mode
	)

Parameters

$a_html
$a_mode

Returns: mixed|string

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

References $access, $end, $id, and array.

Referenced by modifyPageContentPostXsl().

     {
         $ilAccess = $this->access;
 
         while (($start = strpos($a_html, "{{{{{Section;Access;")) > 0) {
             $end = strpos($a_html, "}}}}}", $start);
             $access_attr = explode(";", substr($a_html, $start, $end - $start));
             $id = explode("_", $access_attr[3]);
             $access = true;
             if (in_array($id[1], array("", 0, IL_INST_ID)) && $id[3] > 0) {
                 $access = $ilAccess->checkAccess($access_attr[5], "", $id[3]);
             }
             if ($access) {
                 $a_html = substr($a_html, 0, $start) . substr($a_html, $end + 5);
             } else {
                 $end = strpos($a_html, "{{{{{Section;Access}}}}}", $start);
                 $a_html = substr($a_html, 0, $start) . substr($a_html, $end + 24);
             }
         }
 
         $a_html = str_replace("{{{{{Section;Access}}}}}", "", $a_html);
 
         return $a_html;
     }

Here is the caller graph for this function:

◆ init()

ilPCSection::init ( )

Init page content component.

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

References $DIC, and ilPageContent\setType().

     {
         global $DIC;
 
         $this->access = $DIC->access();
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $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 470 of file class.ilPCSection.php.

References $ctrl, $end, $from, $html, $i, $ilCtrl, $lng, ilDatePresentation\formatDate(), IL_CAL_UNIX, and ilDatePresentation\setUseRelativeDates().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->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 135 of file class.ilPCSection.php.

References handleAccess().

     {
         $a_output = self::insertTimings($a_output);
         $a_output = $this->handleAccess($a_output, $a_mode);
 
         return $a_output;
     }

Here is the call graph for this function:

◆ saveTimings()

static ilPCSection::saveTimings ( $a_page )

static

Save timings.

Parameters

ilPageObject $a_page page object

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

References $DIC, $from, $i, $ilDB, $path, $res, $xml, array, domxml_open_mem(), xpath_eval(), and xpath_new_context().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $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->replace(
                     "copg_section_timings",
                     array(
                         "page_id" => array("integer", $a_page->getId()),
                         "parent_type" => array("text", $a_page->getParentType()),
                         "unix_ts" => array("integer", $from)
                         ),
                     array()
                 );
             }
             $to = $res->nodeset[$i]->get_attribute("ActiveTo");
             if ($to != "") {
                 $ilDB->replace(
                     "copg_section_timings",
                     array(
                         "page_id" => array("integer", $a_page->getId()),
                         "parent_type" => array("text", $a_page->getParentType()),
                         "unix_ts" => array("integer", $to)
                     ),
                     array()
                 );
             }
         }
     }

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 148 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 178 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");
             }
         }
     }

◆ setAttribute()

ilPCSection::setAttribute	(	$a_attr,
		$a_val
	)

protected

Set attribute.

Parameters

string	$a_attr	attribute
string	$a_val	attribute value

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

Referenced by setPermission(), and setPermissionRefId().

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

Here is the caller graph for this function:

◆ setCharacteristic()

ilPCSection::setCharacteristic ( $a_char )

Set Characteristic of section.

Parameters

string $a_char Characteristic

Definition at line 79 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");
             }
         }
     }

◆ setExtLink()

ilPCSection::setExtLink ( $a_href )

Set link of area to an external one.

Parameters

string $a_href

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

References $attributes, array, ilDOMUtil\setFirstOptionalElement(), and setNoLink().

     {
         $this->setNoLink();
         if (trim($a_href) != "") {
             $attributes = array("Href" => trim($a_href));
             ilDOMUtil::setFirstOptionalElement(
                 $this->dom,
                 $this->sec_node,
                 "ExtLink",
                 array(""),
                 "",
                 $attributes
             );
         }
     }

Here is the call graph for this function:

◆ setIntLink()

ilPCSection::setIntLink	(	$a_type,
		$a_target,
		$a_target_frame
	)

Set link of area to an internal one.

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

References $a_type, $attributes, array, ilDOMUtil\setFirstOptionalElement(), and setNoLink().

     {
         $this->setNoLink();
         $attributes = array("Type" => $a_type, "Target" => $a_target,
             "TargetFrame" => $a_target_frame);
         ilDOMUtil::setFirstOptionalElement(
             $this->dom,
             $this->sec_node,
             "IntLink",
             array(""),
             "",
             $attributes
         );
     }

Here is the call graph for this function:

◆ setNode()

ilPCSection::setNode ( $a_node )

Set node.

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

◆ setNoLink()

ilPCSection::setNoLink ( )

Set no link.

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

References array, and ilDOMUtil\deleteAllChildsByName().

Referenced by setExtLink(), and setIntLink().

     {
         ilDOMUtil::deleteAllChildsByName($this->sec_node, array("IntLink", "ExtLink"));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPermission()

ilPCSection::setPermission ( $a_val )

Set permission.

Parameters

string $a_val "read"|"write"|"visible"

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

References setAttribute().

     {
         $this->setAttribute("Permission", $a_val);
     }

Here is the call graph for this function:

◆ setPermissionRefId()

ilPCSection::setPermissionRefId ( $a_ref_id )

Set permission ref id.

Parameters

integer $a_ref_id ref id

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

References setAttribute().

     {
         $this->setAttribute("PermissionRefId", "il__ref_" . $a_ref_id);
     }

Here is the call graph for this function:

Field Documentation

◆ $access

ilPCSection::$access

protected

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

Referenced by handleAccess().

◆ $ctrl

ilPCSection::$ctrl

protected

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

Referenced by insertTimings().

◆ $dom

ilPCSection::$dom

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

◆ $lng

ilPCSection::$lng

protected

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

Referenced by insertTimings().

◆ $sec_node

ilPCSection::$sec_node

Definition at line 35 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

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ afterPageUpdate()

◆ create()

◆ getActiveFrom()

◆ getActiveTo()

◆ getAttribute()

◆ getCacheTriggerString()

◆ getCharacteristic()

◆ getLangVars()

◆ getLink()

◆ getPermission()

◆ getPermissionRefId()

◆ handleAccess()

◆ init()

◆ insertTimings()

◆ modifyPageContentPostXsl()

◆ saveTimings()

◆ setActiveFrom()

◆ setActiveTo()

◆ setAttribute()

◆ setCharacteristic()

◆ setExtLink()

◆ setIntLink()

◆ setNode()

◆ setNoLink()

◆ setPermission()

◆ setPermissionRefId()

Field Documentation

◆ $access

◆ $ctrl

◆ $dom

◆ $lng

◆ $sec_node