Public Member Functions |
Static Public Attributes |
Protected Member Functions |
Private Member Functions |
Private Attributes
ilObjectDataSet Class Reference
Object data set class. 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... | |
| initByExporter (ilXmlExporter $xml_exporter) | |
| 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... | |
| getCollection (array $record, string $entity, string $schema_version, string $field, string $value) | |
| getContainerExportConfig (array $record, string $entity, string $schema_version, string $field, string $value) | |
Static Public Attributes | |
| static string | $base_lang = null |
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) | |
| getExportDirInContainer (string $exp_dir) | |
| getIRSSContainerExportConfig (StorableResource $source_container, string $source_path, string $target_path="") | |
| 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=[]) | |
Private Member Functions | |
| copyTileToTempFolderForExport (ResourceIdentification $rid) | |
Private Attributes | |
| ResourceStorage | $storage |
| Aggregator | $properties_aggregator |
| TranslationsRepository | $translations_repository |
Additional Inherited Members | |
| Data Fields inherited from ilDataSet | |
| const | DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3' |
| const | DATASET_NS_PREFIX = 'ds' |
| 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 | |
| ILIAS ResourceStorage Services | $irss |
| string | $current_installation_id = "" |
| array | $data = [] |
| ilDBInterface | $db |
| ilLogger | $ds_log |
| string | $import_directory = "" |
| string | $entity = "" |
| string | $schema_version = "" |
| string | $component_export_dir = "" |
| string | $ds_prefix = "ds" |
| string | $version = "" |
| ilSurveyImporter | $import |
| ilExport | $export |
Detailed Description
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 37 of file class.ilObjectDataSet.php.
Member Function Documentation
◆ copyTileToTempFolderForExport()
|
private |
Definition at line 256 of file class.ilObjectDataSet.php.
256 : string
257 {
258 $path_in_container = "/dsDir_{$this->dircnt}/"
259 . $this->storage->manage()->getResource($rid)
260 ->getCurrentRevision()->getTitle();
261 $path_in_container = $this->export->isContainerExport()
262 ? $this->export->getPathToComponentExpDirInContainerWithLeadingSetNumber()
263 . $path_in_container
264 : $this->export->getPathToComponentExpDirInContainer()
265 . $path_in_container;
266 $this->export->getExportWriter()->writeFilesByResourceId(
267 $rid->serialize(),
268 $path_in_container
269 );
270 return $path_in_container;
271 }
References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().
Here is the call graph for this function:
◆ getDependencies()
|
protected |
Determine the dependent sets of data.
Reimplemented from ilDataSet.
Definition at line 275 of file class.ilObjectDataSet.php.
280 : array {
281 $rec['ObjId'] = $rec['ObjId'] ?? null;
283 case 'common':
284 return [
285 'transl' => ['ids' => $rec['ObjId']],
286 'transl_entry' => ['ids' => $rec['ObjId']],
287 'service_settings' => ['ids' => $rec['ObjId']],
288 'tile' => ['ids' => $rec['ObjId']],
289 'icon' => ['ids' => $rec['ObjId']]
290 ];
291 }
292
293 return [];
294 }
◆ getSupportedVersions()
| ilObjectDataSet::getSupportedVersions | ( | ) |
Reimplemented from ilDataSet.
Definition at line 57 of file class.ilObjectDataSet.php.
57 : array
58 {
59 return ['4.4.0', '5.1.0', '5.2.0', '5.4.0'];
60 }
◆ getTypes()
|
protected |
Get field types for entity.
Reimplemented from ilDataSet.
Definition at line 70 of file class.ilObjectDataSet.php.
70 : array
71 {
74 case '4.4.0':
75 case '5.1.0':
76 case '5.2.0':
77 case '5.4.0':
78 return [
79 'ObjId' => 'integer',
80 'Title' => 'text',
81 'Description' => 'text',
82 'LangCode' => 'text',
83 'LangDefault' => 'integer'
84 ];
85 }
86 }
89 case '4.4.0':
90 case '5.1.0':
91 case '5.2.0':
92 case '5.4.0':
93 return [
94 'ObjId' => 'integer',
95 'MasterLang' => 'text'
96 ];
97 }
98 }
101 case '5.1.0':
102 case '5.2.0':
103 case '5.4.0':
104 return [
105 'ObjId' => 'integer',
106 'Setting' => 'text',
107 'Value' => 'text'
108 ];
109 }
110 }
113 return [
114 'ObjId' => 'integer'
115 ];
116 }
117 }
120 return [
121 'ObjId' => 'integer',
122 'Filename' => 'text',
123 'Dir' => 'directory'
124 ];
125 }
126 }
129 return [
130 'ObjId' => 'integer',
131 'Dir' => 'directory'
132 ];
133 }
134 }
135 return [];
136 }
References ilDataSet\$entity, and ilDataSet\$version.
◆ getXmlNamespace()
|
protected |
Reimplemented from ilDataSet.
Definition at line 62 of file class.ilObjectDataSet.php.
References ilDataSet\$entity.
Field Documentation
◆ $base_lang
|
static |
Definition at line 43 of file class.ilObjectDataSet.php.
◆ $properties_aggregator
|
private |
Definition at line 40 of file class.ilObjectDataSet.php.
◆ $storage
|
private |
Definition at line 39 of file class.ilObjectDataSet.php.
◆ $translations_repository
|
private |
Definition at line 41 of file class.ilObjectDataSet.php.
The documentation for this class was generated from the following file:
- components/ILIAS/ILIASObject/classes/class.ilObjectDataSet.php
