Inheritance diagram for ilPCFileList:

Collaboration diagram for ilPCFileList:

Public Member Functions
	init ()
	Init page content component. More...

	setNode ($a_node)
	Set xml node of page content. More...

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

	appendItem ($a_id, $a_location, $a_format)

	setListTitle ($a_title, $a_language)

	getListTitle ()

	getLanguage ()

	getFileList ()
	Get list of files. More...

	deleteFileItems ($a_ids)
	Delete file items. More...

	savePositions ($a_pos)
	Save positions of file items. More...

	getAllClasses ()
	Get all style classes. More...

	saveStyleClasses ($a_class)
	Save style classes of file items. 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...

	getModel ()
	Get model. More...

Static Public Member Functions
static	getLangVars ()
	Get lang vars needed for editing. 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...

static	saveFileUsage ($a_page, $a_domdoc, $a_old_nr=0)
	Save file usages. More...

static	collectFileItems ($a_page, $a_domdoc)
	Get all file items that are used within the page. 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
	$list_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
	$profile_back_url

	$file_download_link

	$fullscreen_link

	$sourcecode_download_script

	$log

Detailed Description

Class ilPCFileList.

File List 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 18 of file class.ilPCFileList.php.

Member Function Documentation

◆ afterPageHistoryEntry()

static ilPCFileList::afterPageHistoryEntry	(		$a_page,
		DOMDocument	$a_old_domdoc,
			$a_old_xml,
			$a_old_nr
	)

static

After page history entry has been created.

Parameters

object	$a_page	page object
DOMDocument	$a_old_domdoc	old dom document
string	$a_old_xml	old xml
integer	$a_old_nr	history number

Reimplemented from ilPageContent.

Definition at line 312 of file class.ilPCFileList.php.

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

References saveFileUsage().

Here is the call graph for this function:

◆ afterPageUpdate()

static ilPCFileList::afterPageUpdate	(		$a_page,
		DOMDocument	$a_domdoc,
			$a_xml,
			$a_creation
	)

static

After page has been updated (or created)

Parameters

object	$a_page	page object
DOMDocument	$a_domdoc	dom document
string	$a_xml	xml
bool	$a_creation	true on creation, otherwise false

Reimplemented from ilPageContent.

Definition at line 250 of file class.ilPCFileList.php.

    {
        if (!$a_page->getImportMode()) {
            // pc filelist
            include_once("./Modules/File/classes/class.ilObjFile.php");
            $file_ids = ilObjFile::_getFilesOfObject(
                $a_page->getParentType() . ":pg",
                $a_page->getId(),
                0,
                $a_page->getLanguage()
            );
            self::saveFileUsage($a_page, $a_domdoc);
 
            foreach ($file_ids as $file) {      // check, whether file object can be deleted
                if (ilObject::_exists($file) && ilObject::_lookupType($file) == "file") {
                    $file_obj = new ilObjFile($file, false);
                    $usages = $file_obj->getUsages();
                    if (count($usages) == 0) {  // delete, if no usage exists
                        if ($file_obj->getMode() == "filelist") {               // non-repository object
                            $file_obj->delete();
                        }
                    }
                }
            }
        }
    }

References ilObject\_exists(), ilObject\_lookupType(), and saveFileUsage().

Here is the call graph for this function:

◆ appendItem()

ilPCFileList::appendItem	(	$a_id,
		$a_location,
		$a_format
	)

Definition at line 54 of file class.ilPCFileList.php.

    {
        // File Item
        $new_item = $this->dom->create_element("FileItem");
        $new_item = $this->list_node->append_child($new_item);
 
        // Identifier
        $id_node = $this->dom->create_element("Identifier");
        $id_node = $new_item->append_child($id_node);
        $id_node->set_attribute("Catalog", "ILIAS");
        $id_node->set_attribute("Entry", "il__file_" . $a_id);
 
        // Location
        $loc_node = $this->dom->create_element("Location");
        $loc_node = $new_item->append_child($loc_node);
        $loc_node->set_attribute("Type", "LocalFile");
        $loc_node->set_content($a_location);
 
        // Format
        $form_node = $this->dom->create_element("Format");
        $form_node = $new_item->append_child($form_node);
        $form_node->set_content($a_format);
    }

◆ beforePageDelete()

static ilPCFileList::beforePageDelete ( $a_page )

static

Before page is being deleted.

Parameters

object $a_page page object

Reimplemented from ilPageContent.

Definition at line 282 of file class.ilPCFileList.php.

    {
        $files = self::collectFileItems($a_page, $a_page->getDomDoc());
        
        // delete all file usages
        include_once("./Modules/File/classes/class.ilObjFile.php");
        ilObjFile::_deleteAllUsages(
            $a_page->getParentType() . ":pg",
            $a_page->getId(),
            false,
            $a_page->getLanguage()
        );
 
        include_once("./Modules/File/classes/class.ilObjFile.php");
        foreach ($files as $file_id) {
            if (ilObject::_exists($file_id)) {
                $file_obj = new ilObjFile($file_id, false);
                $file_obj->delete();
            }
        }
    }

References ilObject\_exists(), and collectFileItems().

Here is the call graph for this function:

◆ collectFileItems()

static ilPCFileList::collectFileItems	(	$a_page,
		$a_domdoc
	)

static

Get all file items that are used within the page.

Definition at line 339 of file class.ilPCFileList.php.

    {
        $xpath = new DOMXPath($a_domdoc);
        $nodes = $xpath->query('//FileItem/Identifier');
        $file_ids = array();
        foreach ($nodes as $node) {
            $id_arr = explode("_", $node->getAttribute("Entry"));
            $file_id = $id_arr[count($id_arr) - 1];
            if ($file_id > 0 && ($id_arr[1] == "" || $id_arr[1] == IL_INST_ID || $id_arr[1] == 0)) {
                $file_ids[$file_id] = $file_id;
            }
        }
        // file items in download links
        $xpath = new DOMXPath($a_domdoc);
        $nodes = $xpath->query("//IntLink[@Type='File']");
        foreach ($nodes as $node) {
            $t = $node->getAttribute("Target");
            if (substr($t, 0, 9) == "il__dfile") {
                $id_arr = explode("_", $t);
                $file_id = $id_arr[count($id_arr) - 1];
                $file_ids[$file_id] = $file_id;
            }
        }
        return $file_ids;
    }

References ilPageContent\$node, and IL_INST_ID.

Referenced by beforePageDelete(), ilSCORM2004Asset\exportHTMLPageObjects(), ilObjGlossary\exportXML(), ilGlossaryDefinition\exportXMLDefinition(), ilLMPageObject\exportXMLPageContent(), ilSCORM2004Page\exportXMLPageContent(), ilObjTest\exportXMLPageObjects(), ilObjQuestionPool\exportXMLPageObjects(), ilSCORM2004ScoGUI\getExportResources(), saveFileUsage(), and ilContObjectManifestBuilder\writeResources().

Here is the caller graph for this function:

◆ create()

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

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

    {
        $this->node = $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->list_node = $this->dom->create_element("FileList");
        $this->list_node = $this->node->append_child($this->list_node);
    }

References ilPageContent\createPageContentNode(), and IL_INSERT_AFTER.

Here is the call graph for this function:

◆ deleteFileItems()

ilPCFileList::deleteFileItems ( $a_ids )

Delete file items.

Definition at line 148 of file class.ilPCFileList.php.

    {
        $files = array();
        
        // File Item
        $childs = $this->list_node->child_nodes();
 
        for ($i = 0; $i < count($childs); $i++) {
            if ($childs[$i]->node_name() == "FileItem") {
                $id = $entry = "";
                $pc_id = $childs[$i]->get_attribute("PCID");
                $hier_id = $childs[$i]->get_attribute("HierId");
                
                if (in_array($hier_id . ":" . $pc_id, $a_ids)) {
                    $childs[$i]->unlink($childs[$i]);
                }
            }
        }
    }

References ilPageContent\$hier_id, and $i.

◆ getAllClasses()

ilPCFileList::getAllClasses ( )

Get all style classes.

Definition at line 198 of file class.ilPCFileList.php.

    {
        $classes = array();
        
        // File Item
        $childs = $this->list_node->child_nodes();
 
        for ($i = 0; $i < count($childs); $i++) {
            if ($childs[$i]->node_name() == "FileItem") {
                $classes[$childs[$i]->get_attribute("HierId") . ":" .
                    $childs[$i]->get_attribute("PCID")] = $childs[$i]->get_attribute("Class");
            }
        }
        
        return $classes;
    }

References $i.

◆ getFileList()

ilPCFileList::getFileList ( )

Get list of files.

Definition at line 115 of file class.ilPCFileList.php.

    {
        $files = array();
        
        // File Item
        $childs = $this->list_node->child_nodes();
        for ($i = 0; $i < count($childs); $i++) {
            if ($childs[$i]->node_name() == "FileItem") {
                $id = $entry = "";
                $pc_id = $childs[$i]->get_attribute("PCID");
                $hier_id = $childs[$i]->get_attribute("HierId");
                $class = $childs[$i]->get_attribute("Class");
                
                // Identifier
                $id_node = $childs[$i]->first_child();
                if ($id_node->node_name() == "Identifier") {
                    $entry = $id_node->get_attribute("Entry");
                    if (substr($entry, 0, 9) == "il__file_") {
                        $id = substr($entry, 9);
                    }
                }
                $files[] = array("entry" => $entry, "id" => $id,
                    "pc_id" => $pc_id, "hier_id" => $hier_id,
                    "class" => $class);
            }
        }
        
        return $files;
    }

References ilPageContent\$hier_id, and $i.

◆ getLanguage()

ilPCFileList::getLanguage ( )

Definition at line 101 of file class.ilPCFileList.php.

    {
        $chlds = $this->list_node->child_nodes();
        for ($i = 0; $i < count($chlds); $i++) {
            if ($chlds[$i]->node_name() == "Title") {
                return $chlds[$i]->get_attribute("Language");
            }
        }
        return "";
    }

References $i.

◆ getLangVars()

static ilPCFileList::getLangVars ( )

static

Get lang vars needed for editing.

Returns: array array of lang var keys

Reimplemented from ilPageContent.

Definition at line 237 of file class.ilPCFileList.php.

    {
        return array("ed_edit_files", "ed_insert_filelist", "pc_flist");
    }

◆ getListTitle()

ilPCFileList::getListTitle ( )

Definition at line 90 of file class.ilPCFileList.php.

    {
        $chlds = $this->list_node->child_nodes();
        for ($i = 0; $i < count($chlds); $i++) {
            if ($chlds[$i]->node_name() == "Title") {
                return $chlds[$i]->get_content();
            }
        }
        return "";
    }

References $i.

◆ init()

ilPCFileList::init ( )

Init page content component.

Reimplemented from ilPageContent.

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

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

References ilPageContent\setType().

Here is the call graph for this function:

◆ saveFileUsage()

static ilPCFileList::saveFileUsage	(	$a_page,
		$a_domdoc,
		$a_old_nr = `0`
	)

static

Save file usages.

Definition at line 320 of file class.ilPCFileList.php.

    {
        $file_ids = self::collectFileItems($a_page, $a_domdoc);
        include_once("./Modules/File/classes/class.ilObjFile.php");
        ilObjFile::_deleteAllUsages($a_page->getParentType() . ":pg", $a_page->getId(), $a_old_nr, $a_page->getLanguage());
        foreach ($file_ids as $file_id) {
            ilObjFile::_saveUsage(
                $file_id,
                $a_page->getParentType() . ":pg",
                $a_page->getId(),
                $a_old_nr,
                $a_page->getLanguage()
            );
        }
    }

References collectFileItems().

Referenced by afterPageHistoryEntry(), and afterPageUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePositions()

ilPCFileList::savePositions ( $a_pos )

Save positions of file items.

Definition at line 171 of file class.ilPCFileList.php.

    {
        asort($a_pos);
        
        // File Item
        $childs = $this->list_node->child_nodes();
        $nodes = array();
        for ($i = 0; $i < count($childs); $i++) {
            if ($childs[$i]->node_name() == "FileItem") {
                $id = $entry = "";
                $pc_id = $childs[$i]->get_attribute("PCID");
                $hier_id = $childs[$i]->get_attribute("HierId");
                $nodes[$hier_id . ":" . $pc_id] = $childs[$i];
                $childs[$i]->unlink($childs[$i]);
            }
        }
        
        foreach ($a_pos as $k => $v) {
            if (is_object($nodes[$k])) {
                $nodes[$k] = $this->list_node->append_child($nodes[$k]);
            }
        }
    }

References ilPageContent\$hier_id, and $i.

◆ saveStyleClasses()

ilPCFileList::saveStyleClasses ( $a_class )

Save style classes of file items.

Definition at line 218 of file class.ilPCFileList.php.

    {
        // File Item
        $childs = $this->list_node->child_nodes();
        for ($i = 0; $i < count($childs); $i++) {
            if ($childs[$i]->node_name() == "FileItem") {
                $childs[$i]->set_attribute(
                    "Class",
                    $a_class[$childs[$i]->get_attribute("HierId") . ":" .
                    $childs[$i]->get_attribute("PCID")]
                );
            }
        }
    }

References $i.

◆ setListTitle()

ilPCFileList::setListTitle	(	$a_title,
		$a_language
	)

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

    {
        ilDOMUtil::setFirstOptionalElement(
            $this->dom,
            $this->list_node,
            "Title",
            array("FileItem"),
            $a_title,
            array("Language" => $a_language)
        );
    }

References ilDOMUtil\setFirstOptionalElement().

Here is the call graph for this function:

◆ setNode()

ilPCFileList::setNode ( $a_node )

Set xml node of page content.

Parameters

object $a_node node object

Reimplemented from ilPageContent.

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

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

Field Documentation

◆ $list_node

ilPCFileList::$list_node

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

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

Services/COPage/classes/class.ilPCFileList.php

Public Member Functions

Static Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ afterPageHistoryEntry()

◆ afterPageUpdate()

◆ appendItem()

◆ beforePageDelete()

◆ collectFileItems()

◆ create()

◆ deleteFileItems()

◆ getAllClasses()

◆ getFileList()

◆ getLanguage()

◆ getLangVars()

◆ getListTitle()

◆ init()

◆ saveFileUsage()

◆ savePositions()

◆ saveStyleClasses()

◆ setListTitle()

◆ setNode()

Field Documentation

◆ $list_node