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

Collaboration diagram for ilPCFileItem:

Public Member Functions
	init ()
	Init object. More...
	newItemAfter (int $a_id, string $a_location, string $a_format)
	newItemBefore (int $a_id, string $a_location, string $a_format)
	insert new list item before current one More...
	deleteItem ()
	Delete file item. More...
	moveItemDown ()
	move list item down More...
	moveItemUp ()
	move list item up More...
	getListPCId ()
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...

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

File Item content object (see ILIAS DTD)

Author

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

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

Member Function Documentation

deleteItem()

ilPCFileItem::deleteItem

(

)

Delete file item.

Definition at line 98 of file class.ilPCFileItem.php.

                                : void
    {
        $li = $this->getDomNode();
        $li->parentNode->removeChild($li);
    }

getListPCId()

ilPCFileItem::getListPCId

(

)

Definition at line 128 of file class.ilPCFileItem.php.

                                 : string
    {
        $list = $this->getDomNode()->parentNode->parentNode;
        return $list->getAttribute("PCID");
    }

init()

ilPCFileItem::init

(

)

Init object.

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

Reimplemented from ilPageContent.

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

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

References ilPageContent\setType().

Here is the call graph for this function:

moveItemDown()

ilPCFileItem::moveItemDown

(

)

move list item down

Definition at line 107 of file class.ilPCFileItem.php.

                                  : void
    {
        $li = $this->getDomNode();
        $next = $li->nextSibling;
        $next_copy = $next->cloneNode(true);
        $next_copy = $li->parentNode->insertBefore($next_copy, $li);
        $next->parentNode->removeChild($next);
    }

moveItemUp()

ilPCFileItem::moveItemUp

(

)

move list item up

Definition at line 119 of file class.ilPCFileItem.php.

                                : void
    {
        $li = $this->getDomNode();
        $prev = $li->previousSibling;
        $li_copy = $li->cloneNode(true);
        $li_copy = $prev->parentNode->insertBefore($li_copy, $prev);
        $li->parentNode->removeChild($li);
    }

newItemAfter()

ilPCFileItem::newItemAfter	(	int	$a_id,
		string	$a_location,
		string	$a_format
	)

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

     : void {
        $li = $this->getDomNode();
        $new_item = $this->dom_doc->createElement("FileItem");
        if ($next_li = $li->nextSibling) {
            $new_item = $next_li->parentNode->insertBefore($new_item, $next_li);
        } else {
            $parent_list = $li->parentNode;
            $new_item = $parent_list->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);
    }

newItemBefore()

ilPCFileItem::newItemBefore	(	int	$a_id,
		string	$a_location,
		string	$a_format
	)

insert new list item before current one

Definition at line 68 of file class.ilPCFileItem.php.

     : void {
        $li = $this->getDomNode();
        $new_item = $this->dom_doc->createElement("FileItem");
        $new_item = $li->parentNode->insertBefore($new_item, $li);
 
        // 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);
    }

---

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

• components/ILIAS/COPage/PC/FileList/class.ilPCFileItem.php