This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilItemGroupDataSet:

Collaboration diagram for ilItemGroupDataSet:

Public Member Functions
	getSupportedVersions ()

	getXmlNamespace (string $a_entity, string $a_schema_version)

	readData (string $a_entity, string $a_version, array $a_ids)

	getXmlRecord (string $a_entity, string $a_version, array $a_set)

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
	getTypes (string $a_entity, string $a_version)

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

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

Protected Attributes
ilObjItemGroup	$current_obj

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

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

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 Item group data set class

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ getDependencies()

ilItemGroupDataSet::getDependencies	(	string	$a_entity,
		string	$a_version,
		?array	$a_rec = `null`,
		?array	$a_ids = `null`
	)

protected

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

References $ref_id, ilObject\_getAllReferences(), ilImportMapping\addMapping(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ilDataSet\importRecord(), and ilDataSet\stripTags().

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

Here is the call graph for this function:

◆ getSupportedVersions()

ilItemGroupDataSet::getSupportedVersions ( )

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

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

◆ getTypes()

ilItemGroupDataSet::getTypes	(	string	$a_entity,
		string	$a_version
	)

protected

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

                                                                     : array
     {
         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"
                         );
             }
         }
         return [];
     }

◆ getXmlNamespace()

ilItemGroupDataSet::getXmlNamespace	(	string	$a_entity,
		string	$a_schema_version
	)

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

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

◆ getXmlRecord()

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

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

References ilObject\_lookupObjId().

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

Here is the call graph for this function:

◆ readData()

ilItemGroupDataSet::readData	(	string	$a_entity,
		string	$a_version,
		array	$a_ids
	)

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

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

                                                                                : void
     {
         $ilDB = $this->db;
 
         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;
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $current_obj

ilObjItemGroup ilItemGroupDataSet::$current_obj

protected

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

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

Modules/ItemGroup/classes/class.ilItemGroupDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ getXmlRecord()

◆ readData()

Field Documentation

◆ $current_obj