class.ilHelpDataSet.php

Go to the documentation of this file.

<?php

class ilHelpDataSet extends ilDataSet
{
    protected \ILIAS\Help\Tooltips\TooltipsManager $help_tooltips;
    protected \ILIAS\Help\Map\MapManager $help_map;

    public function __construct()
    {
        global $DIC;

        $help_domain = $DIC->help()->internal()->domain();

        parent::__construct();

        $this->help_map = $help_domain->map();
        $this->help_tooltips = $help_domain->tooltips();
    }

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

    protected function getXmlNamespace(string $a_entity, string $a_schema_version): string
    {
        return "https://www.ilias.de/xml/Services/Help/" . $a_entity;
    }

    protected function getTypes(string $a_entity, string $a_version): 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"
                    );
            }
        }
        return [];
    }

    public function readData(string $a_entity, string $a_version, array $a_ids): 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;
            }
        }
    }

    public function importRecord(
        string $a_entity,
        array $a_types,
        array $a_rec,
        ilImportMapping $a_mapping,
        string $a_schema_version
    ): 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;
        }
    }
}