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

Collaboration diagram for ilPCContentTemplate:

Public Member Functions
	init ()
	create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id, string $a_page_templ)
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 Member Functions
	getTemplatePage (string $a_page_templ)
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=[])

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

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 Content templates are not existing in the page. Once they are inserted into a page all content elements of the template are inserted instead.

Author

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

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

Member Function Documentation

create()

ilPCContentTemplate::create	(	ilPageObject	$a_pg_obj,
		string	$a_hier_id,
		string	$a_pc_id,
		string	$a_page_templ
	)

Definition at line 38 of file class.ilPCContentTemplate.php.

References ilPageContent\$hier_id, ilPageContent\getDomDoc(), ilPageObjectFactory\getInstance(), getLanguage(), ilPageContent\getPage(), and IL_INSERT_AFTER.

                                                                                                            : void
    {
        $source_id = explode(":", $a_page_templ);
        $source_page = ilPageObjectFactory::getInstance(
            $source_id[1],
            (int) $source_id[0],
            0,
            $this->getPage()->getLanguage()
        );
        $source_page->buildDom();
        $source_page->addHierIDs();
        $hier_ids = $source_page->getHierIds();

        $copy_ids = array();
        foreach ($hier_ids as $hier_id) {
            // move top level nodes only
            if (!is_int(strpos($hier_id, "_"))) {
                if ($hier_id != "pg") {
                    $copy_ids[] = $hier_id;
                }
            }
        }
        arsort($copy_ids);
        foreach ($copy_ids as $copy_id) {
            $source_content = $source_page->getContentObject($copy_id);

            $source_node = $source_content->getDomNode();
            $clone_node = $source_node->cloneNode(true);
            $clone_node = $this->getPage()->getDomDoc()->importNode($clone_node, true);

            // insert cloned node at target
            $source_content->setDomNode($clone_node);
            $this->getPage()->insertContent($source_content, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
            $xpath = new DOMXpath($this->getPage()->getDomDoc());
            if ($clone_node->getAttribute("PCID") != "") {
                $clone_node->setAttribute("PCID", "");
            }
            $els = $xpath->query(".//*[@PCID]", $clone_node);
            foreach ($els as $el) {
                $el->setAttribute("PCID", "");
            }
        }
        $this->getPage()->update();
    }

Here is the call graph for this function:

getTemplatePage()

ilPCContentTemplate::getTemplatePage ( string  $a_page_templ )

protected

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

References ilPageContent\getPageManager().

                                                            : ilPageObject
    {
        $source_id = explode(":", $a_page_templ);
        return $this->getPageManager()->get($source_id[1], (int) $source_id[0]);
    }

Here is the call graph for this function:

init()

ilPCContentTemplate::init

(

)

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

References ilPageContent\setType().

                          : void
    {
        $this->setType("templ");
    }

Here is the call graph for this function:

---

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

• components/ILIAS/COPage/PC/ContentTemplate/class.ilPCContentTemplate.php