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

Collaboration diagram for ilPCResources:

Public Member Functions
	init ()
	Init object. 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="")
	setResourceListType (string $a_type)
	setItemGroupRefId (int $a_ref_id)
	getResourceListType ()
	Get Resource List Type. More...
	getItemGroupRefId ()
	Get item group ref id. More...
	getMainType ()
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	modifyItemGroupRefIdsByMapping (ilPageObject $a_page, array $mappings)
static	getLangVars ()
	Get lang vars needed for editing. More...
static	resolveResources (ilPageObject $page, array $ref_mappings)
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	$res_node
Data Fields inherited from ilPageContent
string	$hier_id = ""
php4DOMElement	$node = null
php4DOMDocument	$dom = null
string	$page_lang = ""

Additional Inherited Members
Protected Member Functions inherited from ilPageContent
	setType (string $a_type)
	Set Type. More...
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 Resources content object (see ILIAS DTD). Inserts Repository Resources of a Container Object,

Author

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

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

Member Function Documentation

create()

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

Definition at line 40 of file class.ilPCResources.php.

     : void {
        $this->node = $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->res_node = $this->dom->create_element("Resources");
        $this->res_node = $this->node->append_child($this->res_node);
    }

getItemGroupRefId()

ilPCResources::getItemGroupRefId

(

)

Get item group ref id.

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

                                       : ?int
    {
        if (is_object($this->res_node)) {
            $children = $this->res_node->child_nodes();
            if (is_object($children[0]) && $children[0]->node_name() == "ItemGroup") {
                return (int) $children[0]->get_attribute("RefId");
            }
        }
        return null;
    }

getLangVars()

static ilPCResources::getLangVars ( )

static

Get lang vars needed for editing.

Returns

string[] array of lang var keys

Reimplemented from ilPageContent.

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

                                        : array
    {
        return array("pc_res");
    }

getMainType()

ilPCResources::getMainType

(

)

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

                                 : ?string
    {
        if (is_object($this->res_node)) {
            $children = $this->res_node->child_nodes();
            if (is_object($children[0])) {
                return (string) $children[0]->node_name();
            }
        }
        return null;
    }

getResourceListType()

ilPCResources::getResourceListType

(

)

Get Resource List Type.

Definition at line 80 of file class.ilPCResources.php.

                                         : ?string
    {
        if (is_object($this->res_node)) {
            $children = $this->res_node->child_nodes();
            if (is_object($children[0]) && $children[0]->node_name() == "ResourceList") {
                return $children[0]->get_attribute("Type");
            }
        }
        return null;
    }

init()

ilPCResources::init

(

)

Init object.

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

Reimplemented from ilPageContent.

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

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

References ilPageContent\setType().

Here is the call graph for this function:

modifyItemGroupRefIdsByMapping()

static ilPCResources::modifyItemGroupRefIdsByMapping ( ilPageObject  $a_page, array  $mappings  )

static

Definition at line 116 of file class.ilPCResources.php.

     : bool {
        $dom = $a_page->getDom();
        $log = ilLoggerFactory::getLogger('copg');
 
        if ($dom instanceof php4DOMDocument) {
            $dom = $dom->myDOMDocument;
        }
        $changed = false;
        $xpath_temp = new DOMXPath($dom);
        $igs = $xpath_temp->query("//Resources/ItemGroup");
 
        foreach ($igs as $ig_node) {
            $ref_id = $ig_node->getAttribute("RefId");
            $log->debug(">>> Fix Item Group with import Ref Id:" . $ref_id);
            $log->debug("Ref Id Mapping:" . print_r($mappings, true));
            if (($mappings[$ref_id] ?? 0) > 0) {
                $ig_node->setAttribute("RefId", $mappings[$ref_id]);
                $changed = true;
            }
        }
        return $changed;
    }

resolveResources()

static ilPCResources::resolveResources ( ilPageObject  $page, array  $ref_mappings  )

static

Definition at line 147 of file class.ilPCResources.php.

     : bool {
        return self::modifyItemGroupRefIdsByMapping($page, $ref_mappings);
    }

Referenced by ilPageObject\resolveResources().

Here is the caller graph for this function:

setItemGroupRefId()

ilPCResources::setItemGroupRefId

(

int

$a_ref_id

)

Definition at line 64 of file class.ilPCResources.php.

                                                    : void
    {
        if (!empty($a_ref_id)) {
            $children = $this->res_node->child_nodes();
            for ($i = 0; $i < count($children); $i++) {
                $this->res_node->remove_child($children[$i]);
            }
            $list_node = $this->dom->create_element("ItemGroup");
            $list_node = $this->res_node->append_child($list_node);
            $list_node->set_attribute("RefId", $a_ref_id);
        }
    }

References $i.

setNode()

ilPCResources::setNode

(

php4DOMElement

$a_node

)

Set xml node of page content.

Parameters

php4DOMElement

$a_node

node object

Reimplemented from ilPageContent.

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

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

References php4DOMNode\first_child().

Here is the call graph for this function:

setResourceListType()

ilPCResources::setResourceListType

(

string

$a_type

)

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

                                                       : void
    {
        if (!empty($a_type)) {
            $children = $this->res_node->child_nodes();
            for ($i = 0; $i < count($children); $i++) {
                $this->res_node->remove_child($children[$i]);
            }
            $list_node = $this->dom->create_element("ResourceList");
            $list_node = $this->res_node->append_child($list_node);
            $list_node->set_attribute("Type", $a_type);
        }
    }

References $i.

Field Documentation

$res_node

php4DOMElement ilPCResources::$res_node

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

---

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

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