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

Author

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

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

Member Function Documentation

getDependencies()

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

protected

Determine the dependent sets of data.

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

References $DIC, ilDataSet\$schema_version, ILIAS\LTI\ToolProvider\$settings, $type, ilObject\_lookupType(), ilContainer\_writeContainerSetting(), ilObjectGUI\ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION, ilObjectServiceSettingsGUI\AUTO_RATING_NEW_OBJECTS, ilObjectServiceSettingsGUI\CALENDAR_VISIBILITY, ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilImportMapping\getAllMappings(), ilDataSet\getImportDirectory(), ilObjectTranslation\getInstance(), ilImportMapping\getMapping(), ilDataSet\importRecord(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ILIAS\Repository\int(), ilObjectServiceSettingsGUI\NEWS_VISIBILITY, ilObjectServiceSettingsGUI\TAG_CLOUD, ilObjectServiceSettingsGUI\TAXONOMIES, and ilObjectServiceSettingsGUI\USE_NEWS.

     : 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 32 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 45 of file class.ilObjectDataSet.php.

References $DIC, ilDataSet\$entity, $id, ILIAS\LTI\ToolProvider\$settings, ilDataSet\$version, ilContainer\_hasContainerSetting(), ilContainer\_lookupContainerSetting(), ilObject\_lookupType(), ilObjectServiceSettingsGUI\AUTO_RATING_NEW_OBJECTS, ilObjectServiceSettingsGUI\CALENDAR_VISIBILITY, ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilDataSet\getDirectDataFromQuery(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilObjectServiceSettingsGUI\NEWS_VISIBILITY, 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',
                    'Extension' => 'text',
                    'Dir' => 'directory'
                ];
            }
        }
        return [];
    }

Here is the call graph for this function:

getXmlNamespace()

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

protected

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

References ilDataSet\$entity.

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

---

The documentation for this class was generated from the following file:

• Services/Object/classes/class.ilObjectDataSet.php