ilPCPlugged Class Reference

Class ilPCPlugged Plugged content object (see ILIAS DTD) More...

Inheritance diagram for ilPCPlugged:

Collaboration diagram for ilPCPlugged:

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, $a_plugin_name, $a_plugin_version)
	Create plugged node in xml. More...
	setProperties ($a_properties)
	Set properties of plugged component. More...
	getProperties ()
	Get properties of plugged component. More...
	setPluginVersion ($a_version)
	Set version of plugged component. More...
	getPluginVersion ()
	Get version of plugged component. More...
	setPluginName ($a_name)
	Set name of plugged component. More...
	getPluginName ()
	Get name of plugged component. More...
	modifyPageContentPostXsl ($a_html, $a_mode, $a_abstract_only=false)
	@inheritDoc More...
	getJavascriptFiles ($a_mode)
	Get javascript files. More...
	getCssFiles ($a_mode)
	Get css files. 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...
	setProfileBackUrl ($url)
	getProfileBackUrl ()
	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, $a_abstract_only=false)
	Modify page content after xsl. More...

Data Fields
	$dom
	$plug_node
Data Fields inherited from ilPageContent
	$hier_id
	$node
	$dom
	$page_lang

Protected Attributes
	$lng
	$plugin_admin
Protected Attributes inherited from ilPageContent
	$profile_back_url
	$file_download_link
	$fullscreen_link
	$sourcecode_download_script
	$log

Additional Inherited Members
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...
Protected Member Functions inherited from ilPageContent
	setType ($a_type)
	Set Type. More...

Detailed Description

Class ilPCPlugged Plugged 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 16 of file class.ilPCPlugged.php.

Member Function Documentation

create()

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

Create plugged node in xml.

Parameters

object	$a_pg_obj	Page Object
string	$a_hier_id	Hierarchical ID

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

      {
        $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);
    }

References ilPageContent\createPageContentNode(), and IL_INSERT_AFTER.

Here is the call graph for this function:

getCssFiles()

ilPCPlugged::getCssFiles

(

$a_mode

)

Get css files.

Reimplemented from ilPageContent.

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

    {
        $ilPluginAdmin = $this->plugin_admin;
        
        $css_files = array();
        
        $pl_names = $ilPluginAdmin->getActivePluginsForSlot(
            IL_COMP_SERVICE,
            "COPage",
            "pgcp"
        );
        foreach ($pl_names as $pl_name) {
            $plugin = $ilPluginAdmin->getPluginObject(
                IL_COMP_SERVICE,
                "COPage",
                "pgcp",
                $pl_name
            );
            $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, $plugin_admin, ilPageContent\getPage(), and IL_COMP_SERVICE.

Here is the call graph for this function:

getJavascriptFiles()

ilPCPlugged::getJavascriptFiles

(

$a_mode

)

Get javascript files.

Reimplemented from ilPageContent.

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

    {
        $ilPluginAdmin = $this->plugin_admin;
        
        $js_files = array();
        
        $pl_names = $ilPluginAdmin->getActivePluginsForSlot(
            IL_COMP_SERVICE,
            "COPage",
            "pgcp"
        );
        foreach ($pl_names as $pl_name) {
            $plugin = $ilPluginAdmin->getPluginObject(
                IL_COMP_SERVICE,
                "COPage",
                "pgcp",
                $pl_name
            );
            $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, $plugin_admin, ilPageContent\getPage(), and IL_COMP_SERVICE.

Here is the call graph for this function:

getPluginName()

ilPCPlugged::getPluginName

(

)

Get name of plugged component.

Returns

string name

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

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

getPluginVersion()

ilPCPlugged::getPluginVersion

(

)

Get version of plugged component.

Returns

string version

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

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

getProperties()

ilPCPlugged::getProperties

(

)

Get properties of plugged component.

Returns

string characteristic

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

    {
        $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;
    }

References $i.

init()

ilPCPlugged::init

(

)

Init page content component.

Reimplemented from ilPageContent.

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->plugin_admin = $DIC["ilPluginAdmin"];
        $this->setType("plug");
    }

References $DIC, and ilPageContent\setType().

Here is the call graph for this function:

modifyPageContentPostXsl()

ilPCPlugged::modifyPageContentPostXsl	(		$a_html,
			$a_mode,
			$a_abstract_only = false
	)

@inheritDoc

Reimplemented from ilPageContent.

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

    {
        $lng = $this->lng;
        $ilPluginAdmin = $this->plugin_admin;
        
        $c_pos = 0;
        $start = strpos($a_html, "{{{{{Plugged<pl");
        //echo htmlentities($a_html)."-";
        if (is_int($start)) {
            $end = strpos($a_html, "}}}}}", $start);
        }
        $i = 1;
 
        while ($end > 0) {
            $param = substr($a_html, $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>";
            }
            if ($ilPluginAdmin->isActive(IL_COMP_SERVICE, "COPage", "pgcp", $plugin_name)) {
                $plugin_obj = $ilPluginAdmin->getPluginObject(
                    IL_COMP_SERVICE,
                    "COPage",
                    "pgcp",
                    $plugin_name
                );
                $plugin_obj->setPageObj($this->getPage());
                $gui_obj = $plugin_obj->getUIClassInstance();
                $plugin_html = $gui_obj->getElementHTML($a_mode, $properties, $plugin_version);
            }
            
            $a_html = substr($a_html, 0, $start) .
                $plugin_html .
                substr($a_html, $end + 5);
 
            if (strlen($a_html) > $start + 5) {
                $start = strpos($a_html, "{{{{{Plugged<pl", $start + 5);
            } else {
                $start = false;
            }
            $end = 0;
            if (is_int($start)) {
                $end = strpos($a_html, "}}}}}", $start);
            }
        }
                
        return $a_html;
    }

References $i, $lng, $param, $plugin_admin, ilPageContent\getPage(), and IL_COMP_SERVICE.

Here is the call graph for this function:

setNode()

ilPCPlugged::setNode

(

$a_node

)

Set node.

Reimplemented from ilPageContent.

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

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

setPluginName()

ilPCPlugged::setPluginName

(

$a_name

)

Set name of plugged component.

Parameters

string

$a_name

name

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

    {
        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

(

$a_version

)

Set version of plugged component.

Parameters

string

$a_version

version

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

    {
        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

(

$a_properties

)

Set properties of plugged component.

Parameters

array

$a_properties

component properties

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

    {
        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);
            }
        }
    }

References $i.

Field Documentation

$dom

ilPCPlugged::$dom

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

$lng

ilPCPlugged::$lng

protected

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

Referenced by modifyPageContentPostXsl().

$plug_node

ilPCPlugged::$plug_node

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

$plugin_admin

ilPCPlugged::$plugin_admin

protected

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

Referenced by getCssFiles(), getJavascriptFiles(), and modifyPageContentPostXsl().

---

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

• Services/COPage/classes/class.ilPCPlugged.php