Inheritance diagram for ilPCContentInclude:

Collaboration diagram for ilPCContentInclude:

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 content include node in xml. More...

	setContentId ($a_id)
	Set content id. More...

	getContentId ()
	Get content id. More...

	setContentType ($a_type)
	Set content type. More...

	getContentType ()
	Get content type. More...

	setInstId ($a_id)
	Set installation id. More...

	getInstId ()
	Get installation id. More...

	getContentIncludeAttribute ($a_attr)
	Get content include tag attribute. More...

	modifyPageContentPostXsl ($a_html, $a_mode)

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

static	saveContentIncludeUsage ($a_page, $a_domdoc, $a_old_nr=0)
	save content include usages More...

static	collectContentIncludes ($a_page, $a_domdoc)
	get all content includes that are used within the page 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

	$incl_node

Data Fields inherited from ilPageContent
	$hier_id

	$node

	$dom

	$page_lang

Protected Member Functions
	setContentIncludeAttribute ($a_attr, $a_value)
	Set attribute of content include tag. More...

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

Protected Attributes
	$access

Protected Attributes inherited from ilPageContent
	$file_download_link

	$fullscreen_link

	$sourcecode_download_script

	$log

Detailed Description

Class ilPCContentInclude.

Content include object (see ILIAS DTD). Inserts content snippets from other source (e.g. media pool)

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

Member Function Documentation

◆ afterPageHistoryEntry()

static ilPCContentInclude::afterPageHistoryEntry	(		$a_page,
		DOMDocument	$a_old_domdoc,
			$a_old_xml,
			$a_old_nr
	)

static

After page history entry has been created.

Parameters

object	$a_page	page object
DOMDocument	$a_old_domdoc	old dom document
string	$a_old_xml	old xml
integer	$a_old_nr	history number

Definition at line 176 of file class.ilPCContentInclude.php.

         {
                 self::saveContentIncludeUsage($a_page, $a_old_domdoc, $a_old_nr);
         }

◆ afterPageUpdate()

static ilPCContentInclude::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 151 of file class.ilPCContentInclude.php.

         {
                 // pc content include
                 self::saveContentIncludeUsage($a_page, $a_domdoc);
         }

◆ beforePageDelete()

static ilPCContentInclude::beforePageDelete ( $a_page )

static

Before page is being deleted.

Parameters

object $a_page page object

Definition at line 162 of file class.ilPCContentInclude.php.

References ilPageContentUsage\deleteAllUsages().

         {
                 include_once("./Services/COPage/classes/class.ilPageContentUsage.php");
                 ilPageContentUsage::deleteAllUsages("incl", $a_page->getParentType().":pg", $a_page->getId(), false, $a_page->getLanguage());
         }

Here is the call graph for this function:

◆ collectContentIncludes()

static ilPCContentInclude::collectContentIncludes	(	$a_page,
		$a_domdoc
	)

static

get all content includes that are used within the page

Definition at line 202 of file class.ilPCContentInclude.php.

References ilPageContent\$node, and array.

Referenced by ilPageObjectGUI\showPage().

         {
                 $xpath = new DOMXPath($a_domdoc);
                 $nodes = $xpath->query('//ContentInclude');     
 
                 $ci_ids = array();
                 foreach ($nodes as $node)
                 {
                         $type = $node->getAttribute("ContentType");
                         $id = $node->getAttribute("ContentId");
                         $inst_id = $node->getAttribute("InstId");
                         $ci_ids[$type.":".$id.":".$inst_id] = array(
                                 "type" => $type, "id" => $id, "inst_id" => $inst_id);
                 }
 
                 return $ci_ids;
         }

Here is the caller graph for this function:

◆ create()

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

Create content include node in xml.

Parameters

object	$a_pg_obj	Page Object
string	$a_hier_id	Hierarchical ID

Definition at line 53 of file class.ilPCContentInclude.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->incl_node = $this->dom->create_element("ContentInclude");
                 $this->incl_node = $this->node->append_child($this->incl_node);
         }

Here is the call graph for this function:

◆ getContentId()

ilPCContentInclude::getContentId ( )

Get content id.

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

References getContentIncludeAttribute().

         {
                 return $this->getContentIncludeAttribute("ContentId");
         }

Here is the call graph for this function:

◆ getContentIncludeAttribute()

ilPCContentInclude::getContentIncludeAttribute ( $a_attr )

Get content include tag attribute.

Returns: string attribute name

Definition at line 135 of file class.ilPCContentInclude.php.

Referenced by getContentId(), getContentType(), and getInstId().

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

Here is the caller graph for this function:

◆ getContentType()

ilPCContentInclude::getContentType ( )

Get content type.

Definition at line 88 of file class.ilPCContentInclude.php.

References getContentIncludeAttribute().

         {
                 return $this->getContentIncludeAttribute("ContentType");
         }

Here is the call graph for this function:

◆ getInstId()

ilPCContentInclude::getInstId ( )

Get installation id.

Definition at line 104 of file class.ilPCContentInclude.php.

References getContentIncludeAttribute().

         {
                 return $this->getContentIncludeAttribute("InstId");
         }

Here is the call graph for this function:

◆ init()

ilPCContentInclude::init ( )

Init page content component.

Definition at line 30 of file class.ilPCContentInclude.php.

References $DIC, and ilPageContent\setType().

         {
                 global $DIC;
 
                 $this->setType("incl");
                 $this->access = $DIC->access();
         }

Here is the call graph for this function:

◆ modifyPageContentPostXsl()

ilPCContentInclude::modifyPageContentPostXsl	(	$a_html,
		$a_mode
	)

Definition at line 223 of file class.ilPCContentInclude.php.

References $html, $info, $lng, $ref_id, $start, ilPageObject\_exists(), ilObject\_getAllReferences(), ilLink\_getLink(), ilObject\_lookupTitle(), ilPageContent\getFileDownloadLink(), ilPageContent\getFullscreenLink(), ilPageContent\getPage(), ilPageContent\getSourcecodeDownloadScript(), IL_PAGE_OFFLINE, and ilMediaPoolItem\lookupTitle().

         {
                 global $lng;
 
                 $end = 0;
                 $start = strpos($a_html, "{{{{{ContentInclude;");
                 if (is_int($start))
                 {
                         $end = strpos($a_html, "}}}}}", $start);
                 }
                 $i = 1;
                 while ($end > 0)
                 {
                         $param = substr($a_html, $start + 20, $end - $start - 20);
                         $param = explode(";", $param);
 
                         if ($param[0] == "mep" && is_numeric($param[1]))
                         {
                                 include_once("./Modules/MediaPool/classes/class.ilMediaPoolPageGUI.php");
                                 $html = "";
                                 $snippet_lang = $this->getPage()->getLanguage();
                                 if (!ilPageObject::_exists("mep", $param[1], $snippet_lang))
                                 {
                                         $snippet_lang = "-";
                                 }
                                 if (($param[2] <= 0 || $param[2] == IL_INST_ID) && ilPageObject::_exists("mep", $param[1]))
                                 {
                                         $page_gui = new ilMediaPoolPageGUI($param[1], 0, true, $snippet_lang);
                                         if ($a_mode != "offline")
                                         {
                                                 $page_gui->setFileDownloadLink($this->getFileDownloadLink());
                                                 $page_gui->setFullscreenLink($this->getFullscreenLink());
                                                 $page_gui->setSourcecodeDownloadScript($this->getSourcecodeDownloadScript());
                                         }
                                         else
                                         {
                                                 $page_gui->setOutputMode(IL_PAGE_OFFLINE);
                                         }
 
                                         $html = $page_gui->getRawContent();
                                         if ($a_mode == "edit")
                                         {
                                                 include_once("./Services/Link/classes/class.ilLink.php");
                                                 $par_id = $page_gui->getPageObject()->getParentId();
                                                 $info = "";
                                                 foreach (ilObject::_getAllReferences($par_id) as $ref_id)
                                                 {
                                                         if ($this->access->checkAccess("write", "", $ref_id))
                                                         {
                                                                 $info = " ".$lng->txt("title").": ".ilMediaPoolItem::lookupTitle($page_gui->getPageObject()->getId()).
                                                                         ", ".$lng->txt("obj_mep").": <a href='".ilLink::_getLink($ref_id)."'>".ilObject::_lookupTitle($par_id)."</a>";
                                                         }
                                                 }
                                                 $html = '<p class="small light">'.$lng->txt("copg_snippet_cannot_be_edited").$info.'</p>'.$html;
                                         }
                                 }
                                 else
                                 {
                                         if ($a_mode == "edit")
                                         {
                                                 if ($param[2] <= 0)
                                                 {
                                                         $html = "// ".$lng->txt("cont_missing_snippet")." //";
                                                 }
                                                 else
                                                 {
                                                         $html = "// ".$lng->txt("cont_snippet_from_another_installation")." //";
                                                 }
                                         }
                                 }
                                 $h2 = substr($a_html, 0, $start).
                                         $html.
                                         substr($a_html, $end + 5);
                                 $a_html = $h2;
                                 $i++;
                         }
 
                         $start = strpos($a_html, "{{{{{ContentInclude;", $start + 5);
                         $end = 0;
                         if (is_int($start))
                         {
                                 $end = strpos($a_html, "}}}}}", $start);
                         }
                 }
                 return $a_html;
         }

Here is the call graph for this function:

◆ saveContentIncludeUsage()

static ilPCContentInclude::saveContentIncludeUsage	(	$a_page,
		$a_domdoc,
		$a_old_nr = `0`
	)

static

save content include usages

Definition at line 184 of file class.ilPCContentInclude.php.

References ilPageContentUsage\deleteAllUsages(), and ilPageContentUsage\saveUsage().

         {
                 include_once("./Services/COPage/classes/class.ilPageContentUsage.php");
                 $ci_ids = self::collectContentIncludes($a_page, $a_domdoc);
                 ilPageContentUsage::deleteAllUsages("incl", $a_page->getParentType().":pg", $a_page->getId(), $a_old_nr, $a_page->getLanguage());
                 foreach($ci_ids as $ci_id)
                 {
                         if ((int) $ci_id["inst_id"] <= 0 || $ci_id["inst_id"] == IL_INST_ID)
                         {
                                 ilPageContentUsage::saveUsage("incl", $ci_id["id"], $a_page->getParentType().":pg", $a_page->getId(), $a_old_nr,
                                         $a_page->getLanguage());
                         }
                 }
         }

Here is the call graph for this function:

◆ setContentId()

ilPCContentInclude::setContentId ( $a_id )

Set content id.

Definition at line 64 of file class.ilPCContentInclude.php.

References setContentIncludeAttribute().

         {
                 $this->setContentIncludeAttribute("ContentId", $a_id);
         }

Here is the call graph for this function:

◆ setContentIncludeAttribute()

ilPCContentInclude::setContentIncludeAttribute	(	$a_attr,
		$a_value
	)

protected

Set attribute of content include tag.

Parameters

string	attribute name
string	attribute value

Definition at line 115 of file class.ilPCContentInclude.php.

Referenced by setContentId(), setContentType(), and setInstId().

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

Here is the caller graph for this function:

◆ setContentType()

ilPCContentInclude::setContentType ( $a_type )

Set content type.

Definition at line 80 of file class.ilPCContentInclude.php.

References $a_type, and setContentIncludeAttribute().

         {
                 $this->setContentIncludeAttribute("ContentType", $a_type);
         }

Here is the call graph for this function:

◆ setInstId()

ilPCContentInclude::setInstId ( $a_id )

Set installation id.

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

References setContentIncludeAttribute().

         {
                 $this->setContentIncludeAttribute("InstId", $a_id);
         }

Here is the call graph for this function:

◆ setNode()

ilPCContentInclude::setNode ( $a_node )

Set node.

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

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

Field Documentation

◆ $access

ilPCContentInclude::$access

protected

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

◆ $dom

ilPCContentInclude::$dom

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

◆ $incl_node

ilPCContentInclude::$incl_node

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

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

Services/COPage/classes/class.ilPCContentInclude.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ afterPageHistoryEntry()

◆ afterPageUpdate()

◆ beforePageDelete()

◆ collectContentIncludes()

◆ create()

◆ getContentId()

◆ getContentIncludeAttribute()

◆ getContentType()

◆ getInstId()

◆ init()

◆ modifyPageContentPostXsl()

◆ saveContentIncludeUsage()

◆ setContentId()

◆ setContentIncludeAttribute()

◆ setContentType()

◆ setInstId()

◆ setNode()

Field Documentation

◆ $access

◆ $dom

◆ $incl_node