class.ilOrgUnitGenericMultiInputGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;
use ILIAS\UI\Implementation\Render\Loader as UIRendererLoader;

class ilOrgUnitGenericMultiInputGUI extends ilFormPropertyGUI
{
    public const HOOK_IS_LINE_REMOVABLE = "hook_is_line_removable";
    public const HOOK_IS_INPUT_DISABLED = "hook_is_disabled";
    public const HOOK_BEFORE_INPUT_RENDER = "hook_before_render";

    public const MULTI_FIELD_ID = "id";
    public const MULTI_FIELD_OVER = "over";
    public const MULTI_FIELD_SCOPE = "scope";

    protected array $cust_attr = [];
    protected $value;
    protected array $inputs = [];
    protected array $input_options = [];
    protected array $hooks = [];
    protected array $line_values = [];
    protected string $template_dir = '';
    protected array $post_var_cache = [];
    protected bool $show_label = false;
    protected bool $show_label_once = false;
    protected array $hidden_inputs = [];
    protected bool $position_movable = false;
    protected int $counter = 0;
    protected bool $show_info = false;
    protected bool $render_one_for_empty_value = true;

    protected UIFactory $ui_factory;
    protected UIRenderer $ui_renderer;
    protected UIRendererLoader $renderer_loader;

    public function __construct(string $a_title = "", string $a_postvar = "")
    {
        parent::__construct($a_title, $a_postvar);
        $this->setType("line_select");
        $this->setMulti(true);
        $this->initCSSandJS();

        global $DIC;
        $this->ui_factory = $DIC['ui.factory'];
        $this->ui_renderer = $DIC['ui.renderer'];
        $this->renderer_loader = $DIC["ui.component_renderer_loader"];

    }

    public function getHook(string $key)
    {
        if (isset($this->hooks[$key])) {
            return $this->hooks[$key];
        }

        return false;
    }

    public function addHook(string $key, array $options)
    {
        $this->hooks[$key] = $options;
    }

    public function removeHook(string $key): bool
    {
        if (isset($this->hooks[$key])) {
            unset($this->hooks[$key]);

            return true;
        }

        return false;
    }

    public function addInput(\ilFormPropertyGUI $input, array $options = []): void
    {
        $this->inputs[$input->getPostVar()] = $input;
        $this->input_options[$input->getPostVar()] = $options;
        $this->counter++;
    }

    public function getTemplateDir(): string
    {
        return $this->template_dir;
    }

    public function setTemplateDir(string $template_dir)
    {
        $this->template_dir = $template_dir;
    }

    public function isShowLabel(): bool
    {
        return $this->show_label;
    }

    public function setShowLabel(bool $show_label)
    {
        $this->show_label = $show_label;
    }

    public function getInputs(): array
    {
        return $this->inputs;
    }

    public function setMulti(bool $a_multi, bool $a_sortable = false, bool $a_addremove = true): void
    {
        $this->multi = $a_multi;
    }

    public function setValue(array $value)
    {
        $this->value = $value;

        foreach ($this->inputs as $key => $item) {
            if ($item instanceof \ilDateTimeInputGUI) {
                $item->setDate(new \ilDate($value[$key]['date'], IL_CAL_DATE));
            } else {
                if (array_key_exists($key, $value)) {
                    $item->setValue((string) $value[$key]);
                }
            }
        }
    }

    public function getValue(): array
    {
        $out = [];
        foreach ($this->inputs as $key => $item) {
            $out[$key] = $item->getValue();
        }

        return $out;
    }

    public function setValueByArray(array $a_values): void
    {
        $data = $a_values[$this->getPostVar()] ?? [];
        if ($this->getMulti()) {
            $this->line_values = $data;
        } else {
            $this->setValue($data);
        }
    }

    public function checkInput(): bool
    {
        $internal_fields = array_keys($this->inputs);
        $key = $this->getPostVar();
        $post = $this->raw($key);

        if (is_array($post)) {
            foreach ($post as $authority) {
                if (!(
                    array_key_exists(self::MULTI_FIELD_ID, $authority) &&
                    array_key_exists(self::MULTI_FIELD_OVER, $authority) &&
                    array_key_exists(self::MULTI_FIELD_SCOPE, $authority) &&
                    trim($authority[self::MULTI_FIELD_OVER]) !== '' &&
                    trim($authority[self::MULTI_FIELD_SCOPE]) !== ''
                )) {
                    $this->setAlert($this->lng->txt("msg_input_is_required"));
                    return false;
                }
            }
        }

        return true;
    }

    public function addCustomAttribute(string $key, string $value, bool $override = false): void
    {
        if (isset($this->cust_attr[$key]) && !$override) {
            $this->cust_attr[$key] .= ' ' . $value;
        } else {
            $this->cust_attr[$key] = $value;
        }
    }

    public function getCustomAttributes(): array
    {
        return (array) $this->cust_attr;
    }

    private function createInputPostVar(string $iterator_id, \ilFormPropertyGUI $input): string
    {
        if ($this->getMulti()) {
            return $this->getPostVar() . '[' . $iterator_id . '][' . $input->getPostVar() . ']';
        } else {
            return $this->getPostVar() . '[' . $input->getPostVar() . ']';
        }
    }


    public function render(int|string $iterator_id = 0, bool $clean_render = false): string
    {
        $first_label = true;
        $tpl = new ilTemplate("tpl.prop_generic_multi_line.html", true, true, 'components/ILIAS/OrgUnit');

        $class = 'multi_input_line';
        $this->addCustomAttribute('class', $class, true);
        foreach ($this->getCustomAttributes() as $key => $value) {
            $tpl->setCurrentBlock('cust_attr');
            $tpl->setVariable('CUSTOM_ATTR_KEY', $key);
            $tpl->setVariable('CUSTOM_ATTR_VALUE', $value);
            $tpl->parseCurrentBlock();
        }
        $inputs = $this->inputs;
        foreach ($inputs as $key => $input) {
            $input = clone $input;
            $is_hidden = false;
            $is_ta = false;
            if (!method_exists($input, 'render')) {
                switch (true) {
                    case ($input instanceof \ilHiddenInputGUI):
                        $is_hidden = true;
                        break;
                    case ($input instanceof \ilTextAreaInputGUI):
                        $is_ta = true;
                        break;
                    default:
                        throw new \ilException("Method " . get_class($input)
                            . "::render() does not exists! You cannot use this input-type in ilMultiLineInputGUI");
                }
            }

            $is_disabled_hook = $this->getHook(self::HOOK_IS_INPUT_DISABLED);
            if ($is_disabled_hook !== false && !$clean_render) {
                $input->setDisabled($is_disabled_hook($this->getValue()));
            }
            if ($this->getDisabled()) {
                $input->setDisabled(true);
            }
            if ($iterator_id == 0 && !isset($this->post_var_cache[$key])) {
                $this->post_var_cache[$key] = $input->getPostVar();
            } else {
                // Reset post var
                $input->setPostVar($this->post_var_cache[$key]);
            }
            $post_var = $this->createInputPostVar((string) $iterator_id, $input);
            $input->setPostVar($post_var);
            $before_render_hook = $this->getHook(self::HOOK_BEFORE_INPUT_RENDER);
            if ($before_render_hook !== false && !$clean_render) {
                $input = $before_render_hook($this->getValue(), $key, $input);
            }
            switch (true) {
                case $is_hidden:
                    $tpl->setCurrentBlock('hidden');
                    $tpl->setVariable('NAME', $post_var);
                    $tpl->setVariable('VALUE', ilLegacyFormElementsUtil::prepareFormOutput($input->getValue()));
                    break;
                case $is_ta:
                    if ($this->isShowLabel() || ($this->isShowLabelOnce() && $first_label)) {
                        $tpl->setCurrentBlock('input_label');
                        $tpl->setVariable('LABEL', $input->getTitle());
                        $tpl->setVariable('CONTENT', $input->getHTML());
                        $tpl->parseCurrentBlock();
                        $first_label = false;
                    } else {
                        $tpl->setCurrentBlock('input');
                        $tpl->setVariable('CONTENT', $input->getHTML());
                    }
                    break;
                default:
                    if ($this->isShowLabel() || ($this->isShowLabelOnce() && $first_label)) {
                        $tpl->setCurrentBlock('input_label');
                        $tpl->setVariable('LABEL', $input->getTitle());
                        $tpl->setVariable('CONTENT', $input->render());
                        $first_label = false;
                    } else {
                        $tpl->setCurrentBlock('input');
                        $tpl->setVariable('CONTENT', $input->render());
                    }
                    break;
            }
            if ($this->isShowInfo()) {
                if ($this->isShowLabel()) {
                    $tpl->setCurrentBlock('input_info_label');
                    $tpl->setVariable('INFO_LABEL', $input->getInfo());
                    $tpl->parseCurrentBlock();
                } else {
                    $tpl->setCurrentBlock('input_info');
                    $tpl->setVariable('INFO', $input->getInfo());
                    $tpl->parseCurrentBlock();
                }
            }
            $tpl->parseCurrentBlock();
        }
        if ($this->getMulti() && !$this->getDisabled()) {
            $is_removeable_hook = $this->getHook(self::HOOK_IS_LINE_REMOVABLE);
            if ($is_removeable_hook !== false && !$clean_render) {
                $show_remove = $is_removeable_hook($this->getValue());
            }
            $tpl->setCurrentBlock('multi_icons');
            $tpl->setVariable('IMAGE_PLUS', $this->getGlyph('add'));
            $tpl->setVariable('IMAGE_MINUS', $this->getGlyph('remove'));
            $tpl->parseCurrentBlock();

            if ($this->isPositionMovable()) {
                $tpl->setCurrentBlock('multi_icons_move');
                $tpl->setVariable('IMAGE_UP', $this->getGlyph('up'));
                $tpl->setVariable('IMAGE_DOWN', $this->getGlyph('down'));
                $tpl->parseCurrentBlock();
            }
        }

        return $tpl->get();
    }

    public function initCSSandJS()
    {
        $this->global_tpl->addJavascript('assets/js/generic_multi_line_input.js');
    }

    public function insert(\ilTemplate $a_tpl): void
    {
        $output = "";

        $output .= $this->render(0, true);
        if ($this->getMulti() && is_array($this->line_values) && count($this->line_values) > 0) {
            $tpl = new ilTemplate("tpl.prop_generic_multi_line.html", true, true, 'components/ILIAS/OrgUnit');
            $tpl->setVariable('ADDITIONAL_ATTRS', "id='multi_line_add_button' style='display:none'");
            $tpl->setCurrentBlock('multi_icons');
            $tpl->setVariable('IMAGE_PLUS', $this->getGlyph('add'));
            $tpl->setVariable('IMAGE_MINUS', $this->getGlyph('remove'));
            $tpl->parseCurrentBlock();
            $output .= $tpl->get();

            foreach ($this->line_values as $run => $data) {
                $object = $this;
                $object->setValue($data);
                $output .= $object->render($run);
            }
        } else {
            if ($this->render_one_for_empty_value) {
                $output .= $this->render(0, true);
            } else {
                $tpl = new ilTemplate("tpl.prop_generic_multi_line.html", true, true, 'components/ILIAS/OrgUnit');
                $tpl->setVariable('ADDITIONAL_ATTRS', "id='multi_line_add_button'");
                $tpl->setCurrentBlock('multi_icons');
                $tpl->setVariable('IMAGE_PLUS', $this->getGlyph('add'));
                $tpl->setVariable('IMAGE_MINUS', $this->getGlyph('remove'));

                $tpl->parseCurrentBlock();
                $output .= $tpl->get();
            }
        }
        if ($this->getMulti()) {
            $output = "<div style=\"display:none;\" id='{$this->getFieldId()}' class='multi_line_input'>{$output}</div>";
            $config = json_encode($this->input_options);
            $options = json_encode([
                'limit' => 999999,
                'sortable' => false,
                'locale' => $this->lng->getLangKey()
            ]);
            global $tpl;
            $tpl->addOnLoadCode("
                il.DataCollection.genericMultiLineInit('{$this->getFieldId()}',$config,$options);
                document.body.querySelector('#{$this->getFieldId()}').removeAttribute('style');
            ");
        }

        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $output);
        $a_tpl->parseCurrentBlock();
    }

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

    public function getToolbarHTML(): string
    {
        return $this->render("toolbar");
    }

    public function isPositionMovable(): bool
    {
        return $this->position_movable;
    }

    public function setPositionMovable(bool $position_movable): void
    {
        $this->position_movable = $position_movable;
    }

    public function isShowLabelOnce(): bool
    {
        return $this->show_label_once;
    }

    public function setShowLabelOnce(bool $show_label_once): void
    {
        $this->setShowLabel(false);
        $this->show_label_once = $show_label_once;
    }

    public function isShowInfo(): bool
    {
        return $this->show_info;
    }

    public function setShowInfo(bool $show_info): void
    {
        $this->show_info = $show_info;
    }

    public function isRenderOneForEmptyValue(): bool
    {
        return $this->render_one_for_empty_value;
    }

    public function setRenderOneForEmptyValue(bool $render_one_for_empty_value): void
    {
        $this->render_one_for_empty_value = $render_one_for_empty_value;
    }

    private function getGlyph(string $which): string
    {
        $symbol = $this->ui_factory->symbol()->glyph()->$which();
        $renderer = $this->renderer_loader->getRendererFor(
            $symbol,
            [$this->ui_factory->button()->bulky($symbol, '', '')]
        );
        return $renderer->render($symbol, $this->ui_renderer);
    }
}