class.ilECSNodeMappingLocalExplorer.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilECSNodeMappingLocalExplorer extends ilExplorer
{
    public const SEL_TYPE_CHECK = 1;
    public const SEL_TYPE_RADIO = 2;

    private array $checked_items = [];
    private string $post_var = '';
    private array $form_items = [];
    private int $type;

    private int $sid;
    private int $mid;

    private array $mappings = [];

    public function __construct(string $a_target, int $a_sid, int $a_mid)
    {
        parent::__construct($a_target);

        $this->sid = $a_sid;
        $this->mid = $a_mid;

        $this->type = self::SEL_TYPE_RADIO;

        $this->setRoot($this->tree->readRootId());
        $this->setOrderColumn('title');


        // reset filter
        $this->filter = array();

        $this->addFilter('root');
        $this->addFilter('cat');

        $this->addFormItemForType('root');
        $this->addFormItemForType('cat');

        $this->setFiltered(true);
        $this->setFilterMode(IL_FM_POSITIVE);

        $this->initMappings();
    }

    public function getSid(): int
    {
        return $this->sid;
    }

    public function getMid(): int
    {
        return $this->mid;
    }

    public function isClickable(string $type, int $ref_id = 0): bool
    {
        return false;
    }

    public function addFormItemForType($type): void
    {
        $this->form_items[$type] = true;
    }

    public function removeFormItemForType($type): void
    {
        $this->form_items[$type] = false;
    }

    public function setCheckedItems($a_checked_items = array()): void
    {
        $this->checked_items = $a_checked_items;
    }

    public function getCheckedItems(): array
    {
        return $this->checked_items;
    }

    public function isItemChecked(int $a_id): bool
    {
        return in_array($a_id, $this->checked_items, true);
    }

    public function setPostVar(string $a_post_var): void
    {
        $this->post_var = $a_post_var;
    }
    public function getPostVar(): string
    {
        return $this->post_var;
    }

    public function buildFormItem($a_node_id, string $a_type): string
    {
        if (!array_key_exists($a_type, $this->form_items) || !$this->form_items[$a_type]) {
            return '';
        }

        switch ($this->type) {
            case self::SEL_TYPE_CHECK:
                return ilLegacyFormElementsUtil::formCheckbox(
                    $this->isItemChecked($a_node_id),
                    $this->post_var,
                    (string) $a_node_id
                );
            case self::SEL_TYPE_RADIO:
                return ilLegacyFormElementsUtil::formRadioButton(
                    $this->isItemChecked($a_node_id),
                    $this->post_var,
                    (string) $a_node_id,
                    "document.getElementById('map').submit(); return false;"
                );
        }
        return '';
    }

    public function formatObject(ilTemplate $tpl, $a_node_id, array $a_option, $a_obj_id = 0): void
    {
        if (!isset($a_node_id) || !is_array($a_option)) {
            $this->error->raiseError(get_class($this) . "::formatObject(): Missing parameter or wrong datatype! " .
                                    "node_id: " . $a_node_id . " options:" . print_r($a_option, true), $this->error->WARNING);
        }

        $pic = false;
        foreach ($a_option["tab"] as $picture) {
            if ($picture === 'plus') {
                $tpl->setCurrentBlock("expander");
                $tpl->setVariable("EXP_DESC", $this->lng->txt("expand"));
                $this->setParamsGet([]);
                $target = $this->createTarget('+', $a_node_id);
                $tpl->setVariable("LINK_NAME", $a_node_id);
                $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                $tpl->setVariable("IMGPATH", $this->getImage("browser/plus.png"));
                $tpl->parseCurrentBlock();
                $pic = true;
            }

            if ($picture === 'minus' && $this->show_minus) {
                $tpl->setCurrentBlock("expander");
                $tpl->setVariable("EXP_DESC", $this->lng->txt("collapse"));
                $this->setParamsGet([]);
                $target = $this->createTarget('-', $a_node_id);
                $tpl->setVariable("LINK_NAME", $a_node_id);
                $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                $tpl->setVariable("IMGPATH", $this->getImage("browser/minus.png"));
                $tpl->parseCurrentBlock();
                $pic = true;
            }
        }

        if (!$pic) {
            $tpl->setCurrentBlock("blank");
            $tpl->setVariable("BLANK_PATH", $this->getImage("browser/blank.png"));
            $tpl->parseCurrentBlock();
        }

        if ($this->output_icons) {
            $tpl->setCurrentBlock("icon");
            $tpl->setVariable("ICON_IMAGE", $this->getImage("icon_" . $a_option["type"] . ".svg", $a_option["type"], $a_obj_id));

            $tpl->setVariable("TARGET_ID", "iconid_" . $a_node_id);
            $this->iconList[] = "iconid_" . $a_node_id;
            $tpl->setVariable("TXT_ALT_IMG", $this->lng->txt($a_option["desc"]));
            $tpl->parseCurrentBlock();
        }

        if (($formItem = $this->buildFormItem((int) $a_node_id, (string) $a_option['type'])) !== '') {
            $tpl->setCurrentBlock('check');
            $tpl->setVariable('OBJ_CHECK', $formItem);
            $tpl->parseCurrentBlock();
        }

        if ($this->isClickable($a_option["type"], (int) $a_node_id)) {  // output link
            $tpl->setCurrentBlock("link");
            //$target = (strpos($this->target, "?") === false) ?
            //  $this->target."?" : $this->target."&";
            //$tpl->setVariable("LINK_TARGET", $target.$this->target_get."=".$a_node_id.$this->params_get);
            $tpl->setVariable("LINK_TARGET", $this->buildLinkTarget($a_node_id, $a_option["type"]));

            $style_class = $this->getNodeStyleClass($a_node_id, $a_option["type"]);

            if ($style_class !== "") {
                $tpl->setVariable("A_CLASS", ' class="' . $style_class . '" ');
            }

            if (($onclick = $this->buildOnClick($a_node_id, $a_option["type"], $a_option["title"])) !== "") {
                $tpl->setVariable("ONCLICK", "onClick=\"$onclick\"");
            }

            $tpl->setVariable("LINK_NAME", $a_node_id);
            $tpl->setVariable(
                "TITLE",
                $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"])
            );
            $tpl->setVariable(
                "DESC",
                ilStr::shortenTextExtended(
                    $this->buildDescription($a_option["description"], $a_node_id, $a_option["type"]),
                    $this->textwidth,
                    true
                )
            );
            $frame_target = $this->buildFrameTarget($a_option["type"], $a_node_id, $a_option["obj_id"]);
            if ($frame_target !== "") {
                $tpl->setVariable("TARGET", " target=\"" . $frame_target . "\"");
            }
        } else {                        // output text only
            $tpl->setCurrentBlock("text");
            $tpl->setVariable(
                "OBJ_TITLE",
                $this->buildTitle($a_option["title"], $a_node_id, $a_option["type"])
            );
            $tpl->setVariable(
                "OBJ_DESC",
                ilStr::shortenTextExtended(
                    $this->buildDescription($a_option["desc"], $a_node_id, $a_option["type"]),
                    $this->textwidth,
                    true
                )
            );
        }
        $tpl->parseCurrentBlock();

        $tpl->setCurrentBlock("list_item");
        $tpl->parseCurrentBlock();
        $tpl->touchBlock("element");
    }



    public function formatHeader(ilTemplate $tpl, $a_obj_id, array $a_option): void
    {
        // custom icons
        $path = ilObject::_getIcon((int) $a_obj_id, "tiny", "root");


        $tpl->setCurrentBlock("icon");
        $nd = $this->tree->getNodeData(ROOT_FOLDER_ID);
        $title = $nd["title"];
        if ($title === "ILIAS") {
            $title = $this->lng->txt("repository");
        }

        $tpl->setVariable("ICON_IMAGE", $path);
        $tpl->setVariable("TXT_ALT_IMG", $title);
        $tpl->parseCurrentBlock();

        if (($formItem = $this->buildFormItem((int) $a_obj_id, (string) $a_option['type'])) !== '') {
            $tpl->setCurrentBlock('check');
            $tpl->setVariable('OBJ_CHECK', $formItem);
            $tpl->parseCurrentBlock();
        }

        if ($this->isMapped(ROOT_FOLDER_ID)) {
            $tpl->setVariable(
                'OBJ_TITLE',
                '<font style="font-weight: bold">' . $title . '</font>'
            );
        } else {
            $tpl->setVariable('OBJ_TITLE', $title);
        }
    }

    public function buildTitle(string $a_title, $a_id, string $a_type): string
    {
        if ($this->isMapped($a_id)) {
            return '<font style="font-weight: bold">' . $a_title . '</font>';
        }
        if ($this->hasParentMapping($a_id)) {
            return '<font style="font-style: italic">' . $a_title . '</font>';
        }
        return $a_title;
    }

    protected function initMappings(): bool
    {
        $mappings = array();
        foreach (ilECSCourseMappingRule::getRuleRefIds($this->getSid(), $this->getMid()) as $ref_id) {
            $mappings[$ref_id] = [];
        }

        foreach (array_keys($mappings) as $ref_id) {
            $this->mappings[$ref_id] = $this->tree->getPathId($ref_id, 1);
        }
        return true;
    }

    protected function isMapped($a_ref_id): bool
    {
        return array_key_exists($a_ref_id, $this->mappings);
    }

    protected function hasParentMapping($a_ref_id): bool
    {
        foreach ($this->mappings as $parent_nodes) {
            if (in_array($a_ref_id, $parent_nodes, true)) {
                return true;
            }
        }
        return false;
    }
}