ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
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 ()
 
 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...
 
- 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...
 

Additional Inherited Members

- 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 inherited from ilPageContent
string $hier_id = ""
 
php4DOMElement $node = null
 
php4DOMDocument $dom = null
 
string $page_lang = ""
 
- 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 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.

References ilPageContent\getNode().

98  : void
99  {
100  $li = $this->getNode();
101  $li->unlink($li);
102  }
+ Here is the call graph for this function:

◆ init()

ilPCFileItem::init ( )

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

References ilPageContent\setType().

27  : void
28  {
29  $this->setType("flit");
30  }
setType(string $a_type)
Set Type.
+ Here is the call graph for this function:

◆ moveItemDown()

ilPCFileItem::moveItemDown ( )

move list item down

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

References ilPageContent\getNode().

107  : void
108  {
109  $li = $this->getNode();
110  $next = $li->next_sibling();
111  $next_copy = $next->clone_node(true);
112  $next_copy = $li->insert_before($next_copy, $li);
113  $next->unlink($next);
114  }
+ Here is the call graph for this function:

◆ moveItemUp()

ilPCFileItem::moveItemUp ( )

move list item up

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

References ilPageContent\getNode().

119  : void
120  {
121  $li = $this->getNode();
122  $prev = $li->previous_sibling();
123  $li_copy = $li->clone_node(true);
124  $li_copy = $prev->insert_before($li_copy, $prev);
125  $li->unlink($li);
126  }
+ Here is the call graph for this function:

◆ newItemAfter()

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

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

References ilPageContent\getNode().

36  : void {
37  $li = $this->getNode();
38  $new_item = $this->dom->create_element("FileItem");
39  if ($next_li = $li->next_sibling()) {
40  $new_item = $next_li->insert_before($new_item, $next_li);
41  } else {
42  $parent_list = $li->parent_node();
43  $new_item = $parent_list->append_child($new_item);
44  }
45 
46  // Identifier
47  $id_node = $this->dom->create_element("Identifier");
48  $id_node = $new_item->append_child($id_node);
49  $id_node->set_attribute("Catalog", "ILIAS");
50  $id_node->set_attribute("Entry", "il__file_" . $a_id);
51 
52  // Location
53  $loc_node = $this->dom->create_element("Location");
54  $loc_node = $new_item->append_child($loc_node);
55  $loc_node->set_attribute("Type", "LocalFile");
56  $loc_node->set_content($a_location);
57 
58  // Format
59  $form_node = $this->dom->create_element("Format");
60  $form_node = $new_item->append_child($form_node);
61  $form_node->set_content($a_format);
62  }
+ Here is the call graph for this function:

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

References ilPageContent\getNode().

72  : void {
73  $li = $this->getNode();
74  $new_item = $this->dom->create_element("FileItem");
75  $new_item = $li->insert_before($new_item, $li);
76 
77  // Identifier
78  $id_node = $this->dom->create_element("Identifier");
79  $id_node = $new_item->append_child($id_node);
80  $id_node->set_attribute("Catalog", "ILIAS");
81  $id_node->set_attribute("Entry", "il__file_" . $a_id);
82 
83  // Location
84  $loc_node = $this->dom->create_element("Location");
85  $loc_node = $new_item->append_child($loc_node);
86  $loc_node->set_attribute("Type", "LocalFile");
87  $loc_node->set_content($a_location);
88 
89  // Format
90  $form_node = $this->dom->create_element("Format");
91  $form_node = $new_item->append_child($form_node);
92  $form_node->set_content($a_format);
93  }
+ Here is the call graph for this function:

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