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

Inheritance diagram for ilTaxonomyDataSet:

Collaboration diagram for ilTaxonomyDataSet:

Public Member Functions
	getSupportedVersions ()

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

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)

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

	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)

Protected Member Functions
	getXmlNamespace (string $a_entity, string $a_schema_version)

	getTypes (string $a_entity, string $a_version)

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_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=[])

Protected Attributes
ilObjTaxonomy	$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	$relative_export_dir = ""

string	$absolute_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

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 Taxonomy data set class This class implements the following entities:

tax: data from table tax_data/object_data
tax_usage: data from table tax_usage
tax_tree: data from a join on tax_tree and tax_node
tax_node_assignment: data from table tax_node_assignment
Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 28 of file class.ilTaxonomyDataSet.php.

Member Function Documentation

◆ getDependencies()

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

protected

Determine the dependent sets of data.

Definition at line 168 of file class.ilTaxonomyDataSet.php.

      : array {
         switch ($a_entity) {
             case "tax":
                 return array(
                     "tax_tree" => array("ids" => $a_rec["Id"] ?? null),
                     "tax_usage" => array("ids" => $a_rec["Id"] ?? null)
                 );
             case "tax_tree":
                 return array(
                     "tax_node_assignment" => array("ids" => $a_rec["Child"] ?? null)
                 );
         }
         return [];
     }

◆ getSupportedVersions()

ilTaxonomyDataSet::getSupportedVersions ( )

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

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

◆ getTypes()

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

protected

Definition at line 45 of file class.ilTaxonomyDataSet.php.

                                                                     : array
     {
         // tax
         if ($a_entity == "tax") {
             switch ($a_version) {
                 case "4.3.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "SortingMode" => "integer"
                     );
             }
         }
 
         // tax_usage
         if ($a_entity == "tax_usage") {
             switch ($a_version) {
                 case "4.3.0":
                     return array(
                         "TaxId" => "integer",
                         "ObjId" => "integer"
                     );
             }
         }
 
         // tax_tree
         if ($a_entity == "tax_tree") {
             switch ($a_version) {
                 case "4.3.0":
                     return array(
                         "TaxId" => "integer",
                         "Child" => "integer",
                         "Parent" => "integer",
                         "Depth" => "integer",
                         "Type" => "text",
                         "Title" => "text",
                         "OrderNr" => "integer"
                     );
             }
         }
 
         // tax_node_assignment
         if ($a_entity == "tax_node_assignment") {
             switch ($a_version) {
                 case "4.3.0":
                     return array(
                         "NodeId" => "integer",
                         "Component" => "text",
                         "ItemType" => "text",
                         "ItemId" => "integer"
                     );
             }
         }
         return [];
     }

◆ getXmlNamespace()

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

protected

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

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

◆ importRecord()

ilTaxonomyDataSet::importRecord	(	string	$a_entity,
		array	$a_types,
		array	$a_rec,
		ilImportMapping	$a_mapping,
		string	$a_schema_version
	)

Definition at line 192 of file class.ilTaxonomyDataSet.php.

References ilTaxNodeAssignment\addAssignment(), ilImportMapping\addMapping(), ilImportMapping\getMapping(), ILIAS\Repository\int(), ilTaxonomyNode\putInTree(), and ilDataSet\stripTags().

      : void {
         $a_rec = $this->stripTags($a_rec);
         switch ($a_entity) {
             case "tax":
                 $newObj = new ilObjTaxonomy();
                 $newObj->create();
 
                 $newObj->setTitle($a_rec["Title"]);
                 $newObj->setDescription($a_rec["Description"]);
                 $newObj->setSortingMode((int) $a_rec["SortingMode"]);
                 $newObj->update();
 
                 $this->current_obj = $newObj;
                 $a_mapping->addMapping("Services/Taxonomy", "tax", $a_rec["Id"], $newObj->getId());
                 break;
 
             case "tax_tree":
                 switch ($a_rec["Type"]) {
                     case "taxn":
                         $parent = (int) $a_mapping->getMapping("Services/Taxonomy", "tax_tree", $a_rec["Parent"]);
                         $tax_id = $a_mapping->getMapping("Services/Taxonomy", "tax", $a_rec["TaxId"]);
                         if ($parent == 0) {
                             $parent = $this->current_obj->getTree()->readRootId();
                         }
                         $node = new ilTaxonomyNode();
                         $node->setTitle($a_rec["Title"]);
                         $node->setOrderNr((int) $a_rec["OrderNr"]);
                         $node->setTaxonomyId((int) $tax_id);
                         $node->create();
                         ilTaxonomyNode::putInTree((int) $tax_id, $node, (int) $parent, 0, (int) $a_rec["OrderNr"]);
                         $a_mapping->addMapping(
                             "Services/Taxonomy",
                             "tax_tree",
                             $a_rec["Child"],
                             $node->getId()
                         );
                         break;
                 }
 
                 // no break
             case "tax_node_assignment":
                 $new_item_id = (int) $a_mapping->getMapping(
                     "Services/Taxonomy",
                     "tax_item",
                     ($a_rec["Component"] ?? "") .
                     ":" . ($a_rec["ItemType"] ?? "") . ":" .
                     ($a_rec["ItemId"] ?? "")
                 );
                 $new_node_id = (int) $a_mapping->getMapping("Services/Taxonomy", "tax_tree", $a_rec["NodeId"] ?? "");
 
                 // this is needed since 4.4 (but not exported with 4.3)
                 // with 4.4 this should be part of export/import
                 $new_item_id_obj = (int) $a_mapping->getMapping(
                     "Services/Taxonomy",
                     "tax_item_obj_id",
                     ($a_rec["Component"] ?? "") .
                     ":" . ($a_rec["ItemType"] ?? "") . ":" .
                     ($a_rec["ItemId"] ?? "")
                 );
                 if ($new_item_id > 0 && $new_node_id > 0 && $new_item_id_obj > 0) {
                     $node_ass = new ilTaxNodeAssignment(
                         $a_rec["Component"],
                         $new_item_id_obj,
                         $a_rec["ItemType"],
                         $this->current_obj->getId()
                     );
                     $node_ass->addAssignment($new_node_id, $new_item_id);
                 }
                 break;
 
             case "tax_usage":
                 $usage = $a_mapping->getMapping("Services/Taxonomy", "tax_usage_of_obj", $a_rec["ObjId"]);
                 if ($usage != "") {
                     $usage .= ":";
                 }
                 $a_mapping->addMapping(
                     "Services/Taxonomy",
                     "tax_usage_of_obj",
                     $a_rec["ObjId"],
                     $usage . $this->current_obj->getId()
                 );
                 break;
         }
     }

Here is the call graph for this function:

◆ readData()

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

Definition at line 105 of file class.ilTaxonomyDataSet.php.

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

                                                                                : void
     {
         $ilDB = $this->db;
 
         if (!is_array($a_ids)) {
             $a_ids = array($a_ids);
         }
 
         // tax
         if ($a_entity == "tax") {
             switch ($a_version) {
                 case "4.3.0":
                     $this->getDirectDataFromQuery("SELECT id, title, description, " .
                         " sorting_mode" .
                         " FROM tax_data JOIN object_data ON (tax_data.id = object_data.obj_id) " .
                         "WHERE " .
                         $ilDB->in("id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         // tax usage
         if ($a_entity == "tax_usage") {
             switch ($a_version) {
                 case "4.3.0":
                     $this->getDirectDataFromQuery("SELECT tax_id, obj_id " .
                         " FROM tax_usage " .
                         "WHERE " .
                         $ilDB->in("tax_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         // tax_tree
         if ($a_entity == "tax_tree") {
             switch ($a_version) {
                 case "4.3.0":
                     $this->getDirectDataFromQuery("SELECT tax_id, child " .
                         " ,parent,depth,type,title,order_nr " .
                         " FROM tax_tree JOIN tax_node ON (child = obj_id) " .
                         " WHERE " .
                         $ilDB->in("tax_id", $a_ids, false, "integer") .
                         " ORDER BY depth");
                     break;
             }
         }
 
         // tax node assignment
         if ($a_entity == "tax_node_assignment") {
             switch ($a_version) {
                 case "4.3.0":
                     $this->getDirectDataFromQuery("SELECT node_id, component, item_type, item_id " .
                         " FROM tax_node_assignment " .
                         "WHERE " .
                         $ilDB->in("node_id", $a_ids, false, "integer"));
                     break;
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $current_obj

ilObjTaxonomy ilTaxonomyDataSet::$current_obj

protected

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

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

Services/Taxonomy/classes/class.ilTaxonomyDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()

Field Documentation

◆ $current_obj