ilObjectDataSet 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 ilObjectDataSet:
Collaboration diagram for ilObjectDataSet:
Public Member Functions | |
| getSupportedVersions () | |
| Public Member Functions inherited from ilDataSet | |
| __construct () | |
| init (string $a_entity, string $a_schema_version) | |
| Init. More... | |
| getSupportedVersions () | |
| readData (string $a_entity, string $a_version, array $a_ids) | |
| Read data from DB. More... | |
| setExportDirectories (string $a_relative, string $a_absolute) | |
| setImportDirectory (string $a_val) | |
| getImportDirectory () | |
| setDSPrefix (string $a_val) | |
| getDSPrefix () | |
| getDSPrefixString () | |
| getDirectDataFromQuery (string $a_query, bool $a_convert_to_leading_upper=true, bool $a_set=true) | |
| Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More... | |
| convertToLeadingUpper (string $a_str) | |
| Make xyz_abc a XyzAbc string. More... | |
| getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $a_omit_types=false) | |
| Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text" > <ftype name="field_2" type="date" > <ftype name="field_3" type="integer" > </types> <types ...> ... </types> <set entity="table_name"> <rec> <field_1>content</field_1> <field_2>my_date</field_2> <field_3>my_number</field_3> </rec> ... </set> </dataset> More... | |
| addRecordsXml (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="") | |
| afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set) | |
| getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version) | |
| getXmlRecord (string $a_entity, string $a_version, array $a_set) | |
| Get xml record for version. More... | |
| getXmlTypes (string $a_entity, string $a_version) | |
| Get xml types. More... | |
| getXMLEntityName (string $a_entity, string $a_version) | |
| Get entity name for xml (may be overwritten) More... | |
| getXMLEntityTag (string $a_entity, string $a_schema_version) | |
| Get entity tag. More... | |
| setImport (ilSurveyImporter $a_val) | |
| getImport () | |
| setCurrentInstallationId (string $a_val) | |
| getCurrentInstallationId () | |
| 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. More... | |
Protected Member Functions | |
| getXmlNamespace (string $entity, string $schema_version) | |
| getTypes (string $entity, string $version) | |
| Get field types for entity. More... | |
| getDependencies (string $entity, string $version, ?array $rec=null, ?array $ids=null) | |
| Determine the dependent sets of data. More... | |
| Protected Member Functions inherited from ilDataSet | |
| getTypes (string $a_entity, string $a_version) | |
| Get (abstract) types for (abstract) field names. More... | |
| getXmlNamespace (string $a_entity, string $a_schema_version) | |
| getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null) | |
| createObjectExportId (string $a_type, string $a_id) | |
| Build ilias export id. More... | |
| parseObjectExportId (string $a_id, ?string $a_fallback_id=null) | |
| Parse export id. More... | |
| stripTags (array $rec, array $omit_keys=[]) | |
Additional Inherited Members | |
| Data Fields inherited from ilDataSet | |
| const | EXPORT_NO_INST_ID = 1 |
| const | EXPORT_ID_ILIAS_LOCAL = 2 |
| const | EXPORT_ID_ILIAS_LOCAL_INVALID = 3 |
| const | EXPORT_ID_ILIAS_REMOTE = 4 |
| const | EXPORT_ID_ILIAS_REMOTE_INVALID = 5 |
| const | EXPORT_ID = 6 |
| const | EXPORT_ID_INVALID = 7 |
| int | $dircnt = 0 |
| Protected Attributes inherited from ilDataSet | |
| string | $current_installation_id = "" |
| array | $data = [] |
| ilDBInterface | $db |
| ilLogger | $ds_log |
| string | $import_directory = "" |
| string | $entity = "" |
| string | $schema_version = "" |
| string | $relative_export_dir = "" |
| string | $absolute_export_dir = "" |
| string | $ds_prefix = "ds" |
| string | $version = "" |
| ilSurveyImporter | $import |
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 Object data set class
This class implements the following entities:
- transl_entry: data from object_translation
- transl: data from obj_content_master_lang
Definition at line 30 of file class.ilObjectDataSet.php.
Member Function Documentation
◆ getDependencies()
|
protected |
Determine the dependent sets of data.
Reimplemented from ilDataSet.
Definition at line 228 of file class.ilObjectDataSet.php.
233 : array {
234 $rec['ObjId'] = $rec['ObjId'] ?? null;
236 case 'common':
237 return [
238 'transl' => ['ids' => $rec['ObjId']],
239 'transl_entry' => ['ids' => $rec['ObjId']],
240 'service_settings' => ['ids' => $rec['ObjId']],
241 'tile' => ['ids' => $rec['ObjId']],
242 'icon' => ['ids' => $rec['ObjId']]
243 ];
244 }
245
246 return [];
247 }
◆ getSupportedVersions()
| ilObjectDataSet::getSupportedVersions | ( | ) |
Reimplemented from ilDataSet.
Definition at line 32 of file class.ilObjectDataSet.php.
32 : array
33 {
34 return ['4.4.0', '5.1.0', '5.2.0', '5.4.0'];
35 }
◆ getTypes()
|
protected |
Get field types for entity.
Reimplemented from ilDataSet.
Definition at line 45 of file class.ilObjectDataSet.php.
45 : array
46 {
49 case '4.4.0':
50 case '5.1.0':
51 case '5.2.0':
52 case '5.4.0':
53 return [
54 'ObjId' => 'integer',
55 'Title' => 'text',
56 'Description' => 'text',
57 'LangCode' => 'text',
58 'LangDefault' => 'integer'
59 ];
60 }
61 }
64 case '4.4.0':
65 case '5.1.0':
66 case '5.2.0':
67 case '5.4.0':
68 return [
69 'ObjId' => 'integer',
70 'MasterLang' => 'text'
71 ];
72 }
73 }
76 case '5.1.0':
77 case '5.2.0':
78 case '5.4.0':
79 return [
80 'ObjId' => 'integer',
81 'Setting' => 'text',
82 'Value' => 'text'
83 ];
84 }
85 }
88 return [
89 'ObjId' => 'integer'
90 ];
91 }
92 }
95 return [
96 'ObjId' => 'integer',
97 'Filename' => 'text',
98 'Dir' => 'directory'
99 ];
100 }
101 }
104 return [
105 'ObjId' => 'integer',
106 'Extension' => 'text',
107 'Dir' => 'directory'
108 ];
109 }
110 }
111 return [];
112 }
References ilDataSet\$entity, and ilDataSet\$version.
◆ getXmlNamespace()
|
protected |
Reimplemented from ilDataSet.
Definition at line 37 of file class.ilObjectDataSet.php.
References ilDataSet\$entity.
The documentation for this class was generated from the following file:
- Services/Object/classes/class.ilObjectDataSet.php
