ilPCContentInclude 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 ilPCContentInclude:

Collaboration diagram for ilPCContentInclude:

Public Member Functions
	init ()
	Init page content component. More...
	setNode (php4DOMElement $a_node)
	Set xml node of page content. More...
	create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")
	setContentId (int $a_id)
	Set content id. More...
	getContentId ()
	Get content id. More...
	setContentType (string $a_type)
	Set content type. More...
	getContentType ()
	Get content type. More...
	setInstId (string $a_id)
	Set installation id. More...
	getInstId ()
	Get installation id. More...
	getContentIncludeAttribute (string $a_attr)
	Get content include tag attribute. More...
	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...
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...

Static Public Member Functions
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	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	saveContentIncludeUsage (ilPageObject $a_page, DOMDocument $a_domdoc, int $a_old_nr=0)
	save content include usages More...
static	collectContentIncludes (ilPageObject $a_page, DOMDocument $a_domdoc)
	get all content includes that are used within the page 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...
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...

Data Fields
php4DOMElement	$incl_node
Data Fields inherited from ilPageContent
string	$hier_id = ""
php4DOMElement	$node = null
php4DOMDocument	$dom = null
string	$page_lang = ""

Protected Member Functions
	setContentIncludeAttribute (string $a_attr, string $a_value)
	Set attribute of content include tag. More...
Protected Member Functions inherited from ilPageContent
	setType (string $a_type)
	Set Type. More...

Protected Attributes
ilLanguage	$lng
	ilAccessHandler$access
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 = ""

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 ilPCContentInclude

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

Author

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

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

Member Function Documentation

afterPageHistoryEntry()

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

static

After page history entry has been created.

Reimplemented from ilPageContent.

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

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

afterPageUpdate()

static ilPCContentInclude::afterPageUpdate ( ilPageObject  $a_page, DOMDocument  $a_domdoc, string  $a_xml, bool  $a_creation  )

static

After page has been updated (or created)

Reimplemented from ilPageContent.

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

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

beforePageDelete()

static ilPCContentInclude::beforePageDelete ( ilPageObject  $a_page )

static

Before page is being deleted.

Reimplemented from ilPageContent.

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

                                                                 : void
    {
        ilPageContentUsage::deleteAllUsages("incl", $a_page->getParentType() . ":pg", $a_page->getId(), 0, $a_page->getLanguage());
    }

References ilPageContentUsage\deleteAllUsages(), ilPageObject\getId(), ilPageObject\getLanguage(), and ilPageObject\getParentType().

Here is the call graph for this function:

collectContentIncludes()

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

static

get all content includes that are used within the page

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

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

Referenced by ilPageObjectGUI\showPage().

Here is the caller graph for this function:

create()

ilPCContentInclude::create	(	ilPageObject	$a_pg_obj,
		string	$a_hier_id,
		string	$a_pc_id = ""
	)

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

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

deleteHistoryLowerEqualThan()

static ilPCContentInclude::deleteHistoryLowerEqualThan ( string  $parent_type, int  $page_id, string  $lang, int  $delete_lower_than_nr  )

static

Overwrite in derived classes, if old history entries are being deleted.

Reimplemented from ilPageContent.

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

     : void {
        global $DIC;
 
        $usage_repo = $DIC->copage()
                          ->internal()
                          ->repo()
                          ->usage();
 
        $usage_repo->deleteHistoryUsagesLowerEqualThan(
            "incl",
            $parent_type . ":pg",
            $page_id,
            $delete_lower_than_nr,
            $lang
        );
    }

getContentId()

ilPCContentInclude::getContentId

(

)

Get content id.

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

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

getContentIncludeAttribute()

ilPCContentInclude::getContentIncludeAttribute

(

string

$a_attr

)

Get content include tag attribute.

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

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

getContentType()

ilPCContentInclude::getContentType

(

)

Get content type.

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

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

getInstId()

ilPCContentInclude::getInstId

(

)

Get installation id.

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

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

init()

ilPCContentInclude::init

(

)

Init page content component.

Reimplemented from ilPageContent.

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

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

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

Here is the call graph for this function:

modifyPageContentPostXsl()

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

Modify page content after xsl.

Reimplemented from ilPageContent.

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

     : string {
        $lng = $this->lng;
 
        $end = 0;
        $start = strpos($a_output, "{{{{{ContentInclude;");
        if (is_int($start)) {
            $end = strpos($a_output, "}}}}}", $start);
        }
        $i = 1;
        $parent_lang = $this->getPage()->getLanguage();
        if ($parent_lang == "-" && $this->getPage()->getConcreteLang() != "") {
            $parent_lang = $this->getPage()->getConcreteLang();
        }
        while ($end > 0) {
            $param = substr($a_output, $start + 20, $end - $start - 20);
            $param = explode(";", $param);
 
            if ($param[0] == "mep" && is_numeric($param[1])) {
                $html = "";
                $snippet_lang = $parent_lang;
                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->setProfileBackUrl($this->getProfileBackUrl());
                        $page_gui->setFullscreenLink($this->getFullscreenLink() . "&pg_type=mep");
                        $page_gui->setSourcecodeDownloadScript($this->getSourcecodeDownloadScript());
                    } else {
                        $page_gui->setOutputMode(ilPageObjectGUI::OFFLINE);
                    }
 
                    $html = $page_gui->getRawContent();
                    if ($a_mode == "edit") {
                        $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_output, 0, $start) .
                    $html .
                    substr($a_output, $end + 5);
                $a_output = $h2;
                $i++;
            }
 
            $start = strpos($a_output, "{{{{{ContentInclude;", $start + 5);
            $end = 0;
            if (is_int($start)) {
                $end = strpos($a_output, "}}}}}", $start);
            }
        }
        return $a_output;
    }

saveContentIncludeUsage()

static ilPCContentInclude::saveContentIncludeUsage ( ilPageObject  $a_page, DOMDocument  $a_domdoc, int  $a_old_nr = 0  )

static

save content include usages

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

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

setContentId()

ilPCContentInclude::setContentId

(

int

$a_id

)

Set content id.

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

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

setContentIncludeAttribute()

ilPCContentInclude::setContentIncludeAttribute ( string  $a_attr, string  $a_value  )

protected

Set attribute of content include tag.

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

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

setContentType()

ilPCContentInclude::setContentType

(

string

$a_type

)

Set content type.

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

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

setInstId()

ilPCContentInclude::setInstId

(

string

$a_id

)

Set installation id.

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

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

setNode()

ilPCContentInclude::setNode

(

php4DOMElement

$a_node

)

Set xml node of page content.

Parameters

php4DOMElement

$a_node

node object

Reimplemented from ilPageContent.

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

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

References php4DOMNode\first_child().

Here is the call graph for this function:

Field Documentation

$incl_node

php4DOMElement ilPCContentInclude::$incl_node

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

$lng

ilLanguage ilPCContentInclude::$lng

protected

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

ilAccessHandler$access

ilPCContentInclude::ilAccessHandler$access

protected

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

---

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

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