ILIAS  trunk Revision v11.0_alpha-1689-g66c127b4ae8
•All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
class.ilDataCollectionDataSet.php
Go to the documentation of this file.
1 <?php
2 
19 declare(strict_types=1);
20 
21 class ilDataCollectionDataSet extends ilDataSet
22 {
27  protected array $record_field_ids_2_storage = [];
44  protected array $caches
45  = [
46  'dcl' => [],
47  'il_dcl_table' => [],
48  'il_dcl_field' => [],
49  'il_dcl_field_prop' => [],
50  'il_dcl_sel_opts' => [],
51  'il_dcl_record' => [],
52  'il_dcl_record_field' => [],
53  'il_dcl_stloc1_value' => [],
54  'il_dcl_stloc2_value' => [],
55  'il_dcl_stloc3_value' => [],
56  'il_dcl_stloc1_default' => [],
57  'il_dcl_stloc2_default' => [],
58  'il_dcl_stloc3_default' => [],
59  'il_dcl_tfield_set' => [],
60  'il_dcl_tableview' => [],
61  'il_dcl_tview_set' => [],
62  ];
63 
64  protected ilObjDataCollection $import_dc_object;
65 
69  protected array $import_record_field_cache = [];
70  protected ilObjUser $user;
71  protected \ILIAS\Refinery\Factory $refinery;
72  protected array $import_temp_refs = [];
73  protected array $import_temp_refs_props = [];
74  protected array $import_temp_new_mob_ids = [];
75 
76  public function __construct()
77  {
78  global $DIC;
79  parent::__construct();
80  $this->db = $DIC->database();
81  $this->user = $DIC->user();
82  $this->refinery = $DIC->refinery();
83  }
84 
85  public function getSupportedVersions(): array
86  {
87  return ['4.5.0', '8.13'];
88  }
89 
94  public function getCache(string $a_entity): array
95  {
96  if (!in_array($a_entity, array_keys($this->caches))) {
97  throw new ilException("Entity '$a_entity' does not exist in Cache");
98  }
99 
100  return $this->caches[$a_entity];
101  }
102 
103  protected function getXmlNamespace(string $a_entity, string $a_schema_version): string
104  {
105  return 'https://www.ilias.de/xml/Modules/DataCollection/' . $a_entity;
106  }
107 
108  public function importRecord(
109  string $a_entity,
110  array $a_types,
111  array $a_rec,
112  ilImportMapping $a_mapping,
113  string $a_schema_version
114  ): void {
115  foreach ($a_rec as $key => &$value) {
116  $array = json_decode($value, true);
117  if (is_array($array)) {
118  $value = json_encode($this->escapeArray($array));
119  } else {
120  $value = $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform($value);
121  }
122  }
123  switch ($a_entity) {
124  case 'dcl':
125  if ($new_id = $a_mapping->getMapping('components/ILIAS/Container', 'objs', $a_rec['id'])) {
126  $new_obj = ilObjectFactory::getInstanceByObjId((int) $new_id, false);
127  } else {
128  $new_obj = new ilObjDataCollection();
129  $new_obj->create(true);
130  }
131  $new_obj->setTitle($a_rec['title']);
132  $new_obj->setDescription($a_rec['description']);
133  $new_obj->setApproval((bool) $a_rec['approval']);
134  $new_obj->setPublicNotes((bool) $a_rec['public_notes']);
135  $new_obj->setNotification((bool) $a_rec['notification']);
136  $new_obj->setPublicNotes((bool) $a_rec['public_notes']);
137  $new_obj->setOnline(false);
138  $new_obj->setRating((bool) $a_rec['rating']);
139  $new_obj->update(); //clone mode, so no table will be created
140  $this->import_dc_object = $new_obj;
141  $a_mapping->addMapping('components/ILIAS/DataCollection', 'dcl', $a_rec['id'], (string) $new_obj->getId());
142  $a_mapping->addMapping(
143  'components/ILIAS/MetaData',
144  'md',
145  $a_rec['id'] . ':0:dcl',
146  $new_obj->getId() . ':0:dcl'
147  );
148  break;
149  case 'il_dcl_table':
150  $table = new ilDclTable();
151  $table->setTitle($a_rec['title']);
152  $table->setObjId($this->import_dc_object->getId());
153  $table->setDescription($a_rec['description']);
154  $table->setAddPerm((bool) $a_rec['add_perm']);
155  $table->setEditPerm((bool) $a_rec['edit_perm']);
156  $table->setDeletePerm((bool) $a_rec['delete_perm']);
157  $table->setEditByOwner((bool) $a_rec['edit_by_owner']);
158  $table->setLimited((bool) $a_rec['limited']);
159  $table->setLimitStart($a_rec['limit_start']);
160  $table->setLimitEnd($a_rec['limit_end']);
161  $table->setIsVisible((bool) $a_rec['is_visible']);
162  $table->setExportEnabled((bool) $a_rec['export_enabled']);
163  $table->setImportEnabled((bool) $a_rec['import_enabled']);
164  $table->setDefaultSortField($a_rec['default_sort_field_id']);
165  $table->setDefaultSortFieldOrder($a_rec['default_sort_field_order']);
166  $table->setPublicCommentsEnabled((bool) $a_rec['public_comments']);
167  $table->setViewOwnRecordsPerm((bool) $a_rec['view_own_records_perm']);
168  $table->setDeleteByOwner((bool) $a_rec['delete_by_owner']);
169  $table->setSaveConfirmation((bool) $a_rec['save_confirmation']);
170  $table->setOrder((int) $a_rec['table_order']);
171  $table->doCreate(false, false); // false => Do not create views! They are imported later
172  $a_mapping->addMapping('components/ILIAS/DataCollection', 'il_dcl_table', $a_rec['id'], (string) $table->getId());
173  break;
174  case 'il_dcl_tableview':
175  $new_table_id = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_table', $a_rec['table_id']);
176  if ($new_table_id) {
177  $tableview = new ilDclTableView();
178  $tableview->setTitle($a_rec['title']);
179  $tableview->setTableId((int) $new_table_id);
180  $tableview->setDescription($a_rec['description']);
181  $tableview->setTableviewOrder((int) $a_rec['tableview_order']);
182  if (!is_array($a_rec['roles'])) {
183  $a_rec['roles'] = json_decode($a_rec['roles']);
184  }
185  $tableview->setRoles($a_rec['roles']);
186  $tableview->create(false); //do not create default setting as they are imported too
187 
188  $a_mapping->addMapping(
189  'components/ILIAS/DataCollection',
190  'il_dcl_tableview',
191  $a_rec['id'],
192  (string) $tableview->getId()
193  );
194  $a_mapping->addMapping('components/ILIAS/COPage', 'pg', 'dclf:' . $a_rec['id'], 'dclf:' . $tableview->getId());
195  }
196  break;
197  case 'il_dcl_field':
198  $new_table_id = (int) $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_table', $a_rec['table_id']);
199  if ($new_table_id > 0) {
200  $datatype_id = (int) $a_rec['datatype_id'];
201  $datatype = $a_rec['datatype_title'] ?? null;
202  $datatypes = ilDclDatatype::getAllDatatype();
203  if ($datatype !== null && ilDclFieldTypePlugin::isPluginDatatype($datatype)) {
204  $datatype_id = null;
205  foreach ($datatypes as $dt) {
206  if ($dt->getTitle() === $datatype) {
207  $datatype_id = $dt->getId();
208  }
209  }
210  }
211  if (in_array($datatype_id, array_keys($datatypes))) {
212  $field = new ilDclBaseFieldModel();
213  $field->setTableId($new_table_id);
214  $field->setDatatypeId($datatype_id);
215  $field->setTitle($a_rec['title']);
216  $field->setDescription($a_rec['description']);
217  $field->setUnique((bool) $a_rec['is_unique']);
218  $field->doCreate();
219  $a_mapping->addMapping('components/ILIAS/DataCollection', 'il_dcl_field', $a_rec['id'], $field->getId());
220  // Check if this field was used as default order by, if so, update to new id
221  $table = ilDclCache::getTableCache($new_table_id);
222  if ($table->getDefaultSortField() === (int) $a_rec['id']) {
223  $table->setDefaultSortField($field->getId());
224  $table->doUpdate();
225  }
226  }
227  }
228  break;
229  case 'il_dcl_tfield_set':
230  $new_table_id = (int) $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_table', $a_rec['table_id']);
231  $new_field_id = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_field', $a_rec['field']);
232  if ($new_table_id > 0 && $new_field_id > 0) {
233  $setting = ilDclTableFieldSetting::getInstance(
234  $new_table_id,
235  $new_field_id
236  );
237  $setting->setFieldOrder((int) $a_rec['field_order']);
238  $setting->setExportable((bool) $a_rec['exportable']);
239  $setting->store();
240  }
241  break;
242  case 'il_dcl_tview_set':
243  $new_tableview_id = $a_mapping->getMapping(
244  'components/ILIAS/DataCollection',
245  'il_dcl_tableview',
246  $a_rec['tableview_id']
247  );
248  $new_field_id = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_field', $a_rec['field']);
249  if ($new_tableview_id) {
250  $setting = new ilDclTableViewFieldSetting();
251  $setting->setTableviewId((int) $new_tableview_id);
252  $setting->setVisible((bool) $a_rec['visible']);
253  $setting->setField($new_field_id ?: $a_rec['field']);
254  $setting->setInFilter((bool) $a_rec['in_filter']);
255  $setting->setFilterValue($a_rec['filter_value'] ?: null);
256  $setting->setFilterChangeable((bool) $a_rec['filter_changeable']);
257  $setting->setRequiredCreate((bool) ($a_rec['required_create'] ?? false));
258  $setting->setLockedCreate((bool) ($a_rec['locked_create'] ?? false));
259  $setting->setVisibleCreate((bool) ($a_rec['visible_create'] ?? true));
260  $setting->setVisibleEdit((bool) ($a_rec['visible_edit'] ?? true));
261  $setting->setRequiredEdit((bool) ($a_rec['required_edit'] ?? false));
262  $setting->setLockedEdit((bool) ($a_rec['locked_edit'] ?? false));
263  $setting->setDefaultValue($a_rec['default_value'] ?? null);
264  $setting->create();
265  $a_mapping->addMapping(
266  'components/ILIAS/DataCollection',
267  'il_dcl_tview_set',
268  $a_rec['id'],
269  (string) $setting->getId()
270  );
271  }
272  break;
273  case 'il_dcl_record':
274  $new_table_id = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_table', $a_rec['table_id']);
275  if ($new_table_id) {
276  $record = new ilDclBaseRecordModel();
277  $record->setTableId((int) $new_table_id);
278  $datetime = new ilDateTime(time(), IL_CAL_UNIX);
279  $record->setCreateDate($datetime);
280  $record->setLastUpdate($datetime);
281  $record->setOwner($this->user->getId());
282  $record->setLastEditBy($this->user->getId());
283  $record->doCreate();
284  $a_mapping->addMapping(
285  'components/ILIAS/DataCollection',
286  'il_dcl_record',
287  $a_rec['id'],
288  (string) $record->getId()
289  );
290  }
291  break;
292  case 'il_dcl_view':
293  $new_table_id = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_table', $a_rec['table_id']);
294  if ($new_table_id) {
295  //if import contains il_dcl_view, it must origin from an earlier ILIAS Version and therefore contains no tableviews
296  //->create standard view
297  $tableview = ilDclTableView::createOrGetStandardView((int) $new_table_id);
298  if ($a_rec['type'] == 0 && $a_rec['formtype'] == 0) { //set page_object to tableview
299  // This mapping is needed for the import handled by Services/COPage
300  $a_mapping->addMapping(
301  'components/ILIAS/COPage',
302  'pg',
303  'dclf:' . $a_rec['id'],
304  'dclf:' . $tableview->getId()
305  );
306  $a_mapping->addMapping(
307  'components/ILIAS/DataCollection',
308  'il_dcl_view',
309  $a_rec['id'],
310  (string) $tableview->getId()
311  );
312  } else {
313  $a_mapping->addMapping(
314  'components/ILIAS/DataCollection',
315  'il_dcl_view',
316  $a_rec['id'],
317  json_encode(['type' => $a_rec['type'],
318  'table_id' => $new_table_id,
319  'tableview_id' => $tableview->getId()
320  ])
321  );
322  }
323  }
324  break;
325  case 'il_dcl_viewdefinition':
326  $map = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_view', $a_rec['view_id']);
327  $new_field_id = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_field', $a_rec['field']);
328  $field = ($new_field_id) ?: $a_rec['field'];
329  switch ($map['type']) {
330  case 1: //visible
331  $viewfield_setting = ilDclTableViewFieldSetting::getInstance($map['tableview_id'], $field);
332  $viewfield_setting->setVisible($a_rec['is_set']);
333  $viewfield_setting->store();
334  break;
335  case 3: //in_filter
336  $viewfield_setting = ilDclTableViewFieldSetting::getInstance($map['tableview_id'], $field);
337  $viewfield_setting->setInFilter($a_rec['is_set']);
338  $viewfield_setting->store();
339  break;
340  case 4: //exportable
341  $tablefield_setting = ilDclTableFieldSetting::getInstance($map['table_id'], $field);
342  $tablefield_setting->setExportable($a_rec['is_set']);
343  $tablefield_setting->setFieldOrder($a_rec['field_order']);
344  $tablefield_setting->store();
345  break;
346  }
347  break;
348  case 'il_dcl_sel_opts':
349  $new_field_id = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_field', $a_rec['field_id']);
350  if ($new_field_id) {
351  $opt = new ilDclSelectionOption();
352  $opt->setFieldId((int) $new_field_id);
353  $opt->setOptId((int) $a_rec['opt_id']);
354  $opt->setSorting((int) $a_rec['sorting']);
355  $opt->setValue($a_rec['value']);
356  $opt->store();
357  }
358  break;
359  case 'il_dcl_field_prop':
360  $new_field_id = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_field', $a_rec['field_id']);
361  if ($new_field_id) {
362  $prop = new ilDclFieldProperty();
363  $prop->setFieldId((int) $new_field_id);
364 
365  // OLD IMPORT! Backwards-compatibility
366  $name = $a_rec['name'];
367  if (!isset($name) && isset($a_rec['datatype_prop_id'])) {
368  $properties = [
369  1 => 'length',
370  2 => 'regex',
371  3 => 'table_id',
372  4 => 'url',
373  5 => 'text_area',
374  6 => 'reference_link',
375  7 => 'width',
376  8 => 'height',
377  9 => 'learning_progress',
378  10 => 'ILIAS_reference_link',
379  11 => 'multiple_selection',
380  12 => 'expression',
381  13 => 'display_action_menu',
382  14 => 'link_detail_page',
383  15 => 'link_detail_page',
384  ];
385 
386  $name = $properties[$a_rec['datatype_prop_id']];
387  }
388 
389  $prop->setName($name);
390  $prop->setValue($a_rec['value']);
391  $prop->save();
392  $a_mapping->addMapping(
393  'components/ILIAS/DataCollection',
394  'il_dcl_field_prop',
395  $a_rec['id'],
396  (string) $prop->getId()
397  );
398  $this->import_temp_refs_props[$prop->getId()] = $a_rec['value'];
399  }
400  break;
401  case 'il_dcl_record_field':
402  $record_id = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_record', $a_rec['record_id']);
403  $field_id = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_field', $a_rec['field_id']);
404  if ($record_id && $field_id) {
405  $record = ilDclCache::getRecordCache((int) $record_id);
406  $field = ilDclCache::getFieldCache((int) $field_id);
407  $record_field = new ilDclBaseRecordFieldModel($record, $field);
408  $a_mapping->addMapping(
409  'components/ILIAS/DataCollection',
410  'il_dcl_record_field',
411  $a_rec['id'],
412  (string) $record_field->getId()
413  );
414  $this->import_record_field_cache[$record_field->getId()] = $record_field;
415  }
416  break;
417  case 'il_dcl_stloc1_value':
418  case 'il_dcl_stloc2_value':
419  case 'il_dcl_stloc3_value':
420  $new_record_field_id = $a_mapping->getMapping(
421  'components/ILIAS/DataCollection',
422  'il_dcl_record_field',
423  $a_rec['record_field_id']
424  );
425  if ($new_record_field_id) {
427  $record_field = $this->import_record_field_cache[$new_record_field_id];
428  if (is_object($record_field)) {
429  // Need to rewrite internal references and lookup new objects if MOB or File
430  // For some fieldtypes it's better to reset the value, e.g. ILIAS_REF
431  switch ($record_field->getField()->getDatatypeId()) {
432  case ilDclDatatype::INPUTFORMAT_MOB:
433  // Check if we got a mapping from old object
434  $new_mob_id = $a_mapping->getMapping('components/ILIAS/MediaObjects', 'mob', $a_rec['value']);
435  $value = ($new_mob_id) ? (int) $new_mob_id : null;
436  $this->import_temp_new_mob_ids[] = $new_mob_id;
437  break;
438  case ilDclDatatype::INPUTFORMAT_FILEUPLOAD:
439  $new_file_id = $a_mapping->getMapping('components/ILIAS/File', 'file', $a_rec['value']);
440  $value = ($new_file_id) ? (int) $new_file_id : null;
441  break;
442  case ilDclDatatype::INPUTFORMAT_REFERENCE:
443  case ilDclDatatype::INPUTFORMAT_REFERENCELIST:
444  $value = $a_rec['value'];
445  $decode = json_decode($a_rec['value']);
446  if (is_array($decode)) {
447  foreach ($decode as $id) {
448  $this->import_temp_refs[$new_record_field_id][] = $id;
449  }
450  } else {
451  $this->import_temp_refs[$new_record_field_id] = $value;
452  }
453  break;
454  case ilDclDatatype::INPUTFORMAT_ILIAS_REF:
455  $value = null;
456  break;
457  case ilDclDatatype::INPUTFORMAT_DATETIME:
458  $value = $a_rec['value'];
459  if ($value == '0000-00-00 00:00:00') {
460  $value = null;
461  }
462  break;
463  case ilDclDatatype::INPUTFORMAT_TEXT:
464  if (version_compare($a_schema_version, "8.13") < 0) {
465  $a_rec['value'] = str_replace('&lt;br /&gt;', '', $a_rec['value']);
466  }
467  // no break
468  default:
469  $value = $a_rec['value'];
470  if ($a_entity == 'il_dcl_stloc3_value' && empty($value)) {
471  $value = null;
472  }
473  }
474  $record_field->setValue($value, true);
475  $record_field->doUpdate();
476  }
477  }
478  break;
479  case 'il_dcl_stloc1_default':
480  case 'il_dcl_stloc2_default':
481  case 'il_dcl_stloc3_default':
482 
483  $tview_set_id = $a_mapping->getMapping(
484  'components/ILIAS/DataCollection',
485  'il_dcl_tview_set',
486  $a_rec['tview_set_id']
487  );
488 
489  if ($tview_set_id) {
490  $value = $a_rec['value'];
491  if ($value) {
492  $stloc_default = (new ilDclDefaultValueFactory())->createByTableName($a_entity);
493  if ($a_entity == ilDclTableViewNumberDefaultValue::returnDbTableName()) {
494  $value = (int) $value;
495  }
496  $stloc_default->setValue($value);
497  $stloc_default->setTviewSetId((int) $tview_set_id);
498  $stloc_default->create();
499  }
500  }
501  break;
502  }
503  }
504 
505  protected function escapeArray(array $array): array
506  {
507  $new = [];
508  foreach ($array as $key => $value) {
509  $newkey = $key;
510  if (is_string($key)) {
511  $newkey = $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform($key);
512  }
513  $newvalue = $value;
514  if (is_string($value)) {
515  $newvalue = $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform($value);
516  }
517  if (is_array($value)) {
518  $newvalue = $this->escapeArray($value);
519  }
520  $new[$newkey] = $newvalue;
521  }
522  return $new;
523  }
524 
529  public function beforeFinishImport(ilImportMapping $a_mapping): void
530  {
531  foreach ($this->import_temp_new_mob_ids as $new_mob_id) {
532  if ($new_mob_id) {
533  ilObjMediaObject::_saveUsage((int) $new_mob_id, "dcl:html", $a_mapping->getTargetId());
534  }
535  }
536  foreach ($this->import_temp_refs as $record_field_id => $old_record_id) {
537  if (is_array($old_record_id)) {
538  $new_record_id = [];
539  foreach ($old_record_id as $id) {
540  $new_record_id[] = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_record', $id);
541  }
542  $value = $new_record_id;
543  } else {
544  $value = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_record', $old_record_id);
545  }
547  $record_field = $this->import_record_field_cache[$record_field_id];
548  $record_field->setValue($value, true);
549  $record_field->doUpdate();
550  }
551  foreach ($this->import_temp_refs_props as $field_prop_id => $prop_value) {
552  $new_field_id = $a_mapping->getMapping('components/ILIAS/DataCollection', 'il_dcl_field', $prop_value);
553  $value = ($new_field_id) ? (int) $new_field_id : $prop_value;
554 
555  $field_prop = new ilDclFieldProperty($field_prop_id);
556  $field_prop->setValue($value);
557  $field_prop->update();
558  }
559  }
560 
564  protected function getTypes(string $a_entity, string $a_version): array
565  {
566  switch ($a_entity) {
567  case 'dcl':
568  return [
569  "id" => "integer",
570  "title" => "text",
571  "description" => "text",
572  'is_online' => 'integer',
573  'rating' => 'integer',
574  'public_notes' => 'integer',
575  'approval' => 'integer',
576  'notification' => 'integer',
577  ];
578  case 'il_dcl_table':
579  return [
580  'id' => 'integer',
581  'obj_id' => 'integer',
582  'title' => 'text',
583  'add_perm' => 'integer',
584  'edit_perm' => 'integer',
585  'delete_perm' => 'integer',
586  'edit_by_owner' => 'integer',
587  'limited' => 'integer',
588  'limit_start' => 'text',
589  'limit_end' => 'text',
590  'is_visible' => 'integer',
591  'export_enabled' => 'integer',
592  'import_enabled' => 'integer',
593  'default_sort_field_id' => 'text',
594  'default_sort_field_order' => 'text',
595  'description' => 'text',
596  'public_comments' => 'integer',
597  'view_own_records_perm' => 'integer',
598  'delete_by_owner' => 'integer',
599  'save_confirmation' => 'integer',
600  'table_order' => 'integer',
601  ];
602  case 'il_dcl_tableview':
603  return [
604  'id' => 'integer',
605  'table_id' => 'integer',
606  'title' => 'text',
607  'roles' => 'text',
608  'description' => 'text',
609  'tableview_order' => 'integer',
610  ];
611  case 'il_dcl_field':
612  return [
613  'id' => 'integer',
614  'table_id' => 'integer',
615  'title' => 'text',
616  'description' => 'text',
617  'datatype_id' => 'integer',
618  'datatype_title' => 'text',
619  'is_unique' => 'integer',
620  ];
621  case 'il_dcl_tview_set':
622  return [
623  'id' => 'integer',
624  'tableview_id' => 'integer',
625  'field' => 'text',
626  'visible' => 'integer',
627  'in_filter' => 'integer',
628  'filter_value' => 'text',
629  'filter_changeable' => 'integer',
630  'required_create' => 'integer',
631  'required_edit' => 'integer',
632  'locked_create' => 'integer',
633  'locked_edit' => 'integer',
634  'visible_create' => 'integer',
635  'visible_edit' => 'integer',
636  'default_value' => 'text',
637  ];
638  case 'il_dcl_tfield_set':
639  return [
640  'id' => 'integer',
641  'table_id' => 'integer',
642  'field' => 'text',
643  'field_order' => 'integer',
644  'exportable' => 'integer',
645  ];
646  case 'il_dcl_field_prop':
647  return [
648  'id' => 'integer',
649  'field_id' => 'integer',
650  'name' => 'text',
651  'value' => 'integer',
652  ];
653  case 'il_dcl_sel_opts':
654  return [
655  'id' => 'integer',
656  'field_id' => 'integer',
657  'opt_id' => 'integer',
658  'sorting' => 'integer',
659  'value' => 'text',
660  ];
661  case 'il_dcl_record':
662  return [
663  'id' => 'integer',
664  'table_id' => 'integer',
665  ];
666  case 'il_dcl_record_field':
667  return [
668  'id' => 'integer',
669  'record_id' => 'integer',
670  'field_id' => 'integer',
671  ];
672  case 'il_dcl_stloc1_value':
673  case 'il_dcl_stloc2_value':
674  case 'il_dcl_stloc3_value':
675  return [
676  'id' => 'integer',
677  'record_field_id' => 'integer',
678  'value' => 'text',
679  ];
680  case 'il_dcl_stloc1_default':
681  case 'il_dcl_stloc2_default':
682  case 'il_dcl_stloc3_default':
683  return [
684  'id' => 'integer',
685  'tview_set_id' => 'integer',
686  'value' => 'text',
687  ];
688  default:
689  return [];
690  }
691  }
692 
701  protected function getDependencies(
702  string $a_entity,
703  string $a_version,
704  ?array $a_rec = null,
705  ?array $a_ids = null
706  ): array {
707  if (!$a_rec && !$a_ids) {
708  return [];
709  }
710  switch ($a_entity) {
711  case 'dcl':
712  $set = $this->db->query('SELECT * FROM il_dcl_table WHERE obj_id = ' . $this->db->quote(
713  $a_rec['id'],
714  'integer'
715  ) . ' ORDER BY id');
716  $ids = $this->buildCache('il_dcl_table', $set);
717 
718  return [
719  'il_dcl_table' => ['ids' => $ids],
720  ];
721  case 'il_dcl_table':
722  $set = $this->db->query('SELECT * FROM il_dcl_record WHERE table_id = ' . $this->db->quote(
723  $a_rec['id'],
724  'integer'
725  ));
726  $ids_records = $this->buildCache('il_dcl_record', $set);
727  $set = $this->db->query('SELECT il_dcl_field.*, il_dcl_datatype.title as datatype_title FROM il_dcl_field INNER JOIN il_dcl_datatype ON il_dcl_field.datatype_id = il_dcl_datatype.id WHERE table_id = ' . $this->db->quote(
728  $a_rec['id'],
729  'integer'
730  ));
731  $ids_fields = $this->buildCache('il_dcl_field', $set);
732  $set = $this->db->query('SELECT * FROM il_dcl_tableview WHERE table_id = ' . $this->db->quote(
733  $a_rec['id'],
734  'integer'
735  ));
736  $ids_tableviews = $this->buildCache('il_dcl_tableview', $set);
737  $set = $this->db->query('SELECT * FROM il_dcl_tfield_set WHERE table_id = ' . $this->db->quote(
738  $a_rec['id'],
739  'integer'
740  ));
741  $ids_tablefield_settings = $this->buildCache('il_dcl_tfield_set', $set);
742 
743  return [
744  'il_dcl_field' => ['ids' => $ids_fields],
745  'il_dcl_record' => ['ids' => $ids_records],
746  'il_dcl_tableview' => ['ids' => $ids_tableviews],
747  'il_dcl_tfield_set' => ['ids' => $ids_tablefield_settings],
748  ];
749  case 'il_dcl_field':
750  $set = $this->db->query('SELECT * FROM il_dcl_field_prop WHERE field_id = ' . $this->db->quote(
751  $a_rec['id'],
752  'integer'
753  ));
754  $prop_ids = $this->buildCache('il_dcl_field_prop', $set);
755 
756  $set = $this->db->query('SELECT * FROM il_dcl_sel_opts WHERE field_id = ' . $this->db->quote(
757  $a_rec['id'],
758  'integer'
759  ));
760  $opt_ids = $this->buildCache('il_dcl_sel_opts', $set);
761 
762  return [
763  'il_dcl_field_prop' => ['ids' => $prop_ids],
764  'il_dcl_sel_opts' => ['ids' => $opt_ids],
765  ];
766  case 'il_dcl_record':
767  $sql = 'SELECT rf.*, d.storage_location FROM il_dcl_record_field AS rf' . ' INNER JOIN il_dcl_field AS f ON (f.id = rf.field_id)'
768  . ' INNER JOIN il_dcl_datatype AS d ON (f.datatype_id = d.id) ' . ' WHERE rf.record_id = '
769  . $this->db->quote($a_rec['id'], 'integer');
770  $set = $this->db->query($sql);
771  $ids = $this->buildCache('il_dcl_record_field', $set);
772 
773  $set = $this->db->query($sql);
774  while ($rec = $this->db->fetchObject($set)) {
775  $this->record_field_ids_2_storage[$rec->id] = ilDclCache::getFieldCache($rec->field_id)->getStorageLocation();
776  }
777  // Also build a cache of all values, no matter in which table they are (il_dcl_stloc(1|2|3)_value)
778  $sql
779  = 'SELECT rf.id AS record_field_id, st1.value AS value1, st2.value AS value2, st3.value AS value3 FROM il_dcl_record_field AS rf '
780  . 'LEFT JOIN il_dcl_stloc1_value AS st1 ON (st1.record_field_id = rf.id) '
781  . 'LEFT JOIN il_dcl_stloc2_value AS st2 ON (st2.record_field_id = rf.id) '
782  . 'LEFT JOIN il_dcl_stloc3_value AS st3 ON (st3.record_field_id = rf.id) ' . 'WHERE rf.record_id = '
783  . $this->db->quote($a_rec['id'], 'integer');
784  $set = $this->db->query($sql);
785 
786  while ($rec = $this->db->fetchObject($set)) {
787  $stloc = $this->record_field_ids_2_storage[$rec->record_field_id];
788  $value = null;
789  if ($stloc != 0) {
790  $value = "value$stloc";
791  $value = $rec->{$value};
792  }
793  // Save reocrd field id. Internal ID is not used currently
794  $this->caches["il_dcl_stloc{$stloc}_value"][$rec->record_field_id] = [
795  'record_field_id' => $rec->record_field_id,
796  'value' => $value,
797  ];
798  }
799 
800  return [
801  'il_dcl_record_field' => ['ids' => $ids],
802  ];
803  case 'il_dcl_tableview':
804  $set = $this->db->query('SELECT * FROM il_dcl_tview_set WHERE tableview_id = ' . $this->db->quote(
805  $a_rec['id'],
806  'integer'
807  ));
808  $ids = $this->buildCache('il_dcl_tview_set', $set);
809 
810  return [
811  'il_dcl_tview_set' => ['ids' => $ids],
812  ];
813  case 'il_dcl_tview_set':
814 
815  if (!(int) $a_rec['field'] > 0) {
816  break;
817  }
818  // Also build a cache of all values, no matter in which table they are (il_dcl_stloc(1|2|3)_value)
819  $sql
820  = '
821  SELECT tview_set.id AS tview_set_id, st1.value AS value1, st2.value AS value2, st3.value AS value3,
822  st1.id AS id1, st2.id AS id2, st3.id AS id3
823  FROM il_dcl_tview_set AS tview_set
824  LEFT JOIN il_dcl_stloc1_default AS st1 ON (st1.tview_set_id = tview_set.id)
825  LEFT JOIN il_dcl_stloc2_default AS st2 ON (st2.tview_set_id = tview_set.id)
826  LEFT JOIN il_dcl_stloc3_default AS st3 ON (st3.tview_set_id = tview_set.id)
827  WHERE tview_set.id = ' . $this->db->quote($a_rec['id'], 'integer');
828  $set = $this->db->query($sql);
829 
830  while ($rec = $this->db->fetchObject($set)) {
831  $stloc = ilDclCache::getFieldCache((int) $a_rec['field'])->getStorageLocation();
832  if ($stloc != 0) {
833  $value_str = "value$stloc";
834  $value = $rec->{$value_str};
835  $id_str = "id$stloc";
836  $id = $rec->{$id_str};
837  $tview_set_id = $rec->tview_set_id;
838 
839  // Save reocrd field id. Internal ID is not used currently
840  $this->caches["il_dcl_stloc" . "$stloc" . "_default"][$rec->tview_set_id] = [
841  'id' => $id,
842  'tview_set_id' => $rec->tview_set_id,
843  'value' => $value,
844  ];
845 
846  return [
847  "il_dcl_stloc{$stloc}_default" => ['ids' => [$tview_set_id]],
848  ];
849  }
850  }
851  break;
852  case 'il_dcl_record_field':
853  $record_field_id = $a_rec['id'];
854  $storage_loc = $this->record_field_ids_2_storage[$record_field_id];
855 
856  return [
857  "il_dcl_stloc{$storage_loc}_value" => ['ids' => [$record_field_id]],
858  ];
859  }
860 
861  return [];
862  }
863 
868  public function readData(string $a_entity, string $a_version, array $a_ids): void
869  {
870  $this->data = [];
871  $this->_readData($a_entity, $a_ids);
872  }
873 
879  protected function _readData(string $a_entity, array $a_ids): void
880  {
881  switch ($a_entity) {
882  case 'dcl':
883  foreach ($a_ids as $dcl_id) {
884  if (ilObject::_lookupType((int) $dcl_id) === 'dcl') {
885  $obj = new ilObjDataCollection((int) $dcl_id, false);
886  $data = [
887  'id' => $dcl_id,
888  'title' => $obj->getTitle(),
889  'description' => $obj->getDescription(),
890  'is_online' => $obj->getOnline(),
891  'rating' => $obj->getRating(),
892  'public_notes' => $obj->getPublicNotes(),
893  'approval' => $obj->getApproval(),
894  'notification' => $obj->getNotification(),
895  ];
896  $this->caches['dcl'][$dcl_id] = $data;
897  $this->data[] = $data;
898  }
899  }
900  break;
901  default:
902  $data = $this->getCache($a_entity);
903  foreach ($a_ids as $id) {
904  $this->data[] = $data[$id];
905  }
906  }
907  }
908 
909  protected function buildCache(string $a_entity, ilDBStatement $set): array
910  {
911  $fields = array_keys($this->getTypes($a_entity, ''));
912  $ids = [];
913  while ($rec = $this->db->fetchObject($set)) {
914  $data = [];
915  foreach ($fields as $field) {
916  $data[$field] = $rec->{$field};
917  }
918  $id = $rec->id;
919  $this->caches[$a_entity][$id] = $data;
920  $ids[] = $id;
921  }
922 
923  return $ids;
924  }
925 }
ilDataCollectionDataSet\getXmlNamespace
getXmlNamespace(string $a_entity, string $a_schema_version)
Definition: class.ilDataCollectionDataSet.php:103
ilDclTableView\createOrGetStandardView
static createOrGetStandardView(int $table_id)
Definition: class.ilDclTableView.php:409
ilDataCollectionDataSet\getTypes
getTypes(string $a_entity, string $a_version)
Map XML attributes of entities to datatypes (text, integer...)
Definition: class.ilDataCollectionDataSet.php:564
ilDataCollectionDataSet\buildCache
buildCache(string $a_entity, ilDBStatement $set)
Definition: class.ilDataCollectionDataSet.php:909
ilDclCache\getFieldCache
static getFieldCache(int $field_id=0)
Definition: class.ilDclCache.php:144
$datetime
$datetime
Definition: LOMStructure.php:69
ilObjMediaObject\_saveUsage
static _saveUsage(int $a_mob_id, string $a_type, int $a_id, int $a_usage_hist_nr=0, string $a_lang="-")
Save usage of mob within another container (e.g.
Definition: class.ilObjMediaObject.php:848
ilDclFieldTypePlugin\isPluginDatatype
static isPluginDatatype(string $datatype)
Definition: class.ilDclFieldTypePlugin.php:74
ilDataCollectionDataSet\$import_record_field_cache
array $import_record_field_cache
Caches ilDclBaseRecordFieldModel objects.
Definition: class.ilDataCollectionDataSet.php:69
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:23
ilImportMapping\addMapping
addMapping(string $a_comp, string $a_entity, string $a_old_id, string $a_new_id)
Definition: class.ilImportMapping.php:72
null
while($session_entry=$r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) return null
Definition: shib_logout.php:142
ilDclTableViewFieldSetting\getInstance
static getInstance(int $tableview_id, int $field_id)
Definition: class.ilDclTableViewFieldSetting.php:398
ilImportMapping\getMapping
getMapping(string $a_comp, string $a_entity, string $a_old_id)
Definition: class.ilImportMapping.php:82
ilDataCollectionDataSet\readData
readData(string $a_entity, string $a_version, array $a_ids)
Read data from Cache for a given entity and ID(s)
Definition: class.ilDataCollectionDataSet.php:868
ilDclDatatype\getAllDatatype
static getAllDatatype(bool $force=false)
Get all possible Datatypes.
Definition: class.ilDclDatatype.php:119
ilDataCollectionDataSet\getCache
getCache(string $a_entity)
Get cached data from a given entity.
Definition: class.ilDataCollectionDataSet.php:94
ilDataSet\importRecord
importRecord(string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
Needs to be overwritten for import use case.
Definition: class.ilDataSet.php:558
$DIC
global $DIC
Definition: shib_login.php:22
ilDclCache\getTableCache
static getTableCache(?int $table_id=null)
Definition: class.ilDclCache.php:131
ilDataCollectionDataSet\$import_dc_object
array ilObjDataCollection $import_dc_object
Definition: class.ilDataCollectionDataSet.php:47
ilDataCollectionDataSet\_readData
_readData(string $a_entity, array $a_ids)
Build data array, data is read from cache except dcl object itself.
Definition: class.ilDataCollectionDataSet.php:879
ilDclTableFieldSetting\getInstance
static getInstance(int $table_id, string $field)
Definition: class.ilDclTableFieldSetting.php:126
ilObjectFactory\getInstanceByObjId
static getInstanceByObjId(?int $obj_id, bool $stop_on_error=true)
get an instance of an Ilias object by object id
Definition: class.ilObjectFactory.php:84
ilDclCache\getRecordCache
static getRecordCache(?int $record_id)
Definition: class.ilDclCache.php:154
$id
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
Definition: PluginProviderHelper.php:37
ilDataCollectionDataSet\getDependencies
getDependencies(string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
Return dependencies form entities to other entities (in our case these are all the DB relations) ...
Definition: class.ilDataCollectionDataSet.php:701
ilObject\_lookupType
static _lookupType(int $id, bool $reference=false)
Definition: class.ilObject.php:1084