class.ilExplorerSelectInputGUI.php

Go to the documentation of this file.

<?php

use ILIAS\DI\UIServices;

abstract class ilExplorerSelectInputGUI extends ilFormPropertyGUI implements ilTableFilterItem
{
    protected ilGlobalTemplateInterface $global_template;
    protected UIServices $ui;

    protected $value;
    protected bool $multi_nodes;
    protected ilExplorerBaseGUI $explorer_gui;
    protected bool $disabled = false;

    protected $on_load_code;

    public function __construct(
        string $a_title,
        string $a_postvar,
        ilExplorerBaseGUI $a_explorer_gui,
        bool $a_multi = false
    ) {
        global $DIC;

        $this->lng = $DIC->language();
        $this->multi_nodes = $a_multi;
        $this->explorer_gui = $a_explorer_gui;
        $this->global_template = $DIC->ui()->mainTemplate();

        $this->ui = $DIC->ui();

        parent::__construct($a_title, $a_postvar);
        $this->setType("exp_select");
    }

    public function getExplHandleCmd(): string
    {
        return "handleExplorerCommand";
    }

    public function handleExplorerCommand(): void
    {
        $val = $this->getValue();
        if (is_array($val)) {
            foreach ($val as $v) {
                $this->explorer_gui->setNodeOpen($v);
                $this->explorer_gui->setNodeSelected($v);
            }
        } elseif ($val != "") {
            $this->explorer_gui->setNodeOpen($val);
            $this->explorer_gui->setNodeSelected($val);
        }
        $this->explorer_gui->handleCommand();
    }

    abstract public function getTitleForNodeId($a_id): string;

    public function setValue($a_value): void
    {
        if ($this->multi_nodes && !is_array($a_value)) {
            if ($a_value !== false) {
                $this->value = array($a_value);
            } else {
                $this->value = array();
            }
        } else {
            $this->value = $a_value;
        }
    }

    public function getValue()
    {
        return $this->value;
    }

    public function setValueByArray(array $a_values): void
    {
        $this->setValue($a_values[$this->getPostVar()] ?? "");
    }

    public function checkInput(): bool
    {
        $lng = $this->lng;

        // check required
        if ($this->getRequired()) {
            if ((!$this->multi_nodes && trim($this->getInput()) === "") ||
                ($this->multi_nodes && count($this->getInput()) === 0)) {
                $this->setAlert($lng->txt("msg_input_is_required"));
                return false;
            }
        }
        return true;
    }

    public function getInput()
    {
        if ($this->multi_nodes) {
            return $this->strArray($this->getPostVar());
        } else {
            return $this->str($this->getPostVar());
        }
    }

    public function render(string $a_mode = "property_form"): string
    {
        $lng = $this->lng;

        $on_load_code = $this->getInitializationOnLoadCode();

        $this->global_tpl->addJavascript("assets/js/Explorer2.js");
        $this->global_tpl->addJavascript("asserts/js/LegacyModal.js");
        $this->global_tpl->addOnLoadCode($on_load_code);

        $tpl = new ilTemplate("tpl.prop_expl_select.html", true, true, "components/ILIAS/UIComponent/Explorer2");

        if ($a_mode !== "property_form") {
            $tpl->touchBlock("tiny_presentation");
        }

        // set values
        $val = $this->getValue();
        if (is_array($val)) {
            $val_txt = $sep = "";
            foreach ($val as $v) {
                $tpl->setCurrentBlock("node_hid");
                $tpl->setVariable("HID_NAME", $this->getPostVar() . "[]");
                $tpl->setVariable("HID_VAL", $v);
                $tpl->parseCurrentBlock();
                $val_txt .= $sep . $this->getTitleForNodeId($v);
                $sep = ", ";
                $this->explorer_gui->setNodeOpen($v);
                $this->explorer_gui->setNodeSelected($v);
            }
            $tpl->setVariable("VAL_TXT", $val_txt);
        } elseif ($val != "") {
            $tpl->setCurrentBlock("node_hid");
            $tpl->setVariable("HID_NAME", $this->getPostVar());
            $tpl->setVariable("HID_VAL", $val);
            $tpl->parseCurrentBlock();
            $tpl->setVariable("VAL_TXT", $this->getTitleForNodeId($val));
            $this->explorer_gui->setNodeOpen($val);
            $this->explorer_gui->setNodeSelected($val);
        }

        $tpl->setVariable("POST_VAR", $this->getPostVar());
        $tpl->setVariable("ID", $this->getFieldId());
        $this->global_template->addOnLoadCode($on_load_code);

        //              $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));

        //added disabled
        if (!$this->disabled) {
            $tpl->setCurrentBlock("txt_select");
            $tpl->setVariable("TXT_SELECT", $lng->txt("select"));
            $tpl->setVariable("ID_TXT_SELECT", $this->getFieldId());
            $tpl->parseCurrentBlock();

            $tpl->setCurrentBlock("txt_reset");
            $tpl->setVariable("TXT_RESET", $lng->txt("reset"));
            $tpl->setVariable("ID_TXT_RESET", $this->getFieldId());
            $tpl->parseCurrentBlock();
        }

        $tpl->setVariable("EXPL", $this->explorer_gui->getHTML());

        $top_tb = new ilToolbarGUI();

        $button = ilLinkButton::getInstance();
        $button->setCaption("select");
        $button->addCSSClass("ilExplSelectInputButS");
        $button->setOmitPreventDoubleSubmission(true);
        $top_tb->addStickyItem($button);

        $button = ilLinkButton::getInstance();
        $button->setCaption("cancel");
        $button->addCSSClass("ilExplSelectInputButC");
        $button->setOmitPreventDoubleSubmission(true);
        $top_tb->addStickyItem($button);

        // :TODO: we should probably clone the buttons properly
        $tpl->setVariable("TOP_TB", $top_tb->getHTML());
        $tpl->setVariable("BOT_TB", $top_tb->getHTML());

        return $tpl->get();
    }

    public function insert(ilTemplate $a_tpl): void
    {
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $this->render());
        $a_tpl->parseCurrentBlock();
    }

    public function getTableFilterHTML(): string
    {
        $html = $this->render("table_filter");
        return $html;
    }

    protected function getInitializationOnLoadCode(): string
    {
        if (isset($this->on_load_code)) {
            return $this->on_load_code;
        }

        $modal = $this->ui->factory()->modal()->roundtrip(
            'placeholder',
            $this->ui->factory()->legacy()->content('<div id="' . $this->getFieldId() . '_expl_marker"></div>')
        );
        $rendered_modal = str_replace(
            ["\r\n", "\n", "\r"],
            ' ',
            addslashes(json_encode($this->ui->renderer()->renderAsync($modal)))
        );
        return $this->on_load_code = 'il.Explorer2.initSelect(\'' . $this->getFieldId() . '\',"' .
            $rendered_modal . '",\'' .
            $modal->getShowSignal() . '\',\'' .
            $modal->getCloseSignal() . '\');';
    }
}