ilPCResources Class Reference

Class ilPCResources. More...

Inheritance diagram for ilPCResources:

Collaboration diagram for ilPCResources:

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="")
	Create resources node in xml. More...
	setResourceListType ($a_type)
	Set Type of Resource List (currently only one) More...
	setItemGroupRefId ($a_ref_id)
	Set Item Group Ref Id. More...
	getResourceListType ()
	Get Resource Lis Type. More...
	getItemGroupRefId ()
	Get item group ref id. More...
	getMainType ()
	Get main type. 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...
	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)
	Modify page content after xsl. More...

Static Public Member Functions
static	modifyItemGroupRefIdsByMapping ($a_page, $mappings)
	Modify ref ids by mapping. More...
static	getLangVars ()
	Get lang vars needed for editing. More...
static	resolveResources (ilPageObject $page, $ref_mappings)
	Resolve resources. More...
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...

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

Additional Inherited Members
Protected Member Functions inherited from ilPageContent
	setType ($a_type)
	Set Type. More...
Protected Attributes inherited from ilPageContent
	$file_download_link
	$fullscreen_link
	$sourcecode_download_script
	$log

Detailed Description

Class ilPCResources.

Resources content object (see ILIAS DTD). Inserts Repository Resources of a Container Object,

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Member Function Documentation

create()

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

Create resources node in xml.

Parameters

object	$a_pg_obj	Page Object
string	$a_hier_id	Hierarchical ID

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

References ilPageContent\createPageContentNode(), and IL_INSERT_AFTER.

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

Here is the call graph for this function:

getItemGroupRefId()

ilPCResources::getItemGroupRefId

(

)

Get item group ref id.

Returns

int ref id

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

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

getLangVars()

static ilPCResources::getLangVars ( )

static

Get lang vars needed for editing.

Returns

array array of lang var keys

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

References array.

    {
        return array("pc_res");
    }

getMainType()

ilPCResources::getMainType

(

)

Get main type.

Returns

int ref id

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

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

getResourceListType()

ilPCResources::getResourceListType

(

)

Get Resource Lis Type.

Returns

string resource type group

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

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

init()

ilPCResources::init

(

)

Init page content component.

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

References ilPageContent\setType().

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

Here is the call graph for this function:

modifyItemGroupRefIdsByMapping()

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

static

Modify ref ids by mapping.

Parameters

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

References $dom.

Referenced by ilObjItemGroup\fixContainerItemGroupRefsAfterCloning().

    {
        $dom = $a_page->getDom();
        
        if ($dom instanceof php4DOMDocument) {
            $dom = $dom->myDOMDocument;
        }
 
        $xpath_temp = new DOMXPath($dom);
        $igs = $xpath_temp->query("//Resources/ItemGroup");

        $updated = false;
        foreach ($igs as $ig_node) {
            $ref_id = $ig_node->getAttribute("RefId");
            if ($mappings[$ref_id] > 0) {
                $ig_node->setAttribute("RefId", $mappings[$ref_id]);
                $updated = true;
            }
        }
        return $updated;
    }

Here is the caller graph for this function:

resolveResources()

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

static

Resolve resources.

Parameters

ilPageObject

$page

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

Referenced by ilPageObject\resolveResources().

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

Here is the caller graph for this function:

setItemGroupRefId()

ilPCResources::setItemGroupRefId

(

$a_ref_id

)

Set Item Group Ref Id.

Parameters

int

$a_ref_id

item group ref id

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

References $i.

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

setNode()

ilPCResources::setNode

(

$a_node

)

Set node.

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

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

setResourceListType()

ilPCResources::setResourceListType

(

$a_type

)

Set Type of Resource List (currently only one)

Parameters

string

$a_type

Resource Type Group

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

References $a_type, and $i.

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

Field Documentation

$dom

ilPCResources::$dom

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

Referenced by modifyItemGroupRefIdsByMapping().

$res_node

ilPCResources::$res_node

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

---

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

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