Help system data set class. More...

Inheritance diagram for ilHelpDataSet:

Collaboration diagram for ilHelpDataSet:

Public Member Functions
	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 ...> ... </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 ($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...

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

Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

	$db

	$ds_log

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

◆ getDependencies()

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

protected

Determine the dependent sets of data.

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

    {
        return false;
    }

◆ getSupportedVersions()

ilHelpDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

return

Reimplemented from ilDataSet.

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

    {
        return array("4.3.0");
    }

◆ getTypes()

ilHelpDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 45 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"
                    );
            }
        }
    }

◆ getXmlNamespace()

ilHelpDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

return

Reimplemented from ilDataSet.

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

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

◆ importRecord()

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

Import record.

Parameters

return

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

    {
        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);
                $t = $a_mapping->getAllMappings();
                if ($module_id) {
                    $new_chap = $a_mapping->getMapping(
                        'Services/Help',
                        'help_chap',
                        $a_rec["Chap"]
                    );
 
                    // new import (5.1): get chapter from learning module import mapping
                    if ($new_chap == 0) {
                        $new_chap = $a_mapping->getMapping(
                            'Modules/LearningModule',
                            'lm_tree',
                            $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;
        }
    }

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

Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

return

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

    {
        $ilDB = $this->db;
 
        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;
            }
        }
    }

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()