Item group data set class. More...

Inheritance diagram for ilItemGroupDataSet:

Collaboration diagram for ilItemGroupDataSet:

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

	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record (export) 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...

	stripTags (array $rec, array $omit_keys=[])

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

	$ds_namespace = 'ds'

Detailed Description

Item group data set class.

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

Version: $Id$

Definition at line 13 of file class.ilItemGroupDataSet.php.

Member Function Documentation

◆ getDependencies()

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

protected

Determine the dependent sets of data.

Definition at line 137 of file class.ilItemGroupDataSet.php.

    {
        switch ($a_entity) {
            case "itgr":
                return array(
                    "itgr_item" => array("ids" => $a_rec["Id"])
                );
        }
 
        return false;
    }

◆ getSupportedVersions()

ilItemGroupDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 21 of file class.ilItemGroupDataSet.php.

    {
        return array("4.3.0", "5.3.0");
    }

◆ getTypes()

ilItemGroupDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 43 of file class.ilItemGroupDataSet.php.

    {
        if ($a_entity == "itgr") {
            switch ($a_version) {
                case "4.3.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text");
                case "5.3.0":
                    return array(
                        "Id" => "integer",
                        "HideTitle" => "integer",
                        "Behaviour" => "integer",
                        "Title" => "text",
                        "Description" => "text");
            }
        }
 
        if ($a_entity == "itgr_item") {
            switch ($a_version) {
                case "4.3.0":
                case "5.3.0":
                    return array(
                        "ItemGroupId" => "integer",
                        "ItemId" => "text"
                        );
            }
        }
    }

◆ getXmlNamespace()

ilItemGroupDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 32 of file class.ilItemGroupDataSet.php.

    {
        return "http://www.ilias.de/xml/Modules/ItemGroup/" . $a_entity;
    }

◆ getXmlRecord()

ilItemGroupDataSet::getXmlRecord	(	$a_entity,
		$a_version,
		$a_set
	)

Get xml record (export)

Parameters

array abstract data record

Returns: array xml record

Reimplemented from ilDataSet.

Definition at line 125 of file class.ilItemGroupDataSet.php.

    {
        if ($a_entity == "itgr_item") {
            // make ref id an object id
            $a_set["ItemId"] = ilObject::_lookupObjId($a_set["ItemId"]);
        }
        return $a_set;
    }

References ilObject\_lookupObjId().

Here is the call graph for this function:

◆ importRecord()

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

Import record.

Parameters

return

Definition at line 155 of file class.ilItemGroupDataSet.php.

    {
        $a_rec = $this->stripTags($a_rec);
        switch ($a_entity) {
            case "itgr":
                include_once("./Modules/ItemGroup/classes/class.ilObjItemGroup.php");
                
                if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['Id'])) {
                    $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                } else {
                    $newObj = new ilObjItemGroup();
                    $newObj->setType("itgr");
                    $newObj->create(true);
                }
                
                $newObj->setTitle($a_rec["Title"]);
                $newObj->setDescription($a_rec["Description"]);
                $newObj->setBehaviour($a_rec["Behaviour"]);
                $newObj->setHideTitle($a_rec["HideTitle"]);
                $newObj->update(true);
                $this->current_obj = $newObj;
                $a_mapping->addMapping("Modules/ItemGroup", "itgr", $a_rec["Id"], $newObj->getId());
                
                break;
                
            case "itgr_item":
                if ($obj_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['ItemId'])) {
                    $ref_id = current(ilObject::_getAllReferences($obj_id));
                    include_once './Modules/ItemGroup/classes/class.ilItemGroupItems.php';
                    $itgri = new ilItemGroupItems();
                    $itgri->setItemGroupId($this->current_obj->getId());
                    $itgri->read();
                    $itgri->addItem($ref_id);
                    $itgri->update();
                }
                break;
 
        }
    }

References ilObject\_getAllReferences(), ilObjectFactory\getInstanceByObjId(), and ilDataSet\stripTags().

Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

return

Definition at line 80 of file class.ilItemGroupDataSet.php.

    {
        $ilDB = $this->db;
 
        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
                
        if ($a_entity == "itgr") {
            switch ($a_version) {
                case "4.3.0":
                    $this->getDirectDataFromQuery("SELECT obj_id id, title, description " .
                        " FROM object_data " .
                        "WHERE " .
                        $ilDB->in("obj_id", $a_ids, false, "integer"));
                    break;
                case "5.3.0":
                    $this->getDirectDataFromQuery("SELECT obj_id id, title, description, hide_title, behaviour " .
                        " FROM object_data JOIN itgr_data ON (object_data.obj_id = itgr_data.id)" .
                        "WHERE " .
                        $ilDB->in("obj_id", $a_ids, false, "integer"));
                    break;
 
            }
        }
 
        if ($a_entity == "itgr_item") {
            switch ($a_version) {
                case "4.3.0":
                case "5.3.0":
                    $this->getDirectDataFromQuery($q = "SELECT item_group_id itgr_id, item_ref_id item_id" .
                        " FROM item_group_item " .
                        "WHERE " .
                        $ilDB->in("item_group_id", $a_ids, false, "integer"));
                    break;
            }
        }
    }

References ilDataSet\$db, $ilDB, and ilDataSet\getDirectDataFromQuery().

Here is the call graph for this function:

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

Modules/ItemGroup/classes/class.ilItemGroupDataSet.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ getXmlRecord()

◆ importRecord()

◆ readData()