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

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=[])

Protected Attributes
LocalDIC	$obj_dic

ResourceStorage	$storage

Aggregator	$properties_aggregator

TranslationsRepository	$translations_repository

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

Private Member Functions
	copyTileToTempFolderForExport (string $rid)

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

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

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 36 of file class.ilObjectDataSet.php.

Member Function Documentation

◆ copyTileToTempFolderForExport()

ilObjectDataSet::copyTileToTempFolderForExport ( string $rid )

private

Definition at line 252 of file class.ilObjectDataSet.php.

References CLIENT_ID, and ILIAS_DATA_DIR.

Referenced by getTypes().

                                                                : string
     {
         $i = $this->storage->manage()->find($rid);
         $stream = $this->storage->consume()->stream(
             $i
         );
         $title = $this->storage->manage()->getCurrentRevision($i)->getTitle();
 
         $temp_dir = implode(
             DIRECTORY_SEPARATOR,
             [ILIAS_DATA_DIR, CLIENT_ID, 'temp', uniqid('tmp')]
         );
         mkdir($temp_dir);
         file_put_contents($temp_dir . DIRECTORY_SEPARATOR . $title, $stream->getStream()->getContents());
         return $temp_dir;
     }

Here is the caller graph for this function:

◆ getDependencies()

ilObjectDataSet::getDependencies	(	string	$entity,
		string	$version,
		?array	$rec = `null`,
		?array	$ids = `null`
	)

protected

Determine the dependent sets of data.

Definition at line 271 of file class.ilObjectDataSet.php.

      : array {
         $rec['ObjId'] = $rec['ObjId'] ?? null;
         switch ($entity) {
             case 'common':
                 return [
                     'transl' => ['ids' => $rec['ObjId']],
                     'transl_entry' => ['ids' => $rec['ObjId']],
                     'service_settings' => ['ids' => $rec['ObjId']],
                     'tile' => ['ids' => $rec['ObjId']],
                     'icon' => ['ids' => $rec['ObjId']]
                 ];
         }
 
         return [];
     }

Here is the call graph for this function:

◆ getSupportedVersions()

ilObjectDataSet::getSupportedVersions ( )

Definition at line 55 of file class.ilObjectDataSet.php.

                                           : array
     {
         return ['4.4.0', '5.1.0', '5.2.0', '5.4.0'];
     }

◆ getTypes()

ilObjectDataSet::getTypes	(	string	$entity,
		string	$version
	)

protected

Get field types for entity.

Definition at line 68 of file class.ilObjectDataSet.php.

References $DIC, ilDataSet\$entity, $id, ilDataSet\$version, ilContainer\_hasContainerSetting(), ilContainer\_lookupContainerSetting(), ilObject\_lookupType(), ilObjectServiceSettingsGUI\AUTO_RATING_NEW_OBJECTS, ilObjectServiceSettingsGUI\CALENDAR_VISIBILITY, copyTileToTempFolderForExport(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilDataSet\getDirectDataFromQuery(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilObjectServiceSettingsGUI\NEWS_VISIBILITY, null, ilDataSet\readData(), ilObjectServiceSettingsGUI\TAG_CLOUD, ilObjectServiceSettingsGUI\TAXONOMIES, and ilObjectServiceSettingsGUI\USE_NEWS.

                                                                 : array
     {
         if ($entity == 'transl_entry') {
             switch ($version) {
                 case '4.4.0':
                 case '5.1.0':
                 case '5.2.0':
                 case '5.4.0':
                     return [
                         'ObjId' => 'integer',
                         'Title' => 'text',
                         'Description' => 'text',
                         'LangCode' => 'text',
                         'LangDefault' => 'integer'
                     ];
             }
         }
         if ($entity == 'transl') {
             switch ($version) {
                 case '4.4.0':
                 case '5.1.0':
                 case '5.2.0':
                 case '5.4.0':
                     return [
                         'ObjId' => 'integer',
                         'MasterLang' => 'text'
                     ];
             }
         }
         if ($entity == 'service_settings') {
             switch ($version) {
                 case '5.1.0':
                 case '5.2.0':
                 case '5.4.0':
                     return [
                         'ObjId' => 'integer',
                         'Setting' => 'text',
                         'Value' => 'text'
                     ];
             }
         }
         if ($entity == 'common') {
             if ($version == '5.4.0') {
                 return [
                     'ObjId' => 'integer'
                 ];
             }
         }
         if ($entity == 'icon') {
             if ($version == '5.4.0') {
                 return [
                     'ObjId' => 'integer',
                     'Filename' => 'text',
                     'Dir' => 'directory'
                 ];
             }
         }
         if ($entity == 'tile') {
             if ($version == '5.4.0') {
                 return [
                     'ObjId' => 'integer',
                     'Dir' => 'directory'
                 ];
             }
         }
         return [];
     }

Here is the call graph for this function:

◆ getXmlNamespace()

ilObjectDataSet::getXmlNamespace	(	string	$entity,
		string	$schema_version
	)

protected

Definition at line 60 of file class.ilObjectDataSet.php.

References ilDataSet\$entity.

                                                                               : string
     {
         return 'http://www.ilias.de/xml/Services/Object/' . $entity;
     }

Field Documentation

◆ $obj_dic

LocalDIC ilObjectDataSet::$obj_dic

protected

Definition at line 38 of file class.ilObjectDataSet.php.

◆ $properties_aggregator

Aggregator ilObjectDataSet::$properties_aggregator

protected

Definition at line 40 of file class.ilObjectDataSet.php.

◆ $storage

ResourceStorage ilObjectDataSet::$storage

protected

Definition at line 39 of file class.ilObjectDataSet.php.

◆ $translations_repository

TranslationsRepository ilObjectDataSet::$translations_repository

protected

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ copyTileToTempFolderForExport()

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

Field Documentation

◆ $obj_dic

◆ $properties_aggregator

◆ $storage

◆ $translations_repository