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

Inheritance diagram for ilGlossaryDataSet:

Collaboration diagram for ilGlossaryDataSet:

Public Member Functions
	__construct ()

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

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

	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
int	$old_glo_id

ilObjGlossary	$current_obj

array	$used_term_ids = []

ilLogger	$log

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 Glossary Data set class

This class implements the following entities:

glo: data from glossary
glo_term: data from glossary_term
glo_definition: data from glossary_definition
glo_advmd_col_order: ordering md fields
glo_auto_glossaries: automatically linked glossaries
Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilGlossaryDataSet::__construct ( )

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ilLoggerFactory\getLogger().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->log = ilLoggerFactory::getLogger('glo');
         parent::__construct();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDependencies()

ilGlossaryDataSet::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 242 of file class.ilGlossaryDataSet.php.

References null.

      : array {
         switch ($a_entity) {
             case "glo":
                 return array(
                     "glo_term" => array("ids" => $a_rec["Id"] ?? null),
                     "glo_advmd_col_order" => array("ids" => $a_rec["Id"] ?? null),
                     "glo_auto_glossaries" => array("ids" => $a_rec["Id"] ?? null)
                 );
         }
 
         return [];
     }

◆ getSupportedVersions()

ilGlossaryDataSet::getSupportedVersions ( )

Definition at line 46 of file class.ilGlossaryDataSet.php.

                                           : array
     {
         return array("5.1.0", "5.4.0", "9.0.0");
     }

◆ getTypes()

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

protected

Definition at line 56 of file class.ilGlossaryDataSet.php.

                                                                     : array
     {
         if ($a_entity == "glo") {
             switch ($a_version) {
                 case "5.1.0":
                 case "5.4.0":
                 case "9.0.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "Virtual" => "text",
                         "PresMode" => "text",
                         "SnippetLength" => "integer",
                         "GloMenuActive" => "text",
                         "ShowTax" => "integer"
                     );
             }
         }
 
         if ($a_entity == "glo_term") {
             switch ($a_version) {
                 case "5.1.0":
                 case "5.4.0":
                 case "9.0.0":
                     return array(
                         "Id" => "integer",
                         "GloId" => "integer",
                         "Term" => "text",
                         "Language" => "text",
                         "ImportId" => "text",
                         "ShortText" => "text",
                         "ShortTextDirty" => "text"
                     );
             }
         }
 
         if ($a_entity == "glo_definition") {
             switch ($a_version) {
                 case "5.1.0":
                 case "5.4.0":
                     return array(
                         "Id" => "integer",
                         "TermId" => "integer",
                         "ShortText" => "text",
                         "Nr" => "integer",
                         "ShortTextDirty" => "integer"
                     );
             }
         }
 
         if ($a_entity == "glo_advmd_col_order") {
             switch ($a_version) {
                 case "5.1.0":
                 case "5.4.0":
                 case "9.0.0":
                     return array(
                         "GloId" => "integer",
                         "FieldId" => "text",
                         "OrderNr" => "integer"
                     );
             }
         }
 
         if ($a_entity == "glo_auto_glossaries") {
             switch ($a_version) {
                 case "5.4.0":
                 case "9.0.0":
                     return array(
                         "GloId" => "integer",
                         "AutoGloId" => "text"
                     );
             }
         }
         return [];
     }

◆ getXmlNamespace()

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

protected

Definition at line 51 of file class.ilGlossaryDataSet.php.

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

◆ importRecord()

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

Definition at line 261 of file class.ilGlossaryDataSet.php.

References ilObject\_lookupObjIdByImportId(), ilObject\_lookupType(), ilImportMapping\addMapping(), ilDataSet\getCurrentInstallationId(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ILIAS\Repository\int(), and ilDataSet\stripTags().

      : void {
         $a_rec = $this->stripTags($a_rec);
         switch ($a_entity) {
             case "glo":
 
                 if ($new_id = $a_mapping->getMapping('components/ILIAS/Container', 'objs', $a_rec['Id'])) {
                     $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                 } else {
                     $newObj = new ilObjGlossary();
                     $newObj->create(true);
                 }
 
                 $newObj->setTitle($a_rec["Title"]);
                 $newObj->setDescription($a_rec["Description"]);
                 $newObj->setVirtualMode($a_rec["Virtual"]);
                 $newObj->setPresentationMode($a_rec["PresMode"]);
                 $newObj->setSnippetLength((int) ($a_rec["SnippetLength"] ?? 0));
                 $newObj->setActiveGlossaryMenu((bool) ($a_rec["GloMenuActive"] ?? false));
                 $newObj->setShowTaxonomy((bool) ($a_rec["ShowTax"] ?? false));
                 $newObj->setActiveFlashcards((bool) ($a_rec["FlashActive"] ?? false));
                 $newObj->setFlashcardsMode($a_rec["FlashMode"] ?? "");
                 if ($this->getCurrentInstallationId() > 0) {
                     $newObj->setImportId("il_" . $this->getCurrentInstallationId() . "_glo_" . $a_rec["Id"]);
                 }
                 $newObj->update();
 
                 $this->current_obj = $newObj;
                 $this->old_glo_id = $a_rec["Id"];
                 $a_mapping->addMapping("components/ILIAS/Glossary", "glo", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping("components/ILIAS/ILIASObject", "obj", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping(
                     "components/ILIAS/MetaData",
                     "md",
                     $a_rec["Id"] . ":0:glo",
                     $newObj->getId() . ":0:glo"
                 );
                 $a_mapping->addMapping("components/ILIAS/AdvancedMetaData", "parent", $a_rec["Id"], $newObj->getId());
                 break;
 
             case "glo_definition":
 
                 // note: this must be kept for older glossaries <= 8
 
                 $term_id = (int) $a_mapping->getMapping("Modules/Glossary", "term", $a_rec["TermId"]);
                 if ($term_id == 0) {
                     $this->log->debug("ERROR: Did not find glossary term glo_term id '" . $a_rec["TermId"] . "' for definition id '" . $a_rec["Id"] . "'.");
                 } elseif (!in_array($term_id, $this->used_term_ids)) {
                     $a_mapping->addMapping(
                         "Services/COPage",
                         "pg",
                         "gdf:" . $a_rec["Id"],
                         "term:" . $term_id
                     );
                     // use only first definition for term, because multiple definitons are abandoned since ILIAS 9
                     $this->used_term_ids[] = $term_id;
                 }
                 break;
 
             case "glo_term":
 
                 // id, glo_id, term, language, import_id, short_text, short_text_dirty
 
                 $glo_id = (int) $a_mapping->getMapping("components/ILIAS/Glossary", "glo", $a_rec["GloId"]);
                 $term = new ilGlossaryTerm();
                 $term->setGlossaryId($glo_id);
                 $term->setTerm($a_rec["Term"]);
                 $term->setLanguage($a_rec["Language"]);
                 $term->setShortText($a_rec["ShortText"] ?? "");
                 $term->setShortTextDirty($a_rec["ShortTextDirty"] ?? true);
                 if ($this->getCurrentInstallationId() > 0) {
                     $term->setImportId("il_" . $this->getCurrentInstallationId() . "_git_" . $a_rec["Id"]);
                 }
                 $term->create(true);
                 $term_id = $term->getId();
                 $this->log->debug("glo_term, import id: " . $term->getImportId() . ", term id: " . $term_id);
 
                 $a_mapping->addMapping(
                     "components/ILIAS/Glossary",
                     "term",
                     $a_rec["Id"],
                     $term_id
                 );
 
                 $a_mapping->addMapping(
                     "components/ILIAS/Taxonomy",
                     "tax_item",
                     "glo:term:" . $a_rec["Id"],
                     $term_id
                 );
 
                 $a_mapping->addMapping(
                     "components/ILIAS/Taxonomy",
                     "tax_item_obj_id",
                     "glo:term:" . $a_rec["Id"],
                     $glo_id
                 );
 
                 $a_mapping->addMapping(
                     "components/ILIAS/AdvancedMetaData",
                     "advmd_sub_item",
                     "advmd:term:" . $a_rec["Id"],
                     $term_id
                 );
 
                 $a_mapping->addMapping(
                     "components/ILIAS/COPage",
                     "pg",
                     "term:" . $a_rec["Id"],
                     "term:" . $term_id
                 );
                 break;
 
             case "glo_advmd_col_order":
                 // glo_id, field_id, order_nr
                 // we save the ordering in the mapping, the glossary importer needs to fix this in the final
                 // processing
                 $a_mapping->addMapping("components/ILIAS/Glossary", "advmd_col_order", $a_rec["GloId"] . ":" . $a_rec["FieldId"], $a_rec["OrderNr"]);
                 break;
 
             case "glo_auto_glossaries":
                 $auto_glo_id = ilObject::_lookupObjIdByImportId($a_rec["AutoGloId"]);
                 $glo_id = (int) $a_mapping->getMapping("components/ILIAS/Glossary", "glo", $a_rec["GloId"]);
                 if ($glo_id > 0 && $auto_glo_id > 0 && ilObject::_lookupType($auto_glo_id) == "glo") {
                     $glo = new ilObjGlossary($glo_id, false);
                     $glo->addAutoGlossary($auto_glo_id);
                     $glo->updateAutoGlossaries();
                 }
                 break;
         }
     }

Here is the call graph for this function:

◆ readData()

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

Definition at line 133 of file class.ilGlossaryDataSet.php.

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

                                                                                : void
     {
         $ilDB = $this->db;
 
         if ($a_entity == "glo") {
             switch ($a_version) {
                 case "5.1.0":
                 case "5.4.0":
                 case "9.0.0":
                     $this->getDirectDataFromQuery("SELECT o.title, o.description, g.id, g.virtual, pres_mode, snippet_length, show_tax, glo_menu_active" .
                         " FROM glossary g JOIN object_data o " .
                         " ON (g.id = o.obj_id) " .
                         " WHERE " . $ilDB->in("g.id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "glo_term") {
             switch ($a_version) {
                 case "5.1.0":
                     $this->getDirectDataFromQuery("SELECT id, glo_id, term, language" .
                         " FROM glossary_term " .
                         " WHERE " . $ilDB->in("glo_id", $a_ids, false, "integer"));
                     break;
 
                 case "5.4.0":
                     $this->getDirectDataFromQuery("SELECT id, glo_id, term, language" .
                         " FROM glossary_term " .
                         " WHERE " . $ilDB->in("glo_id", $a_ids, false, "integer"));
 
                     $set = $ilDB->query("SELECT r.term_id, r.glo_id, t.term, t.language " .
                         "FROM glo_term_reference r JOIN glossary_term t ON (r.term_id = t.id) " .
                         " WHERE " . $ilDB->in("r.glo_id", $a_ids, false, "integer"));
                     while ($rec = $ilDB->fetchAssoc($set)) {
                         $this->data[] = [
                             "Id" => $rec["term_id"],
                             "GloId" => $rec["glo_id"],
                             "Term" => $rec["term"],
                             "Language" => $rec["language"],
                         ];
                     }
                     break;
                 case "9.0.0":
                     $this->getDirectDataFromQuery("SELECT id, glo_id, term, language" .
                         " FROM glossary_term " .
                         " WHERE " . $ilDB->in("glo_id", $a_ids, false, "integer"));
 
                     $set = $ilDB->query("SELECT r.term_id, r.glo_id, t.term, t.language, " .
                         "t.short_text, t.short_text_dirty " .
                         "FROM glo_term_reference r JOIN glossary_term t ON (r.term_id = t.id) " .
                         " WHERE " . $ilDB->in("r.glo_id", $a_ids, false, "integer"));
                     while ($rec = $ilDB->fetchAssoc($set)) {
                         $this->data[] = [
                             "Id" => $rec["term_id"],
                             "GloId" => $rec["glo_id"],
                             "Term" => $rec["term"],
                             "Language" => $rec["language"],
                             "ShortText" => $rec["short_text"],
                             "ShortTextDirty" => $rec["short_text_dirty"]
                         ];
                     }
                     break;
             }
         }
 
         if ($a_entity == "glo_definition") {
             switch ($a_version) {
                 case "5.1.0":
                 case "5.4.0":
                     $this->getDirectDataFromQuery("SELECT id, term_id, short_text, nr, short_text_dirty" .
                         " FROM glossary_definition " .
                         " WHERE " . $ilDB->in("term_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "glo_advmd_col_order") {
             switch ($a_version) {
                 case "5.1.0":
                 case "5.4.0":
                 case "9.0.0":
                     $this->getDirectDataFromQuery("SELECT glo_id, field_id, order_nr" .
                         " FROM glo_advmd_col_order " .
                         " WHERE " . $ilDB->in("glo_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "glo_auto_glossaries") {
             switch ($a_version) {
                 case "5.4.0":
                 case "9.0.0":
                     $set = $ilDB->query("SELECT * FROM glo_glossaries " .
                         " WHERE " . $ilDB->in("id", $a_ids, false, "integer"));
                     $this->data = [];
                     while ($rec = $ilDB->fetchAssoc($set)) {
                         $this->data[] = [
                             "GloId" => $rec["id"],
                             "AutoGloId" => "il_" . IL_INST_ID . "_glo_" . $rec["glo_id"]
                         ];
                     }
                     break;
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $current_obj

ilObjGlossary ilGlossaryDataSet::$current_obj

protected

Definition at line 33 of file class.ilGlossaryDataSet.php.

◆ $log

ilLogger ilGlossaryDataSet::$log

protected

Definition at line 35 of file class.ilGlossaryDataSet.php.

◆ $old_glo_id

int ilGlossaryDataSet::$old_glo_id

protected

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

◆ $used_term_ids

array ilGlossaryDataSet::$used_term_ids = []

protected

Definition at line 34 of file class.ilGlossaryDataSet.php.

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

components/ILIAS/Glossary/Export/class.ilGlossaryDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()

Field Documentation

◆ $current_obj

◆ $log

◆ $old_glo_id

◆ $used_term_ids