ilHelpDataSet Class Reference

Help system data set class. More...

Inheritance diagram for ilHelpDataSet:

Collaboration diagram for ilHelpDataSet:

Public Member Functions
	getSupportedVersions ()
	Get supported versions.
	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace.
	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data.
	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record.
Public Member Functions inherited from ilDataSet
	__construct ()
	Constructor.
	init ($a_entity, $a_schema_version)
	Init.
	readData ($a_entity, $a_version, $a_ids)
	Read data from DB.
	setExportDirectories ($a_relative, $a_absolute)
	Set export directories.
	setImportDirectory ($a_val)
	Set import directory.
	getImportDirectory ()
	Get import directory.
	setDSPrefix ($a_val)
	Set XML dataset namespace prefix.
	getDSPrefix ()
	Get XML dataset namespace prefix.
	getDSPrefixString ()
	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields.
	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string.
	getJsonRepresentation ()
	Get json representation.
	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 ...> ...
	addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
	Add records xml.
	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record.
	getNamespaces (&$namespaces, $a_entity, $a_schema_version)
	Get xml namespaces.
	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version.
	getJsonRecord ($a_set)
	Get json record for version.
	getXmlTypes ($a_entity, $a_version)
	Get xml types.
	getJsonTypes ($a_entity, $a_version)
	Get json types.
	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten)
	getXMLEntityTag ($a_entity, $a_schema_version)
	Get entity tag.
	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten)
	setImport ($a_val)
	Set import object.
	getImport ()
	Get import object.

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity.
	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data.
Protected Member Functions inherited from ilDataSet
	createObjectExportId ($a_type, $a_id)
	Build ilias export id.
	parseObjectExportId ($a_id, $a_fallback_id=NULL)
	Parse export 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

Help system data set class.

Author

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

Version

$Id$

Definition at line 14 of file class.ilHelpDataSet.php.

Member Function Documentation

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

protected

Determine the dependent sets of data.

Definition at line 121 of file class.ilHelpDataSet.php.

        {
                return false;
        }

ilHelpDataSet::getSupportedVersions

(

)

Get supported versions.

Parameters

@return

Reimplemented from ilDataSet.

Definition at line 22 of file class.ilHelpDataSet.php.

        {
                return array("4.3.0");
        }

ilHelpDataSet::getTypes (   $a_entity,   $a_version  )

protected

Get field types for entity.

Parameters

@return

Reimplemented from ilDataSet.

Definition at line 44 of file class.ilHelpDataSet.php.

        {
                if ($a_entity == "help_map")
                {
                        switch ($a_version)
                        {
                                case "4.3.0":
                                        return array(
                                                "Chap" => "integer",
                                                "Component" => "text",
                                                "ScreenId" => "text",
                                                "ScreenSubId" => "text",
                                                "Perm" => "text"
                                        );
                        }
                }

                if ($a_entity == "help_tooltip")
                {
                        switch ($a_version)
                        {
                                case "4.3.0":
                                        return array(
                                                "Id" => "integer",
                                                "TtText" => "text",
                                                "TtId" => "text",
                                                "Comp" => "text",
                                                "Lang" => "text"
                                        );
                        }
                }

        }

ilHelpDataSet::getXmlNamespace	(		$a_entity,
			$a_schema_version
	)

Get xml namespace.

Parameters

@return

Reimplemented from ilDataSet.

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

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

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

Import record.

Parameters

@return

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

References ilHelp\addTooltip(), and ilHelpMapping\saveMappingEntry().

        {
                switch ($a_entity)
                {
                        case "help_map":
                                
                                include_once("./Services/Help/classes/class.ilHelpMapping.php");
                                
                                // without module ID we do nothing
                                $module_id = $a_mapping->getMapping('Services/Help','help_module', 0);
                                if ($module_id)
                                {
                                        $new_chap = $a_mapping->getMapping('Services/Help', 'help_chap',
                                                $a_rec["Chap"]);

                                        if ($new_chap > 0)
                                        {
                                                ilHelpMapping::saveMappingEntry($new_chap,
                                                        $a_rec["Component"],
                                                        $a_rec["ScreenId"],
                                                        $a_rec["ScreenSubId"],
                                                        $a_rec["Perm"],
                                                        $module_id
                                                        );
                                        }
                                }
                                break;
                                
                        case "help_tooltip":
                                
                                include_once("./Services/Help/classes/class.ilHelp.php");
                                
                                // without module ID we do nothing
                                $module_id = $a_mapping->getMapping('Services/Help','help_module',0);
                                if ($module_id)
                                {
                                        ilHelp::addTooltip($a_rec["TtId"], $a_rec["TtText"], $module_id);
                                }
                                break;
                }
        }

Here is the call graph for this function:

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

Read data.

Parameters

@return

Definition at line 84 of file class.ilHelpDataSet.php.

References ilDataSet\getDirectDataFromQuery().

        {
                global $ilDB;

                if (!is_array($a_ids))
                {
                        $a_ids = array($a_ids);
                }
                                
                if ($a_entity == "help_map")
                {
                        switch ($a_version)
                        {
                                case "4.3.0":
                                        $this->getDirectDataFromQuery("SELECT chap, component, screen_id, screen_sub_id, perm ".
                                                " FROM help_map ".
                                                "WHERE ".
                                                $ilDB->in("chap", $a_ids, false, "integer"));
                                        break;
                        }
                }
                
                if ($a_entity == "help_tooltip")
                {
                        switch ($a_version)
                        {
                                case "4.3.0":
                                        $this->getDirectDataFromQuery("SELECT id, tt_text, tt_id, comp, lang FROM help_tooltip");
                                        break;
                        }
                }

        }

Here is the call graph for this function:

---

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

• Services/Help/classes/class.ilHelpDataSet.php