ilPCPlugged Class Reference

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 ()
	Init object. More...
	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)
	Modify page content after xsl. More...
	getJavascriptFiles (string $a_mode)
	getCssFiles (string $a_mode)
Public Member Functions inherited from ilPageContent
	__construct (ilPageObject $a_pg_obj, ?PageManagerInterface $page_manager=null, ?ObjectAdapterInterface $object_adapter=null)
	setPage (ilPageObject $a_val)
	getPage ()
	init ()
	Init object. More...
	getType ()
	getDomNode ()
	getDomDoc ()
	setDomNode (DOMNode $node)
	getChildNode ()
	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...
	getNewPageContentNode ()
	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...

Protected Attributes
ilLanguage	$lng
ilComponentRepository	$component_repository = null
ilComponentFactory	$component_factory = null
Protected Attributes inherited from ilPageContent
DOMDocument	$dom_doc
ILIAS COPage InternalDomainService	$domain
string	$pcid
string	$type = ""
ilPageObject	$pg_obj
string	$file_download_link = ''
string	$fullscreen_link = ''
string	$sourcecode_download_script = ''
ilLogger	$log
string	$profile_back_url = ""
ILIAS COPage Dom DomUtil	$dom_util
PageManagerInterface	$page_manager = null
ObjectAdapterInterface	$object = null

Additional Inherited Members
Static Public Member Functions inherited from ilPageContent
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...
Data Fields inherited from ilPageContent
string	$hier_id = ""
DOMNode	$dom_node = null
string	$page_lang = ""
Protected Member Functions inherited from ilPageContent
	getPageManager ()
	setType (string $a_type)
	Set Type. More...
	hasNode ()
	createInitialChildNode (string $hier_id, string $pc_id, string $child, array $child_attributes=[])

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 44 of file class.ilPCPlugged.php.

     : void {
        $this->createInitialChildNode(
            $a_hier_id,
            $a_pc_id,
            "Plugged",
            ["PluginName" => $a_plugin_name, "PluginVersion" => $a_plugin_version]
        );
    }

getCssFiles()

ilPCPlugged::getCssFiles

(

string

$a_mode

)

Reimplemented from ilPageContent.

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

                                               : 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;
    }

References XapiProxy\$plugin.

getJavascriptFiles()

ilPCPlugged::getJavascriptFiles

(

string

$a_mode

)

Reimplemented from ilPageContent.

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

                                                      : 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;
    }

References XapiProxy\$plugin.

getPluginName()

ilPCPlugged::getPluginName

(

)

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

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

getPluginVersion()

ilPCPlugged::getPluginVersion

(

)

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

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

getProperties()

ilPCPlugged::getProperties

(

)

Get properties of plugged component.

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

                                   : array
    {
        $properties = array();
 
        if (is_object($this->getChildNode())) {
            foreach ($this->getChildNode()->childNodes as $c) {
                if ($c->nodeName == "PluggedProperty") {
                    $properties[$c->getAttribute("Name")] =
                        $this->dom_util->getContent($c);
                }
            }
        }
 
        return $properties;
    }

References $c.

init()

ilPCPlugged::init

(

)

Init object.

This function must be overwritten and at least set the content type.

Reimplemented from ilPageContent.

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

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

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

Here is the call graph for this function:

modifyPageContentPostXsl()

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

Modify page content after xsl.

Reimplemented from ilPageContent.

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

     : 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_obj = self::getActivePluginByName($plugin_name);
            $plugin_html = '';
            if (is_object($plugin_obj)) {
                $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;
    }

setPluginName()

ilPCPlugged::setPluginName

(

string

$a_name

)

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

                                                 : void
    {
        if (!empty($a_name)) {
            $this->getChildNode()->setAttribute("PluginName", $a_name);
        } else {
            if ($this->getChildNode()->hasAttribute("PluginName")) {
                $this->getChildNode()->removeAttribute("PluginName");
            }
        }
    }

setPluginVersion()

ilPCPlugged::setPluginVersion

(

string

$a_version

)

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

                                                       : void
    {
        if (!empty($a_version)) {
            $this->getChildNode()->setAttribute("PluginVersion", $a_version);
        } else {
            if ($this->getChildNode()->hasAttribute("PluginVersion")) {
                $this->getChildNode()->removeAttribute("PluginVersion");
            }
        }
    }

setProperties()

ilPCPlugged::setProperties

(

array

$a_properties

)

Set properties of plugged component.

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

                                                      : void
    {
        if (!is_object($this->getChildNode())) {
            return;
        }
 
        // delete properties
        $this->dom_util->deleteAllChilds($this->getChildNode());
        // set properties
        foreach ($a_properties as $key => $value) {
            $prop_node = $this->dom_doc->createElement("PluggedProperty");
            $prop_node = $this->getChildNode()->appendChild($prop_node);
            $prop_node->setAttribute("Name", $key);
            if ($value != "") {
                $this->dom_util->setContent($prop_node, $value);
            }
        }
    }

Field Documentation

$component_factory

ilComponentFactory ilPCPlugged::$component_factory = null

protected

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

$component_repository

ilComponentRepository ilPCPlugged::$component_repository = null

protected

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

$lng

ilLanguage ilPCPlugged::$lng

protected

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

---

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

• components/ILIAS/COPage/PC/Plugged/class.ilPCPlugged.php