ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Public Member Functions | Protected Member Functions | Protected Attributes
ilItemGroupDataSet 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 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)
 Read data from DB. More...
 
 getXmlRecord (string $a_entity, string $a_version, array $a_set)
 Get xml record for version. More...
 
- 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)
 

Protected Member Functions

 getTypes (string $a_entity, string $a_version)
 Get (abstract) types for (abstract) field names. More...
 
 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)
 
 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=[])
 

Protected Attributes

ilObjItemGroup $current_obj
 
- 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
 

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
 

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

Reimplemented from ilDataSet.

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

117 : array {
118 switch ($a_entity) {
119 case "itgr":
120 return array(
121 "itgr_item" => array("ids" => $a_rec["Id"] ?? [])
122 );
123 }
124
125 return [];
126 }

◆ getSupportedVersions()

ilItemGroupDataSet::getSupportedVersions ( )

Reimplemented from ilDataSet.

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

27 : array
28 {
29 return array("4.3.0", "5.3.0");
30 }

◆ getTypes()

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

Get (abstract) types for (abstract) field names.

Please note that the abstract fields/types only depend on the version! Not on a choosen representation!

Returns
array types array, e.g. array("field_1" => "text", "field_2" => "integer", ...)

Reimplemented from ilDataSet.

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

37 : array
38 {
39 if ($a_entity == "itgr") {
40 switch ($a_version) {
41 case "4.3.0":
42 return array(
43 "Id" => "integer",
44 "Title" => "text",
45 "Description" => "text");
46 case "5.3.0":
47 return array(
48 "Id" => "integer",
49 "HideTitle" => "integer",
50 "Behaviour" => "integer",
51 "Title" => "text",
52 "Description" => "text");
53 }
54 }
55
56 if ($a_entity == "itgr_item") {
57 switch ($a_version) {
58 case "4.3.0":
59 case "5.3.0":
60 return array(
61 "ItemGroupId" => "integer",
62 "ItemId" => "text"
63 );
64 }
65 }
66 return [];
67 }

◆ getXmlNamespace()

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

Reimplemented from ilDataSet.

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

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

◆ getXmlRecord()

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

Get xml record for version.

Parameters
array$a_setabstract data record

Reimplemented from ilDataSet.

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

103 : array
104 {
105 if ($a_entity == "itgr_item") {
106 // make ref id an object id
107 $a_set["ItemId"] = ilObject::_lookupObjId($a_set["ItemId"]);
108 }
109 return $a_set;
110 }
ilObject\_lookupObjId
static _lookupObjId(int $ref_id)
Definition: class.ilObject.php:940

References ilObject\_lookupObjId().

+ Here is the call graph for this function:

◆ readData()

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

Read data from DB.

This should result in the abstract field structure of the version set in the constructor.

Reimplemented from ilDataSet.

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

69 : void
70 {
71 $ilDB = $this->db;
72
73 if ($a_entity == "itgr") {
74 switch ($a_version) {
75 case "4.3.0":
76 $this->getDirectDataFromQuery("SELECT obj_id id, title, description " .
77 " FROM object_data " .
78 "WHERE " .
79 $ilDB->in("obj_id", $a_ids, false, "integer"));
80 break;
81 case "5.3.0":
82 $this->getDirectDataFromQuery("SELECT obj_id id, title, description, hide_title, behaviour " .
83 " FROM object_data JOIN itgr_data ON (object_data.obj_id = itgr_data.id)" .
84 "WHERE " .
85 $ilDB->in("obj_id", $a_ids, false, "integer"));
86 break;
87 }
88 }
89
90 if ($a_entity == "itgr_item") {
91 switch ($a_version) {
92 case "4.3.0":
93 case "5.3.0":
94 $this->getDirectDataFromQuery($q = "SELECT item_group_id itgr_id, item_ref_id item_id" .
95 " FROM item_group_item " .
96 "WHERE " .
97 $ilDB->in("item_group_id", $a_ids, false, "integer"));
98 break;
99 }
100 }
101 }
ilDataSet\getDirectDataFromQuery
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 ...
Definition: class.ilDataSet.php:158
ilDataSet\$db
ilDBInterface $db
Definition: class.ilDataSet.php:59
$q
$q
Definition: shib_logout.php:23

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

+ 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: