Inheritance diagram for ilObjectDataSet:

Collaboration diagram for ilObjectDataSet:

Public Member Functions
	getSupportedVersions ()
	Get supported versions. More...

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data. More...

	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record. More...

Public Member Functions inherited from ilDataSet
	__construct ()
	Constructor. More...

	init ($a_entity, $a_schema_version)
	Init. More...

	getSupportedVersions ()
	Get supported version. More...

	readData ($a_entity, $a_version, $a_ids)
	Read data from DB. More...

	setExportDirectories ($a_relative, $a_absolute)
	Set export directories. More...

	setImportDirectory ($a_val)
	Set import directory. More...

	getImportDirectory ()
	Get import directory. More...

	setDSPrefix ($a_val)
	Set XML dataset namespace prefix. More...

	getDSPrefix ()
	Get XML dataset namespace prefix. More...

	getDSPrefixString ()

	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true, $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...

	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string. More...

	getJsonRepresentation ()
	Get json representation. More...

	getXmlRepresentation ( $a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $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 ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
	Add records xml. More...

	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record. More...

	getNamespaces (&$namespaces, $a_entity, $a_schema_version)
	Get xml namespaces. More...

	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version. More...

	getJsonRecord ($a_set)
	Get json record for version. More...

	getXmlTypes ($a_entity, $a_version)
	Get xml types. More...

	getJsonTypes ($a_entity, $a_version)
	Get json types. More...

	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten) More...

	getXMLEntityTag ($a_entity, $a_schema_version)
	Get entity tag. More...

	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten) More...

	setImport ($a_val)
	Set import object. More...

	getImport ()
	Get import object. More...

	setCurrentInstallationId ($a_val)
	Set current installation id. More...

	getCurrentInstallationId ()
	Get current installation id. More...

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity. More...

	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data. More...

Protected Member Functions inherited from ilDataSet
	getTypes ($a_entity, $a_version)
	Get (abstract) types for (abstract) field names. More...

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	createObjectExportId ($a_type, $a_id)
	Build ilias export id. More...

	parseObjectExportId ($a_id, $a_fallback_id=null)
	Parse export id. More...

Additional Inherited Members
Data Fields inherited from ilDataSet
	$dircnt

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

Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

	$db

	$ds_log

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

Version: $Id$

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

Member Function Documentation

◆ getDependencies()

ilObjectDataSet::getDependencies	(	$a_entity,
		$a_version,
		$a_rec,
		$a_ids
	)

protected

Determine the dependent sets of data.

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

    {
        switch ($a_entity) {
            case "transl":
                return array(
                    "transl_entry" => array("ids" => $a_rec["ObjId"])
                );
        }
 
        return false;
    }

◆ getSupportedVersions()

ilObjectDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

return

Reimplemented from ilDataSet.

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

    {
        return array("4.4.0", "5.1.0", "5.2.0");
    }

◆ getTypes()

ilObjectDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

return

Reimplemented from ilDataSet.

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

    {
        if ($a_entity == "transl_entry") {
            switch ($a_version) {
                case "4.4.0":
                case "5.1.0":
                case "5.2.0":
                    return array(
                        "ObjId" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "LangCode" => "text",
                        "LangDefault" => "integer");
            }
        }
        if ($a_entity == "transl") {
            switch ($a_version) {
                case "4.4.0":
                case "5.1.0":
                case "5.2.0":
                    return array(
                        "ObjId" => "integer",
                        "MasterLang" => "text");
            }
        }
        if ($a_entity == "service_settings") {
            switch ($a_version) {
                case "5.1.0":
                case "5.2.0":
                    return array(
                        "ObjId" => "integer",
                        "Setting" => "text",
                        "Value" => "text");
            }
        }
    }

◆ getXmlNamespace()

ilObjectDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

return

Reimplemented from ilDataSet.

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

    {
        return "http://www.ilias.de/xml/Services/Object/" . $a_entity;
    }

◆ importRecord()

ilObjectDataSet::importRecord	(	$a_entity,
		$a_types,
		$a_rec,
		$a_mapping,
		$a_schema_version
	)

Import record.

Parameters

return

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

    {
        switch ($a_entity) {
            case "transl_entry":
                $new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['ObjId']);
                if (!$new_id) {
                    $new_id = $a_mapping->getMapping('Services/Object', 'obj', $a_rec['ObjId']);
                }
                if ($new_id > 0) {
                    include_once("./Services/Object/classes/class.ilObjectTranslation.php");
                    $transl = ilObjectTranslation::getInstance($new_id);
                    $transl->addLanguage($a_rec["LangCode"], $a_rec["Title"], $a_rec["Description"], $a_rec["LangDefault"], true);
                    $transl->save();
                }
                break;
 
            case "transl":
                $new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['ObjId']);
                if (!$new_id) {
                    $new_id = $a_mapping->getMapping('Services/Object', 'obj', $a_rec['ObjId']);
                }
                if ($new_id > 0) {
                    include_once("./Services/Object/classes/class.ilObjectTranslation.php");
                    $transl = ilObjectTranslation::getInstance($new_id);
                    $transl->setMasterLanguage($a_rec["MasterLang"]);
                    $transl->save();
                }
                break;
 
            case "service_settings":
                include_once("./Services/Object/classes/class.ilObjectServiceSettingsGUI.php");
                include_once("./Services/Container/classes/class.ilContainer.php");
 
                // info, news, custom metadata, tags, taxonomies, auto rating (all stored in container settings)
                $settings = array(
                    ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
                    ilObjectServiceSettingsGUI::NEWS_VISIBILITY,
                    ilObjectServiceSettingsGUI::CUSTOM_METADATA,
                    ilObjectServiceSettingsGUI::TAG_CLOUD,
                    ilObjectServiceSettingsGUI::TAXONOMIES,
                    ilObjectServiceSettingsGUI::AUTO_RATING_NEW_OBJECTS,
                    ilObjectServiceSettingsGUI::CALENDAR_VISIBILITY,
                    ilObjectServiceSettingsGUI::USE_NEWS
                );
                $new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['ObjId']);
                if (!$new_id) {
                    $new_id = $a_mapping->getMapping('Services/Object', 'objs', $a_rec['ObjId']);
                }
                if (!$new_id) {
                    $new_id = $a_mapping->getMapping('Services/Object', 'obj', $a_rec['ObjId']);
                }
                if ($new_id > 0) {
                    if (in_array($a_rec["Setting"], $settings)) {
                        ilContainer::_writeContainerSetting($new_id, $a_rec["Setting"], $a_rec["Value"]);
                    }
                }
                break;
        }
    }

References ilContainer\_writeContainerSetting(), ilObjectServiceSettingsGUI\AUTO_RATING_NEW_OBJECTS, ilObjectServiceSettingsGUI\CALENDAR_VISIBILITY, ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilObjectTranslation\getInstance(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilObjectServiceSettingsGUI\NEWS_VISIBILITY, ilObjectServiceSettingsGUI\TAG_CLOUD, ilObjectServiceSettingsGUI\TAXONOMIES, and ilObjectServiceSettingsGUI\USE_NEWS.

Here is the call graph for this function:

◆ readData()

ilObjectDataSet::readData	(	$a_entity,
		$a_version,
		$a_ids,
		$a_field = `""`
	)

Read data.

Parameters

return

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

    {
        $ilDB = $this->db;
 
        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
                
        if ($a_entity == "transl_entry") {
            switch ($a_version) {
                case "4.4.0":
                case "5.1.0":
                case "5.2.0":
                    $this->getDirectDataFromQuery("SELECT obj_id, title, description," .
                        " lang_code, lang_default" .
                        " FROM object_translation" .
                        " WHERE " . $ilDB->in("obj_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "transl") {
            switch ($a_version) {
                case "4.4.0":
                case "5.1.0":
                case "5.2.0":
                    $this->getDirectDataFromQuery("SELECT obj_id, master_lang" .
                        " FROM obj_content_master_lng" .
                        " WHERE " . $ilDB->in("obj_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "service_settings") {
            switch ($a_version) {
                case "5.1.0":
                case "5.2.0":
                    include_once("./Services/Object/classes/class.ilObjectServiceSettingsGUI.php");
                    include_once("./Services/Container/classes/class.ilContainer.php");
 
                    $this->data = array();
                    foreach ($a_ids as $id) {
                        // info, news, custom metadata, tags, taxonomies, auto rating (all stored in container settings)
                        $settings = array(
                            ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
                            ilObjectServiceSettingsGUI::NEWS_VISIBILITY,
                            ilObjectServiceSettingsGUI::CUSTOM_METADATA,
                            ilObjectServiceSettingsGUI::TAG_CLOUD,
                            ilObjectServiceSettingsGUI::TAXONOMIES,
                            ilObjectServiceSettingsGUI::AUTO_RATING_NEW_OBJECTS,
                            ilObjectServiceSettingsGUI::CALENDAR_VISIBILITY
                        );
                        if ($a_version == "5.2.0") {
                            $settings[] = ilObjectServiceSettingsGUI::USE_NEWS;
                        }
                        foreach ($settings as $s) {
                            $val = ilContainer::_lookupContainerSetting($id, $s);
                            if ($val) {
                                $this->data[] = array(
                                    "ObjId" => $id,
                                    "Setting" => $s,
                                    "Value" => $val
                                );
                            }
                        }
                    }
                    break;
            }
        }
    }

References ilDataSet\$db, $id, $ilDB, $s, ilContainer\_lookupContainerSetting(), ilObjectServiceSettingsGUI\AUTO_RATING_NEW_OBJECTS, ilObjectServiceSettingsGUI\CALENDAR_VISIBILITY, ilObjectServiceSettingsGUI\CUSTOM_METADATA, data, ilDataSet\getDirectDataFromQuery(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilObjectServiceSettingsGUI\NEWS_VISIBILITY, ilObjectServiceSettingsGUI\TAG_CLOUD, ilObjectServiceSettingsGUI\TAXONOMIES, and ilObjectServiceSettingsGUI\USE_NEWS.

Here is the call graph for this function:

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

Services/Object/classes/class.ilObjectDataSet.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()