class.ilMultipleTextsInputGUI.php

Go to the documentation of this file.

<?php
 
use ILIAS\UI\Renderer;
use ILIAS\UI\Component\Button\Factory as ButtonFactory;
use ILIAS\UI\Component\Symbol\Glyph\Factory as GlyphFactory;
 
abstract class ilMultipleTextsInputGUI extends ilIdentifiedMultiValuesInputGUI
{
    protected $editElementOccuranceEnabled = false;
 
    protected $editElementOrderEnabled = false;
 
    protected GlyphFactory $glyph_factory;
    protected ButtonFactory $button_factory;
    protected Renderer $renderer;
    protected ilGlobalTemplateInterface $tpl;
 
    public function __construct($a_title = "", $a_postvar = "")
    {
        parent::__construct($a_title, $a_postvar);
 
        global $DIC;
        $this->lng = $DIC['lng'];
        $this->glyph_factory = $DIC->ui()->factory()->symbol()->glyph();
        $this->button_factory = $DIC->ui()->factory()->button();
        $this->renderer = $DIC['ui.renderer'];
        $this->tpl = $DIC['tpl'];
 
        $this->validationRegexp = "";
    }
 
    public function isEditElementOccuranceEnabled(): bool
    {
        return $this->editElementOccuranceEnabled;
    }
 
    public function setEditElementOccuranceEnabled($editElementOccuranceEnabled): void
    {
        $this->editElementOccuranceEnabled = $editElementOccuranceEnabled;
    }
 
    public function isEditElementOrderEnabled(): bool
    {
        return $this->editElementOrderEnabled;
    }
 
    public function setEditElementOrderEnabled($editElementOrderEnabled): void
    {
        $this->editElementOrderEnabled = $editElementOrderEnabled;
    }
 
    public function onCheckInput(): bool
    {
        $lng = $this->lng;
 
        $submittedElements = $this->getInput();
 
        if ($submittedElements === [] && $this->getRequired()) {
            $this->setAlert($lng->txt('msg_input_is_required'));
            return false;
        }
 
        foreach ($submittedElements as $submittedValue) {
            $submittedContentText = $this->fetchContentTextFromValue($submittedValue);
 
            if ($this->getRequired() && trim((string) $submittedContentText) === "") {
                $this->setAlert($lng->txt('msg_input_is_required'));
                return false;
            }
 
            if ($this->getValidationRegexp() !== '') {
                if (!preg_match($this->getValidationRegexp(), (string) $submittedContentText)) {
                    $this->setAlert($lng->txt('msg_wrong_format'));
                    return false;
                }
            }
        }
 
        return $this->checkSubItemsInput();
    }
 
    public function render(string $a_mode = ""): string
    {
        $tpl = new ilTemplate("tpl.prop_multi_text_inp.html", true, true, "components/ILIAS/TestQuestionPool");
        $i = 0;
        foreach ($this->getIdentifiedMultiValues() as $identifier => $value) {
            if ($value !== null) {
                $tpl->setCurrentBlock("prop_text_propval");
                $tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($value));
                $tpl->parseCurrentBlock();
            }
            if ($this->isEditElementOrderEnabled()) {
                $tpl->setCurrentBlock("move");
                $tpl->setVariable("ID_UP", $this->getMultiValuePosIndexedSubFieldId($identifier, 'up', $i));
                $tpl->setVariable("ID_DOWN", $this->getMultiValuePosIndexedSubFieldId($identifier, 'down', $i));
                $tpl->setVariable("ID", $this->getMultiValuePosIndexedFieldId($identifier, $i));
                $tpl->setVariable("UP_BUTTON", $this->renderer->render(
                    $this->button_factory->shy('', '')->withSymbol($this->glyph_factory->up())
                ));
                $tpl->setVariable("DOWN_BUTTON", $this->renderer->render(
                    $this->button_factory->shy('', '')->withSymbol($this->glyph_factory->down())
                ));
                $tpl->parseCurrentBlock();
            }
            $tpl->setCurrentBlock("row");
            $tpl->setVariable("POST_VAR", $this->getMultiValuePostVarPosIndexed($identifier, $i));
            $tpl->setVariable("ID", $this->getMultiValuePosIndexedFieldId($identifier, $i));
            $tpl->setVariable("SIZE", $this->getSize());
            $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
 
            if ($this->getDisabled()) {
                $tpl->setVariable(
                    "DISABLED",
                    " disabled=\"disabled\""
                );
            } elseif ($this->isEditElementOccuranceEnabled()) {
                $tpl->setVariable("ID_ADD", $this->getMultiValuePosIndexedSubFieldId($identifier, 'add', $i));
                $tpl->setVariable("ID_REMOVE", $this->getMultiValuePosIndexedSubFieldId($identifier, 'remove', $i));
                $tpl->setVariable("ADD_BUTTON", $this->renderer->render(
                    $this->button_factory->shy('', '')->withSymbol($this->glyph_factory->add())
                ));
                $tpl->setVariable("REMOVE_BUTTON", $this->renderer->render(
                    $this->button_factory->shy('', '')->withSymbol($this->glyph_factory->remove())
                ));
            }
 
            $tpl->parseCurrentBlock();
            $i++;
        }
        $tpl->setVariable("ELEMENT_ID", $this->getFieldId());
 
        if (!$this->getDisabled()) {
            $config = '{'
                . '"fieldContainerSelector": ".ilWzdContainerText", '
                . '"reindexingRequiredElementsSelectors": ["input:text", "button"], '
                . '"handleRowCleanUpCallback": function(rowElem) {$(rowElem).find("input:text").val("")}'
                . '}';
            $this->tpl->addJavascript("assets/js/answerwizardinput.js");
            $this->tpl->addJavascript("assets/js/identifiedwizardinput.js");
            $this->tpl->addOnLoadCode("$.extend({}, AnswerWizardInput, IdentifiedWizardInput).init({$config});");
        }
 
        return $tpl->get();
    }
 
    protected function valueHasContentText($value): bool
    {
        if ($value === null || is_array($value) || is_object($value)) {
            return false;
        }
 
        return (bool) strlen($value);
    }
 
    protected function fetchContentTextFromValue($value)
    {
        if ($this->valueHasContentText($value)) {
            return $value;
        }
 
        return null;
    }
}