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

Inheritance diagram for ilHelpDataSet:

Collaboration diagram for ilHelpDataSet:

Public Member Functions
	__construct ()

	getSupportedVersions ()

	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...

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

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 ...> ... </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 (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)
	Get (abstract) types for (abstract) field names. 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
ILIAS Help InternalDomainService	$help_domain

ILIAS Help InternalDataService	$help_data

ILIAS Help Tooltips TooltipsManager	$help_tooltips

ILIAS Help Map MapManager	$help_map

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

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

Constructor & Destructor Documentation

◆ __construct()

ilHelpDataSet::__construct ( )

Reimplemented from ilDataSet.

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

    {
        global $DIC;
 
        $this->help_domain = $DIC->help()->internal()->domain();
        $this->help_data = $DIC->help()->internal()->data();
 
        parent::__construct();
 
        $this->help_map = $this->help_domain->map();
        $this->help_tooltips = $this->help_domain->tooltips();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getSupportedVersions()

ilHelpDataSet::getSupportedVersions ( )

Reimplemented from ilDataSet.

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

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

◆ getTypes()

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

protected

Get (abstract) types for (abstract) field names.

Please note that the abstract fields/types only depend on the version! Not on a choosen representation!

Returns: array types array, e.g. array("field_1" => "text", "field_2" => "integer", ...)

Reimplemented from ilDataSet.

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

                                                                    : array
    {
        if ($a_entity === "help_map") {
            switch ($a_version) {
                case "4.3.0":
                    return array(
                        "Chap" => "integer",
                        "Component" => "text",
                        "ScreenId" => "text",
                        "ScreenSubId" => "text",
                        "Perm" => "text"
                    );
                case "10.0":
                    return array(
                        "Chap" => "integer",
                        "Component" => "text",
                        "ScreenId" => "text",
                        "ScreenSubId" => "text",
                        "Perm" => "text",
                        "FullId" => "text"
                    );
            }
        }
 
        if ($a_entity === "help_tooltip") {
            switch ($a_version) {
                case "4.3.0":
                case "10.0":
                    return array(
                        "Id" => "integer",
                        "TtText" => "text",
                        "TtId" => "text",
                        "Comp" => "text",
                        "Lang" => "text"
                    );
            }
        }
 
        if ($a_entity === "gdtr") {
            switch ($a_version) {
                case "10.0":
                    return [
                        "ObjId" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Permission" => "integer",
                        "ScreenIds" => "text",
                        "Lang" => "text"
                    ];
            }
        }
 
        if ($a_entity === "gdtr_step") {
            switch ($a_version) {
                case "10.0":
                    return [
                        "Id" => "integer",
                        "TourId" => "integer",
                        "OrderNr" => "integer",
                        "Type" => "integer",
                        "ElementId" => "text"
                    ];
            }
        }
 
        return [];
    }

◆ getXmlNamespace()

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

protected

Reimplemented from ilDataSet.

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

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

◆ importRecord()

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

Reimplemented from ilDataSet.

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

     : void {
        $a_rec = $this->stripTags($a_rec);
        switch ($a_entity) {
            case "help_map":
 
                // without module ID we do nothing
                $module_id = $a_mapping->getMapping('components/ILIAS/Help', 'help_module', 0);
                $t = $a_mapping->getAllMappings();
                if ($module_id) {
                    $new_chap = $a_mapping->getMapping(
                        'components/ILIAS/Help',
                        'help_chap',
                        $a_rec["Chap"]
                    );
 
                    // new import (5.1): get chapter from learning module import mapping
                    if ((int) $new_chap === 0) {
                        $new_chap = $a_mapping->getMapping(
                            'components/ILIAS/LearningModule',
                            'lm_tree',
                            $a_rec["Chap"]
                        );
                    }
 
                    if ($new_chap > 0) {
                        $this->help_map->saveMappingEntry(
                            $new_chap,
                            $a_rec["Component"],
                            $a_rec["ScreenId"],
                            $a_rec["ScreenSubId"],
                            $a_rec["Perm"],
                            $module_id,
                            $a_rec["FullId"] ?? ""
                        );
                    }
                }
                break;
 
            case "help_tooltip":
 
                // without module ID we do nothing
                $module_id = $a_mapping->getMapping('components/ILIAS/Help', 'help_module', 0);
                if ($module_id) {
                    $this->help_tooltips->addTooltip($a_rec["TtId"], $a_rec["TtText"], $module_id);
                }
                break;
 
            case "gdtr":
                $newObj = new ilObjGuidedTour();
                $newObj->create(0, true);
 
                $newObj->setTitle($a_rec["Title"]);
                $newObj->setDescription($a_rec["Description"]);
                $newObj->update(true);
 
                //$this->current_obj = $newObj;
                $a_mapping->addMapping("components/ILIAS/Help", "gdtr", $a_rec["ObjId"], $newObj->getId());
                $a_mapping->addMapping("components/ILIAS/ILIASObject", "obj", $a_rec["ObjId"], $newObj->getId());
 
                $this->help_domain->guidedTour()->tourSettings()->save(
                    $this->help_data->guidedTour()->settings(
                        $newObj->getId(),
                        false,
                        $a_rec["ScreenIds"],
                        \ILIAS\Help\GuidedTour\Settings\PermissionType::from((int) $a_rec["Permission"]),
                        $a_rec["Lang"],
                    )
                );
                break;
 
            case "gdtr_step":
                $tour_id = (int) $a_mapping->getMapping("components/ILIAS/Help", "gdtr", $a_rec["TourId"]);
                if ($tour_id > 0) {
                    $step_id = $this->help_domain->guidedTour()->step()->create(
                        $this->help_data->guidedTour()->step(
                            0,
                            $tour_id,
                            (int) $a_rec["OrderNr"],
                            \ILIAS\Help\GuidedTour\Step\StepType::from((int) $a_rec["Type"]),
                            $a_rec["ElementId"],
                        )
                    );
                    $a_mapping->addMapping(
                        "components/ILIAS/COPage",
                        "pg",
                        "gdtr:" . $a_rec["Id"],
                        "gdtr:" . $step_id
                    );
                }
                break;
        }
    }

References ilImportMapping\addMapping(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), ilImportMapping\getAllMappings(), ilImportMapping\getMapping(), and ILIAS\Repository\int().

Here is the call graph for this function:

◆ readData()

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

Read data from DB.

This should result in the abstract field structure of the version set in the constructor.

Reimplemented from ilDataSet.

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

                                                                               : void
    {
        $ilDB = $this->db;
 
        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;
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT chap, component, screen_id, screen_sub_id, perm, full_id " .
                        " FROM help_map " .
                        "WHERE " .
                        $ilDB->in("chap", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity === "help_tooltip") {
            switch ($a_version) {
                case "4.3.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT id, tt_text, tt_id, comp, lang FROM help_tooltip " .
                        " WHERE module_id = " . $ilDB->quote(0, "integer"));
                    break;
            }
        }
 
        if ($a_entity === "gdtr") {
            switch ($a_version) {
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT hs.obj_id, title, description, permission, screen_ids, lang " .
                        " FROM help_gt_settings hs JOIN object_data od ON (hs.obj_id = od.obj_id)" .
                        "WHERE " .
                        $ilDB->in("hs.obj_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity === "gdtr_step") {
            switch ($a_version) {
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT id, tour_id, order_nr, type, element_id " .
                        " FROM help_gt_step " .
                        "WHERE " .
                        $ilDB->in("id", $a_ids, false, "integer"));
                    break;
            }
        }
 
    }

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

Here is the call graph for this function:

Field Documentation

◆ $help_data

ILIAS Help InternalDataService ilHelpDataSet::$help_data

protected

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

◆ $help_domain

ILIAS Help InternalDomainService ilHelpDataSet::$help_domain

protected

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

◆ $help_map

ILIAS Help Map MapManager ilHelpDataSet::$help_map

protected

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

◆ $help_tooltips

ILIAS Help Tooltips TooltipsManager ilHelpDataSet::$help_tooltips

protected

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

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

components/ILIAS/Help/Export/class.ilHelpDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()

Field Documentation

◆ $help_data

◆ $help_domain

◆ $help_map

◆ $help_tooltips