This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPCPlugged:

Collaboration diagram for ilPCPlugged:

Public Member Functions
	init ()

	setNode (php4DOMElement $a_node)

	create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id, string $a_plugin_name, string $a_plugin_version)
	Create plugged node in xml. More...

	setProperties (array $a_properties)
	Set properties of plugged component. More...

	getProperties ()
	Get properties of plugged component. More...

	setPluginVersion (string $a_version)

	getPluginVersion ()

	setPluginName (string $a_name)

	getPluginName ()

	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)

	getJavascriptFiles (string $a_mode)

	getCssFiles (string $a_mode)

Public Member Functions inherited from ilPageContent
	__construct (ilPageObject $a_pg_obj)

	setPage (ilPageObject $a_val)

	getPage ()

	init ()
	Init object. More...

	getType ()

	setNode (php4DOMElement $a_node)
	Set xml node of page content. More...

	getNode ()

	getJavascriptFiles (string $a_mode)

	getCssFiles (string $a_mode)

	getOnloadCode (string $a_mode)

	setHierId (string $a_hier_id)

	getHierId ()

	lookupHierId ()

	readHierId ()

	setPcId (string $a_pcid)

	getPCId ()

	setFileDownloadLink (string $a_download_link)

	getFileDownloadLink ()

	setProfileBackUrl (string $url)

	getProfileBackUrl ()

	setFullscreenLink (string $a_fullscreen_link)

	getFullscreenLink ()

	setSourcecodeDownloadScript (string $script_name)

	getSourcecodeDownloadScript ()

	readPCId ()

	writePCId (string $a_pc_id)

	setEnabled (string $value)
	Set Enabled value for page content component. More...

	enable ()

	disable ()

	isEnabled ()

	createPageContentNode (bool $a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...

	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...

	getModel ()
	Get model as needed for the front-end editor. More...

Data Fields
php4DOMElement	$plug_node

Data Fields inherited from ilPageContent
string	$hier_id = ""

php4DOMElement	$node = null

php4DOMDocument	$dom = null

string	$page_lang = ""

Protected Attributes
ilLanguage	$lng

ilComponentRepository	$component_repository

ilComponentFactory	$component_factory

Protected Attributes inherited from ilPageContent
string	$pcid

string	$type = ""

ilPageObject	$pg_obj

string	$file_download_link

string	$fullscreen_link

string	$sourcecode_download_script

ilLogger	$log

string	$profile_back_url = ""

Additional Inherited Members
Static Public Member Functions inherited from ilPageContent
static	incEdId (string $ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...

static	decEdId (string $ed_id)
	Decreases an hierarchical editing id at lowest level (last number) More...

static	sortHierIds (array $a_array)
	Sort an array of Hier IDS in ascending order. More...

static	isGreaterHierId (string $a, string $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, bool $a_self_ass=true, bool $a_clone_mobs=false, int $new_parent_id=0, int $obj_copy_id=0)
	Handle copied content. More...

static	afterPageUpdate (ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
	After page has been updated (or created) More...

static	beforePageDelete (ilPageObject $a_page)
	Before page is being deleted. More...

static	afterRepositoryCopy (ilPageObject $page, array $mapping, int $source_ref_id)
	After repository (container) copy action. More...

static	afterPageHistoryEntry (ilPageObject $a_page, DOMDocument $a_old_domdoc, string $a_old_xml, int $a_old_nr)
	After page history entry has been created. More...

static	deleteHistoryLowerEqualThan (string $parent_type, int $page_id, string $lang, int $delete_lower_than_nr)
	Overwrite in derived classes, if old history entries are being deleted. More...

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

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilPCPlugged Plugged content object (see ILIAS DTD)

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ create()

ilPCPlugged::create	(	ilPageObject	$a_pg_obj,
		string	$a_hier_id,
		string	$a_pc_id,
		string	$a_plugin_name,
		string	$a_plugin_version
	)

Create plugged node in xml.

Definition at line 51 of file class.ilPCPlugged.php.

References ilPageContent\createPageContentNode(), IL_INSERT_AFTER, and ilPageObject\insertContent().

      : void {
         $this->node = $this->createPageContentNode();
         $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
         $this->plug_node = $this->dom->create_element("Plugged");
         $this->plug_node = $this->node->append_child($this->plug_node);
         $this->plug_node->set_attribute("PluginName", $a_plugin_name);
         $this->plug_node->set_attribute("PluginVersion", $a_plugin_version);
     }

Here is the call graph for this function:

◆ getCssFiles()

ilPCPlugged::getCssFiles ( string $a_mode )

Definition at line 383 of file class.ilPCPlugged.php.

References XapiProxy\$plugin, and ilPageContent\getPage().

                                                : array
     {
         $css_files = array();
 
         foreach ($this->component_factory->getActivePluginsInSlot("pgcp") as $plugin) {
             $plugin->setPageObj($this->getPage());
             $pl_dir = $plugin->getDirectory();
 
             $pl_css_files = $plugin->getCssFiles($a_mode);
             foreach ($pl_css_files as $pl_css_file) {
                 if (!is_int(strpos($pl_css_file, "//"))) {
                     $pl_css_file = $pl_dir . "/" . $pl_css_file;
                 }
                 if (!in_array($pl_css_file, $css_files)) {
                     $css_files[] = $pl_css_file;
                 }
             }
         }
 
         return $css_files;
     }

Here is the call graph for this function:

◆ getJavascriptFiles()

ilPCPlugged::getJavascriptFiles ( string $a_mode )

Definition at line 361 of file class.ilPCPlugged.php.

References XapiProxy\$plugin, and ilPageContent\getPage().

                                                       : array
     {
         $js_files = array();
 
         foreach ($this->component_factory->getActivePluginsInSlot("pgcp") as $plugin) {
             $plugin->setPageObj($this->getPage());
             $pl_dir = $plugin->getDirectory();
 
             $pl_js_files = $plugin->getJavascriptFiles($a_mode);
             foreach ($pl_js_files as $pl_js_file) {
                 if (!is_int(strpos($pl_js_file, "//"))) {
                     $pl_js_file = $pl_dir . "/" . $pl_js_file;
                 }
                 if (!in_array($pl_js_file, $js_files)) {
                     $js_files[] = $pl_js_file;
                 }
             }
         }
         //var_dump($js_files);
         return $js_files;
     }

Here is the call graph for this function:

◆ getPluginName()

ilPCPlugged::getPluginName ( )

Definition at line 142 of file class.ilPCPlugged.php.

References $DIC, Vendor\Package\$e, $ilPluginAdmin, $name, ilPageContent\$node, ilPageContent\afterRepositoryCopy(), ilComponentFactory\getPlugin(), and ilComponentRepository\getPluginByName().

                                    : string
     {
         if (is_object($this->plug_node)) {
             return $this->plug_node->get_attribute("PluginName");
         }
         return "";
     }

Here is the call graph for this function:

◆ getPluginVersion()

ilPCPlugged::getPluginVersion ( )

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

                                       : string
     {
         if (is_object($this->plug_node)) {
             return $this->plug_node->get_attribute("PluginVersion");
         }
         return "";
     }

◆ getProperties()

ilPCPlugged::getProperties ( )

Get properties of plugged component.

Definition at line 94 of file class.ilPCPlugged.php.

References $i.

                                    : array
     {
         $properties = array();
 
         if (is_object($this->plug_node)) {
             // delete properties
             $children = $this->plug_node->child_nodes();
             for ($i = 0; $i < count($children); $i++) {
                 if ($children[$i]->node_name() == "PluggedProperty") {
                     $properties[$children[$i]->get_attribute("Name")] =
                         $children[$i]->get_content();
                 }
             }
         }
 
         return $properties;
     }

◆ init()

ilPCPlugged::init ( )

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

References $DIC, ILIAS\Repository\lng(), and ilPageContent\setType().

                           : void
     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->setType("plug");
         $this->component_repository = $DIC["component.repository"];
         $this->component_factory = $DIC["component.factory"];
     }

Here is the call graph for this function:

◆ modifyPageContentPostXsl()

ilPCPlugged::modifyPageContentPostXsl	(	string	$a_output,
		string	$a_mode,
		bool	$a_abstract_only = `false`
	)

Definition at line 296 of file class.ilPCPlugged.php.

References $i, $lng, $param, ilPageContent\getPage(), ILIAS\Repository\lng(), and ilLanguage\txt().

      : string {
         $lng = $this->lng;
 
         $end = 0;
         $start = strpos($a_output, "{{{{{Plugged<pl");
         //echo htmlentities($a_html)."-";
         if (is_int($start)) {
             $end = strpos($a_output, "}}}}}", $start);
         }
 
         while ($end > 0) {
             $param = substr($a_output, $start + 5, $end - $start - 5);
             $param = str_replace(' xmlns:xhtml="http://www.w3.org/1999/xhtml"', "", $param);
             $param = explode("<pl/>", $param);
             //var_dump($param); exit;
             $plugin_name = $param[1];
             $plugin_version = $param[2];
             $properties = array();
 
             for ($i = 3; $i < count($param); $i += 2) {
                 $properties[$param[$i]] = $param[$i + 1];
             }
 
             // get html from plugin
             if ($a_mode == "edit") {
                 $plugin_html = '<div class="ilBox">' . $lng->txt("content_plugin_not_activated") . " (" . $plugin_name . ")</div>";
             }
 
             $plugin_info = $this->component_repository->getPluginByName($plugin_name);
             $plugin_html = '';
             if ($plugin_info->isActive()) {
                 $plugin_obj = $this->component_factory->getPlugin($plugin_info->getId());
                 $plugin_obj->setPageObj($this->getPage());
                 $gui_obj = $plugin_obj->getUIClassInstance();
                 $plugin_html = $gui_obj->getElementHTML($a_mode, $properties, $plugin_version);
             } else {
                 if ($a_mode === "edit") {
                     $plugin_html = sprintf($this->lng->txt("copg_plugin_not_avail"), $plugin_name);
                 } else {
                     $plugin_html = " ";
                 }
             }
 
             $a_output = substr($a_output, 0, $start) .
                 $plugin_html .
                 substr($a_output, $end + 5);
 
             if (strlen($a_output) > $start + 5) {
                 $start = strpos($a_output, "{{{{{Plugged<pl", $start + 5);
             } else {
                 $start = false;
             }
             $end = 0;
             if (is_int($start)) {
                 $end = strpos($a_output, "}}}}}", $start);
             }
         }
 
         return $a_output;
     }

Here is the call graph for this function:

◆ setNode()

ilPCPlugged::setNode ( php4DOMElement $a_node )

Definition at line 42 of file class.ilPCPlugged.php.

References php4DOMNode\first_child().

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

Here is the call graph for this function:

◆ setPluginName()

ilPCPlugged::setPluginName ( string $a_name )

Definition at line 131 of file class.ilPCPlugged.php.

                                                  : void
     {
         if (!empty($a_name)) {
             $this->plug_node->set_attribute("PluginName", $a_name);
         } else {
             if ($this->plug_node->has_attribute("PluginName")) {
                 $this->plug_node->remove_attribute("PluginName");
             }
         }
     }

◆ setPluginVersion()

ilPCPlugged::setPluginVersion ( string $a_version )

Definition at line 112 of file class.ilPCPlugged.php.

                                                        : void
     {
         if (!empty($a_version)) {
             $this->plug_node->set_attribute("PluginVersion", $a_version);
         } else {
             if ($this->plug_node->has_attribute("PluginVersion")) {
                 $this->plug_node->remove_attribute("PluginVersion");
             }
         }
     }

◆ setProperties()

ilPCPlugged::setProperties ( array $a_properties )

Set properties of plugged component.

Definition at line 69 of file class.ilPCPlugged.php.

References $i, and ILIAS\LTI\ToolProvider\$key.

                                                       : void
     {
         if (!is_object($this->plug_node)) {
             return;
         }
 
         // delete properties
         $children = $this->plug_node->child_nodes();
         for ($i = 0; $i < count($children); $i++) {
             $this->plug_node->remove_child($children[$i]);
         }
         // set properties
         foreach ($a_properties as $key => $value) {
             $prop_node = $this->dom->create_element("PluggedProperty");
             $prop_node = $this->plug_node->append_child($prop_node);
             $prop_node->set_attribute("Name", $key);
             if ($value != "") {
                 $prop_node->set_content($value);
             }
         }
     }

Field Documentation

◆ $component_factory

ilComponentFactory ilPCPlugged::$component_factory

protected

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

◆ $component_repository

ilComponentRepository ilPCPlugged::$component_repository

protected

Definition at line 29 of file class.ilPCPlugged.php.

◆ $lng

ilLanguage ilPCPlugged::$lng

protected

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

Referenced by modifyPageContentPostXsl().

◆ $plug_node

php4DOMElement ilPCPlugged::$plug_node

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

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

Services/COPage/classes/class.ilPCPlugged.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ getCssFiles()

◆ getJavascriptFiles()

◆ getPluginName()

◆ getPluginVersion()

◆ getProperties()

◆ init()

◆ modifyPageContentPostXsl()

◆ setNode()

◆ setPluginName()

◆ setPluginVersion()

◆ setProperties()

Field Documentation

◆ $component_factory

◆ $component_repository

◆ $lng

◆ $plug_node