ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
class.ilPCFileList.php
Go to the documentation of this file.
1<?php
2
25{
26 public function init(): void
27 {
28 $this->setType("flst");
29 }
30
31 public function create(
32 ilPageObject $a_pg_obj,
33 string $a_hier_id,
34 string $a_pc_id = ""
35 ): void {
36 $this->createInitialChildNode($a_hier_id, $a_pc_id, "FileList");
37 }
38
39 public function appendItem(
40 int $a_id,
41 string $a_location,
42 string $a_format
43 ): void {
44 // File Item
45 $new_item = $this->dom_doc->createElement("FileItem");
46 $new_item = $this->getChildNode()->appendChild($new_item);
47
48 // Identifier
49 $id_node = $this->dom_doc->createElement("Identifier");
50 $id_node = $new_item->appendChild($id_node);
51 $id_node->setAttribute("Catalog", "ILIAS");
52 $id_node->setAttribute("Entry", "il__file_" . $a_id);
53
54 // Location
55 $loc_node = $this->dom_doc->createElement("Location");
56 $loc_node = $new_item->appendChild($loc_node);
57 $loc_node->setAttribute("Type", "LocalFile");
58 $this->dom_util->setContent($loc_node, $a_location);
59
60 // Format
61 $form_node = $this->dom_doc->createElement("Format");
62 $form_node = $new_item->appendChild($form_node);
63 $this->dom_util->setContent($form_node, $a_format);
64 }
65
66 public function setListTitle(
67 string $a_title,
68 string $a_language
69 ): void {
70 $this->dom_util->setFirstOptionalElement(
71 $this->getChildNode(),
72 "Title",
73 array("FileItem"),
74 $a_title,
75 array("Language" => $a_language)
76 );
77 }
78
79 public function getListTitle(): string
80 {
81 foreach ($this->getChildNode()->childNodes as $c) {
82 if ($c->nodeName === "Title") {
83 return $c->nodeValue;
84 }
85 }
86 return "";
87 }
88
89 public function getLanguage(): string
90 {
91 foreach ($this->getChildNode()->childNodes as $c) {
92 if ($c->nodeName === "Title") {
93 return $c->getAttribute("Language");
94 }
95 }
96 return "";
97 }
98
102 public function getFileList(): array
103 {
104 $files = array();
105
106 // File Item
107 foreach ($this->getChildNode()->childNodes as $c) {
108 if ($c->nodeName === "FileItem") {
109 $id = $entry = "";
110 $pc_id = $c->getAttribute("PCID");
111 $hier_id = $c->getAttribute("HierId");
112 $class = $c->getAttribute("Class");
113
114 // Identifier
115 $id_node = $c->firstChild;
116 if ($id_node->nodeName === "Identifier") {
117 $entry = $id_node->getAttribute("Entry");
118 if (substr($entry, 0, 9) == "il__file_") {
119 $id = substr($entry, 9);
120 }
121 }
122 $files[] = array("entry" => $entry, "id" => $id,
123 "pc_id" => $pc_id, "hier_id" => $hier_id,
124 "class" => $class);
125 }
126 }
127
128 return $files;
129 }
130
134 public function deleteFileItems(array $a_ids): void
135 {
136 // File Item
137 foreach ($this->getChildNode()->childNodes as $c) {
138 if ($c->nodeName === "FileItem") {
139 $id = $entry = "";
140 $pc_id = $c->getAttribute("PCID");
141 $hier_id = $c->getAttribute("HierId");
142
143 if (in_array($hier_id . ":" . $pc_id, $a_ids)) {
144 $c->parentNode->removeChild($c);
145 }
146 }
147 }
148 }
149
153 public function savePositions(array $a_pos): void
154 {
155 asort($a_pos);
156
157 // File Item
158 $nodes = array();
159 foreach ($this->getChildNode()->childNodes as $c) {
160 if ($c->nodeName === "FileItem") {
161 $pc_id = $c->getAttribute("PCID");
162 $hier_id = $c->getAttribute("HierId");
163 $nodes[$hier_id . ":" . $pc_id] = $c;
164 }
165 }
166 $this->dom_util->deleteAllChildsByName($this->getChildNode(), ["FileItem"]);
167 foreach ($a_pos as $k => $v) {
168 if (is_object($nodes[$k])) {
169 $nodes[$k] = $this->getChildNode()->appendChild($nodes[$k]);
170 }
171 }
172 }
173
177 public function getAllClasses(): array
178 {
179 $classes = array();
180
181 // File Item
182 foreach ($this->getChildNode()->childNodes as $c) {
183 if ($c->nodeName === "FileItem") {
184 $classes[$c->getAttribute("HierId") . ":" .
185 $c->getAttribute("PCID")] = $c->getAttribute("Class");
186 }
187 }
188
189 return $classes;
190 }
191
195 public function saveStyleClasses(array $a_class): void
196 {
197 // File Item
198 foreach ($this->getChildNode()->childNodes as $c) {
199 if ($c->nodeName == "FileItem") {
200 $c->setAttribute(
201 "Class",
202 $a_class[$c->getAttribute("HierId") . ":" .
203 $c->getAttribute("PCID")]
204 );
205 }
206 }
207 }
208
213 public static function getLangVars(): array
214 {
215 return array("ed_edit_files", "ed_insert_filelist", "pc_flist");
216 }
217
221 public static function afterPageUpdate(
222 ilPageObject $a_page,
223 DOMDocument $a_domdoc,
224 string $a_xml,
225 bool $a_creation
226 ): void {
227 if (!$a_page->getImportMode()) {
228 // pc filelist
229 $file_ids = ilObjFile::_getFilesOfObject(
230 $a_page->getParentType() . ":pg",
231 $a_page->getId(),
232 0,
233 $a_page->getLanguage()
234 );
235 self::saveFileUsage($a_page, $a_domdoc);
236
237 foreach ($file_ids as $file) { // check, whether file object can be deleted
238 if (ilObject::_exists($file) && ilObject::_lookupType($file) == "file") {
239 $file_obj = new ilObjFile($file, false);
240 $usages = $file_obj->getUsages();
241 if (count($usages) == 0) { // delete, if no usage exists
242 if ($file_obj->getMode() == "filelist") { // non-repository object
243 $file_obj->delete();
244 }
245 }
246 }
247 }
248 }
249 }
250
254 public static function beforePageDelete(
255 ilPageObject $a_page
256 ): void {
257 $files = self::collectFileItems($a_page, $a_page->getDomDoc());
258
259 // delete all file usages
260 ilObjFile::_deleteAllUsages(
261 $a_page->getParentType() . ":pg",
262 $a_page->getId(),
263 false,
264 $a_page->getLanguage()
265 );
266
267 foreach ($files as $file_id) {
268 if (ilObject::_exists($file_id)) {
269 $file_obj = new ilObjFile($file_id, false);
270 $file_obj->delete();
271 }
272 }
273 }
274
278 public static function afterPageHistoryEntry(
279 ilPageObject $a_page,
280 DOMDocument $a_old_domdoc,
281 string $a_old_xml,
282 int $a_old_nr
283 ): void {
284 self::saveFileUsage($a_page, $a_old_domdoc, $a_old_nr);
285 }
286
290 public static function saveFileUsage(
291 ilPageObject $a_page,
292 DOMDocument $a_domdoc,
293 int $a_old_nr = 0
294 ): void {
295 $file_ids = self::collectFileItems($a_page, $a_domdoc);
296 ilObjFile::_deleteAllUsages($a_page->getParentType() . ":pg", $a_page->getId(), $a_old_nr, $a_page->getLanguage());
297 foreach ($file_ids as $file_id) {
298 ilObjFile::_saveUsage(
299 (int) $file_id,
300 $a_page->getParentType() . ":pg",
301 $a_page->getId(),
302 $a_old_nr,
303 $a_page->getLanguage()
304 );
305 }
306 }
307
311 public static function collectFileItems(
312 ilPageObject $a_page,
313 DOMDocument $a_domdoc
314 ): array {
315 $xpath = new DOMXPath($a_domdoc);
316 $nodes = $xpath->query('//FileItem/Identifier');
317 $file_ids = array();
318 foreach ($nodes as $node) {
319 $id_arr = explode("_", $node->getAttribute("Entry"));
320 $file_id = $id_arr[count($id_arr) - 1];
321 if ($file_id > 0 && ($id_arr[1] == "" || $id_arr[1] == IL_INST_ID || $id_arr[1] == 0)) {
322 $file_ids[$file_id] = $file_id;
323 }
324 }
325 // file items in download links
326 $xpath = new DOMXPath($a_domdoc);
327 $nodes = $xpath->query("//IntLink[@Type='File']");
328 foreach ($nodes as $node) {
329 $t = $node->getAttribute("Target");
330 if (substr($t, 0, 9) == "il__dfile") {
331 $id_arr = explode("_", $t);
332 $file_id = $id_arr[count($id_arr) - 1];
333 $file_ids[$file_id] = $file_id;
334 }
335 }
336 return $file_ids;
337 }
338
339 public static function deleteHistoryLowerEqualThan(
340 string $parent_type,
341 int $page_id,
342 string $lang,
343 int $delete_lower_than_nr
344 ): void {
345 $file_ids = self::_deleteHistoryUsagesLowerEqualThan(
346 $parent_type,
347 $page_id,
348 $delete_lower_than_nr,
349 $lang
350 );
351
352 foreach ($file_ids as $file_id) {
353 if (ilObject::_lookupType($file_id) === "file") {
354 $file = new ilObjFile($file_id, false);
355 $usages = $file->getUsages();
356 if (count($usages) == 0) {
357 $file->delete();
358 }
359 }
360 }
361 }
362
363 protected static function _deleteHistoryUsagesLowerEqualThan(
364 string $parent_type,
365 int $a_id,
366 int $a_usage_hist_nr,
367 string $a_lang = "-"
368 ): array {
369 global $DIC;
370
371 $hist_repo = $DIC->copage()->internal()->repo()->history();
372
373 $file_ids = [];
374 foreach ($hist_repo->getHistoryNumbersOlderEqualThanNr(
375 $a_usage_hist_nr,
376 $parent_type,
377 $a_id,
378 $a_lang
379 ) as $old_nr) {
380 foreach (ilObjFile::_getFilesOfObject($parent_type . ":pg", $a_id, $old_nr, $a_lang) as $file_id) {
381 $file_ids[$file_id] = $file_id;
382 }
383 ilObjFile::_deleteAllUsages($parent_type . ":pg", $a_id, $old_nr, $a_lang);
384 }
385 return $file_ids;
386 }
387}
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
Class ilObjFile.
static _lookupType(int $id, bool $reference=false)
static _exists(int $id, bool $reference=false, ?string $type=null)
checks if an object exists in object_data
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
static beforePageDelete(ilPageObject $a_page)
Before page is being deleted.
static getLangVars()
Get lang vars needed for editing.
static afterPageUpdate(ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
After page has been updated (or created)
static collectFileItems(ilPageObject $a_page, DOMDocument $a_domdoc)
Get all file items that are used within the page.
getAllClasses()
Get all style classes.
static saveFileUsage(ilPageObject $a_page, DOMDocument $a_domdoc, int $a_old_nr=0)
Save file usages.
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.
static _deleteHistoryUsagesLowerEqualThan(string $parent_type, int $a_id, int $a_usage_hist_nr, string $a_lang="-")
saveStyleClasses(array $a_class)
Save style classes of file items.
setListTitle(string $a_title, string $a_language)
savePositions(array $a_pos)
Save positions of file items.
create(ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")
static afterPageHistoryEntry(ilPageObject $a_page, DOMDocument $a_old_domdoc, string $a_old_xml, int $a_old_nr)
After page history entry has been created.
deleteFileItems(array $a_ids)
Delete file items.
init()
Init object.
appendItem(int $a_id, string $a_location, string $a_format)
getFileList()
Get list of files.
Content object of ilPageObject (see ILIAS DTD).
createInitialChildNode(string $hier_id, string $pc_id, string $child, array $child_attributes=[])
setType(string $a_type)
Set Type.
Class ilPageObject Handles PageObjects of ILIAS Learning Modules (see ILIAS DTD)
const IL_INST_ID
Definition: constants.php:40
$c
Definition: deliver.php:25
if(!file_exists('../ilias.ini.php'))
global $DIC
Definition: shib_login.php:26
$lang
Definition: xapiexit.php:25