This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPCFileList:

Collaboration diagram for ilPCFileList:

Public Member Functions
	init ()
	Init object. More...

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

	appendItem (int $a_id, string $a_location, string $a_format)

	setListTitle (string $a_title, string $a_language)

	getListTitle ()

	getLanguage ()

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

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

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

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

	saveStyleClasses (array $a_class)
	Save style classes of file items. More...

	saveStyleClass (string $id, string $class)

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

Static Public Member Functions
static	getLangVars ()
	Get lang vars needed for editing. 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	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	saveFileUsage (ilPageObject $a_page, DOMDocument $a_domdoc, int $a_old_nr=0)
	Save file usages. More...

static	collectFileItems (ilPageObject $a_page, DOMDocument $a_domdoc)
	Get all file items 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	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...

Static Protected Member Functions
static	_deleteHistoryUsagesLowerEqualThan (string $parent_type, int $a_id, int $a_usage_hist_nr, string $a_lang="-")

Additional Inherited Members
Data Fields inherited from ilPageContent
string	$hier_id = ""

DOMNode	$dom_node = null

string	$page_lang = ""

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=[])

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 Class ilPCFileList File List content object (see ILIAS DTD)

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

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

Member Function Documentation

◆ _deleteHistoryUsagesLowerEqualThan()

static ilPCFileList::_deleteHistoryUsagesLowerEqualThan	(	string	$parent_type,
		int	$a_id,
		int	$a_usage_hist_nr,
		string	$a_lang = `"-"`
	)

staticprotected

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

     : array {
        global $DIC;
 
        $hist_repo = $DIC->copage()->internal()->repo()->history();
 
        $file_ids = [];
        foreach ($hist_repo->getHistoryNumbersOlderEqualThanNr(
            $a_usage_hist_nr,
            $parent_type,
            $a_id,
            $a_lang
        ) as $old_nr) {
            foreach (ilObjFile::_getFilesOfObject($parent_type . ":pg", $a_id, $old_nr, $a_lang) as $file_id) {
                $file_ids[$file_id] = $file_id;
            }
            ilObjFile::_deleteAllUsages($parent_type . ":pg", $a_id, $old_nr, $a_lang);
        }
        return $file_ids;
    }

◆ afterPageHistoryEntry()

static ilPCFileList::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 295 of file class.ilPCFileList.php.

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

◆ afterPageUpdate()

static ilPCFileList::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 238 of file class.ilPCFileList.php.

     : void {
        if (!$a_page->getImportMode()) {
            // pc filelist
            $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(), ilPageObject\getId(), ilPageObject\getLanguage(), and ilPageObject\getParentType().

Here is the call graph for this function:

◆ appendItem()

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

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

     : void {
        // File Item
        $new_item = $this->dom_doc->createElement("FileItem");
        $new_item = $this->getChildNode()->appendChild($new_item);
 
        // Identifier
        $id_node = $this->dom_doc->createElement("Identifier");
        $id_node = $new_item->appendChild($id_node);
        $id_node->setAttribute("Catalog", "ILIAS");
        $id_node->setAttribute("Entry", "il__file_" . $a_id);
 
        // Location
        $loc_node = $this->dom_doc->createElement("Location");
        $loc_node = $new_item->appendChild($loc_node);
        $loc_node->setAttribute("Type", "LocalFile");
        $this->dom_util->setContent($loc_node, $a_location);
 
        // Format
        $form_node = $this->dom_doc->createElement("Format");
        $form_node = $new_item->appendChild($form_node);
        $this->dom_util->setContent($form_node, $a_format);
    }

◆ beforePageDelete()

static ilPCFileList::beforePageDelete ( ilPageObject $a_page )

static

Before page is being deleted.

Reimplemented from ilPageContent.

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

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

◆ collectFileItems()

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

static

Get all file items that are used within the page.

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

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

Referenced by ilObjTest\addQTIMaterial(), ilObjQuestionPool\exportXMLPageObjects(), and ilObjTest\exportXMLPageObjects().

Here is the caller graph for this function:

◆ create()

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

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

     : void {
        $this->createInitialChildNode($a_hier_id, $a_pc_id, "FileList");
    }

◆ deleteFileItems()

ilPCFileList::deleteFileItems ( array $a_ids )

Delete file items.

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

                                                 : void
    {
        // File Item
        $childs = iterator_to_array($this->getChildNode()->childNodes);
        foreach ($childs as $c) {
            if ($c->nodeName === "FileItem") {
                $id = $entry = "";
                $pc_id = $c->getAttribute("PCID");
                $hier_id = $c->getAttribute("HierId");
 
                if (in_array($hier_id . ":" . $pc_id, $a_ids)) {
                    $c->parentNode->removeChild($c);
                }
            }
        }
    }

References $c, and $id.

◆ deleteHistoryLowerEqualThan()

static ilPCFileList::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 356 of file class.ilPCFileList.php.

     : void {
        $file_ids = self::_deleteHistoryUsagesLowerEqualThan(
            $parent_type,
            $page_id,
            $delete_lower_than_nr,
            $lang
        );
 
        foreach ($file_ids as $file_id) {
            if (ilObject::_lookupType($file_id) === "file") {
                $file = new ilObjFile($file_id, false);
                $usages = $file->getUsages();
                if (count($usages) == 0) {
                    $file->delete();
                }
            }
        }
    }

References ilObject\_lookupType().

Here is the call graph for this function:

◆ getAllClasses()

ilPCFileList::getAllClasses ( )

Get all style classes.

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

                                   : array
    {
        $classes = array();
 
        // File Item
        foreach ($this->getChildNode()->childNodes as $c) {
            if ($c->nodeName === "FileItem") {
                $classes[$c->getAttribute("HierId") . ":" .
                    $c->getAttribute("PCID")] = $c->getAttribute("Class");
            }
        }
 
        return $classes;
    }

References $c.

◆ getFileList()

ilPCFileList::getFileList ( )

Get list of files.

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

                                 : array
    {
        $files = array();
 
        // File Item
        foreach ($this->getChildNode()->childNodes as $c) {
            if ($c->nodeName === "FileItem") {
                $id = $entry = "";
                $pc_id = $c->getAttribute("PCID");
                $hier_id = $c->getAttribute("HierId");
                $class = $c->getAttribute("Class");
 
                // Identifier
                $id_node = $c->firstChild;
                if ($id_node->nodeName === "Identifier") {
                    $entry = $id_node->getAttribute("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 $c, and $id.

◆ getLanguage()

ilPCFileList::getLanguage ( )

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

                                 : string
    {
        foreach ($this->getChildNode()->childNodes as $c) {
            if ($c->nodeName === "Title") {
                return $c->getAttribute("Language");
            }
        }
        return "";
    }

References $c.

◆ getLangVars()

static ilPCFileList::getLangVars ( )

static

Get lang vars needed for editing.

Returns: array array of lang var keys

Reimplemented from ilPageContent.

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

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

◆ getListTitle()

ilPCFileList::getListTitle ( )

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

                                  : string
    {
        foreach ($this->getChildNode()->childNodes as $c) {
            if ($c->nodeName === "Title") {
                return $c->nodeValue;
            }
        }
        return "";
    }

References $c.

◆ init()

ilPCFileList::init ( )

Init object.

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

Reimplemented from ilPageContent.

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

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

References ilPageContent\setType().

Here is the call graph for this function:

◆ saveFileUsage()

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

static

Save file usages.

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

     : void {
        $file_ids = self::collectFileItems($a_page, $a_domdoc);
        ilObjFile::_deleteAllUsages($a_page->getParentType() . ":pg", $a_page->getId(), $a_old_nr, $a_page->getLanguage());
        foreach ($file_ids as $file_id) {
            ilObjFile::_saveUsage(
                (int) $file_id,
                $a_page->getParentType() . ":pg",
                $a_page->getId(),
                $a_old_nr,
                $a_page->getLanguage()
            );
        }
    }

◆ savePositions()

ilPCFileList::savePositions ( array $a_pos )

Save positions of file items.

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

                                               : void
    {
        //asort($a_pos);
 
        // File Item
        $nodes = array();
        foreach ($this->getChildNode()->childNodes as $c) {
            if ($c->nodeName === "FileItem") {
                $pc_id = $c->getAttribute("PCID");
                $hier_id = $c->getAttribute("HierId");
                $nodes[$hier_id . ":" . $pc_id] = $c;
            }
        }
        $this->dom_util->deleteAllChildsByName($this->getChildNode(), ["FileItem"]);
        foreach ($a_pos as $k) {
            if (is_object($nodes[$k])) {
                $nodes[$k] = $this->getChildNode()->appendChild($nodes[$k]);
            }
        }
    }

References $c.

◆ saveStyleClass()

ilPCFileList::saveStyleClass	(	string	$id,
		string	$class
	)

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

                                                             : void
    {
        // File Item
        foreach ($this->getChildNode()->childNodes as $c) {
            if ($c->nodeName == "FileItem") {
                if ($c->getAttribute("HierId") . ":" .
                    $c->getAttribute("PCID") === $id) {
                    $c->setAttribute(
                        "Class",
                        $class
                    );
                }
            }
        }
    }

References $c, and $id.

◆ saveStyleClasses()

ilPCFileList::saveStyleClasses ( array $a_class )

Save style classes of file items.

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

                                                    : void
    {
        // File Item
        foreach ($this->getChildNode()->childNodes as $c) {
            if ($c->nodeName == "FileItem") {
                $c->setAttribute(
                    "Class",
                    $a_class[$c->getAttribute("HierId") . ":" .
                    $c->getAttribute("PCID")]
                );
            }
        }
    }

References $c.

◆ setListTitle()

ilPCFileList::setListTitle	(	string	$a_title,
		string	$a_language
	)

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

     : void {
        $this->dom_util->setFirstOptionalElement(
            $this->getChildNode(),
            "Title",
            array("FileItem"),
            $a_title,
            array("Language" => $a_language)
        );
    }

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

components/ILIAS/COPage/PC/FileList/class.ilPCFileList.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _deleteHistoryUsagesLowerEqualThan()

◆ afterPageHistoryEntry()

◆ afterPageUpdate()

◆ appendItem()

◆ beforePageDelete()

◆ collectFileItems()

◆ create()

◆ deleteFileItems()

◆ deleteHistoryLowerEqualThan()

◆ getAllClasses()

◆ getFileList()

◆ getLanguage()

◆ getLangVars()

◆ getListTitle()

◆ init()

◆ saveFileUsage()

◆ savePositions()

◆ saveStyleClass()

◆ saveStyleClasses()

◆ setListTitle()