ilGlossaryDataSet Class Reference

Glossary Data set class. More...

Inheritance diagram for ilGlossaryDataSet:

Collaboration diagram for ilGlossaryDataSet:

Public Member Functions
	__construct ()
	Constructor. More...
	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...
	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 ...> ... 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...

Protected Attributes
	$log
Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

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

Detailed Description

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

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilGlossaryDataSet::__construct

(

)

Constructor.

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

References ilLoggerFactory\getLogger().

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

Here is the call graph for this function:

Member Function Documentation

getDependencies()

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

protected

Determine the dependent sets of data.

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

References array.

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

                        case "glo_term":
                                return array (
                                        "glo_definition" => array("ids" => $a_rec["Id"])
                                );
                }

                return false;
        }

getSupportedVersions()

ilGlossaryDataSet::getSupportedVersions

(

)

Get supported versions.

Returns

string version

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

References array.

        {
                return array("5.1.0");
        }

getTypes()

ilGlossaryDataSet::getTypes (   $a_entity,   $a_version  )

protected

Get field types for entity.

Parameters

string	$a_entity	entity
string	$a_version	version number

Returns

array types array

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

References array.

        {
                if ($a_entity == "glo")
                {
                        switch ($a_version)
                        {
                                case "5.1.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":
                                        return array(
                                                "Id" => "integer",
                                                "GloId" => "integer",
                                                "Term" => "text",
                                                "Language" => "text",
                                                "ImportId" => "text"
                                        );
                        }
                }

                if ($a_entity == "glo_definition")
                {
                        switch ($a_version)
                        {
                                case "5.1.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":
                                        return array(
                                                "GloId" => "integer",
                                                "FieldId" => "text",
                                                "OrderNr" => "integer"
                                        );
                        }
                }

        }

getXmlNamespace()

ilGlossaryDataSet::getXmlNamespace	(		$a_entity,
			$a_schema_version
	)

Get xml namespace.

Parameters

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

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

importRecord()

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

Import record.

Parameters

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

References ilDataSet\getCurrentInstallationId(), and ilObjectFactory\getInstanceByObjId().

        {
                switch ($a_entity)
                {
                        case "glo":

                                include_once("./Modules/Glossary/classes/class.ilObjGlossary.php");
                                if($new_id = $a_mapping->getMapping('Services/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($a_rec["SnippetLength"]);
                                $newObj->setActiveGlossaryMenu($a_rec["GloMenuActive"]);
                                $newObj->setShowTaxonomy($a_rec["ShowTax"]);
                                $newObj->update(true);

                                $this->current_obj = $newObj;
                                $this->old_glo_id = $a_rec["Id"];
                                $a_mapping->addMapping("Modules/Glossary", "glo", $a_rec["Id"], $newObj->getId());
                                $a_mapping->addMapping("Services/Object", "obj", $a_rec["Id"], $newObj->getId());
                                $a_mapping->addMapping("Services/MetaData", "md",
                                        $a_rec["Id"].":0:glo", $newObj->getId().":0:glo");
                                $a_mapping->addMapping("Services/AdvancedMetaData", "parent", $a_rec["Id"], $newObj->getId());
                                break;

                        case "glo_term":

                                // id, glo_id, term, language, import_id

                                include_once("./Modules/Glossary/classes/class.ilGlossaryTerm.php");
                                $glo_id = (int) $a_mapping->getMapping("Modules/Glossary", "glo", $a_rec["GloId"]);
                                $term = new ilGlossaryTerm();
                                $term->setGlossaryId($glo_id);
                                $term->setTerm($a_rec["Term"]);
                                $term->setLanguage($a_rec["Language"]);
                                if ($this->getCurrentInstallationId() > 0)
                                {
                                        $term->setImportId("il_".$this->getCurrentInstallationId()."_git_".$a_rec["Id"]);
                                }
                                $term->create();
                                $term_id = $term->getId();
                                $this->log->debug("glo_term, import id: ".$term->getImportId().", term id: ".$term_id);

                                $a_mapping->addMapping("Modules/Glossary", "term",
                                        $a_rec["Id"], $term_id);

                                $a_mapping->addMapping("Services/Taxonomy", "tax_item",
                                        "glo:term:".$a_rec["Id"], $term_id);

                                $a_mapping->addMapping("Services/Taxonomy", "tax_item_obj_id",
                                        "glo:term:".$a_rec["Id"], $glo_id);

                                $a_mapping->addMapping("Services/AdvancedMetaData", "advmd_sub_item",
                                        "advmd:term:".$a_rec["Id"], $term_id);
                                break;

                        case "glo_definition":

                                // id, term_id, short_text, nr, short_text_dirty

                                include_once("./Modules/Glossary/classes/class.ilGlossaryDefinition.php");
                                $term_id = (int) $a_mapping->getMapping("Modules/Glossary", "term", $a_rec["TermId"]);
                                if ((int) $term_id == 0)
                                {
                                        $this->log->debug("ERROR: Did not find glossary term glo_term id '".$a_rec["TermId"]."' for definition id '".$a_rec["Id"]."'.");
                                }
                                else
                                {
                                        $def = new ilGlossaryDefinition();
                                        $def->setTermId($term_id);
                                        $def->setShortText($a_rec["ShortText"]);
                                        $def->setNr($a_rec["Nr"]);
                                        $def->setShortTextDirty($a_rec["ShortTextDirty"]);
                                        // no metadata, no page creation
                                        $def->create(true, true);

                                        $a_mapping->addMapping("Modules/Glossary", "def", $a_rec["Id"], $def->getId());
                                        $a_mapping->addMapping("Services/COPage", "pg", "gdf:" . $a_rec["Id"],
                                                "gdf:" . $def->getId());
                                        $a_mapping->addMapping("Services/MetaData", "md",
                                                $this->old_glo_id . ":" . $a_rec["Id"] . ":gdf", $this->current_obj->getId() . ":" . $def->getId() . ":gdf");
                                }
                                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("Modules/Glossary", "advmd_col_order", $a_rec["GloId"].":".$a_rec["FieldId"], $a_rec["OrderNr"]);
                                break;
                }
        }

Here is the call graph for this function:

readData()

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

Read data.

Parameters

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

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

        {
                global $ilDB;

                if (!is_array($a_ids))
                {
                        $a_ids = array($a_ids);
                }
                                
                if ($a_entity == "glo")
                {
                        switch ($a_version)
                        {
                                case "5.1.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":
                                        // todo: how does import id needs to be set?
                                        $this->getDirectDataFromQuery("SELECT id, glo_id, term, language".
                                                " FROM glossary_term ".
                                                " WHERE ".$ilDB->in("glo_id", $a_ids, false, "integer"));
                                        break;
                        }
                }

                if ($a_entity == "glo_definition")
                {
                        switch ($a_version)
                        {
                                case "5.1.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":
                                        $this->getDirectDataFromQuery("SELECT glo_id, field_id, order_nr".
                                                " FROM glo_advmd_col_order ".
                                                " WHERE ".$ilDB->in("glo_id", $a_ids, false, "integer"));
                                        break;
                        }
                }
        }

Here is the call graph for this function:

Field Documentation

$log

ilGlossaryDataSet::$log

protected

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

---

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

• Modules/Glossary/classes/class.ilGlossaryDataSet.php