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 (string $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

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 253 of file class.ilObjectDataSet.php.

                                                               : string
    {
        $i = $this->storage->manage()->find($rid);
        $resource = $this->storage->manage()->getResource($i);
        $path_in_container = "/dsDir_" . $this->dircnt . "/" . $resource->getCurrentRevision()->getTitle();
        $path_in_container = $this->export->isContainerExport()
            ? $this->export->getPathToComponentExpDirInContainerWithLeadingSetNumber() . $path_in_container
            : $this->export->getPathToComponentExpDirInContainer() . $path_in_container;
        $this->export->getExportWriter()->writeFilesByResourceId($rid, $path_in_container);
        return $path_in_container;
    }

◆ getDependencies()

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

protected

Determine the dependent sets of data.

Reimplemented from ilDataSet.

Definition at line 267 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 [];
    }

◆ getSupportedVersions()

ilObjectDataSet::getSupportedVersions ( )

Reimplemented from ilDataSet.

Definition at line 56 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.

Reimplemented from ilDataSet.

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

                                                                : 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 [];
    }

References ilDataSet\$entity, and ilDataSet\$version.

◆ getXmlNamespace()

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

protected

Reimplemented from ilDataSet.

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

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

References ilDataSet\$entity.

Field Documentation

◆ $base_lang

string ilObjectDataSet::$base_lang = null

static

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

◆ $properties_aggregator

Aggregator ilObjectDataSet::$properties_aggregator

private

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

◆ $storage

ResourceStorage ilObjectDataSet::$storage

private

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

◆ $translations_repository

TranslationsRepository ilObjectDataSet::$translations_repository

private

Definition at line 40 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

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ copyTileToTempFolderForExport()

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

Field Documentation

◆ $base_lang

◆ $properties_aggregator

◆ $storage

◆ $translations_repository