class.ilAssNestedOrderingElementsInputGUI.php

Go to the documentation of this file.

<?php

use ILIAS\DI\UIServices;

class ilAssNestedOrderingElementsInputGUI extends ilMultipleNestedOrderingElementsInputGUI
{
    public const CONTEXT_QUESTION_PREVIEW = 'QuestionPreview';
    public const CONTEXT_CORRECT_SOLUTION_PRESENTATION = 'CorrectSolutionPresent';
    public const CONTEXT_USER_SOLUTION_PRESENTATION = 'UserSolutionPresent';
    public const CONTEXT_USER_SOLUTION_SUBMISSION = 'UserSolutionSubmit';

    public const ILC_CSS_CLASS_LIST = 'ilc_qordul_OrderList';
    public const ILC_CSS_CLASS_ITEM = 'ilc_qordli_OrderListItem';

    public const DEFAULT_THUMBNAIL_PREFIX = 'thumb.';

    protected $context = null;

    protected $uniquePrefix = null;

    protected $orderingType = null;

    protected $thumbnailFilenamePrefix = self::DEFAULT_THUMBNAIL_PREFIX;

    protected $elementImagePath = null;

    protected $showCorrectnessIconsEnabled = false;

    protected $correctnessTrueElementList = null;

    private UIServices $ui;

    public function __construct(ilAssOrderingFormValuesObjectsConverter $converter, $postVar)
    {
        global $DIC;
        $this->ui = $DIC->ui();
        $manipulator = new ilAssOrderingDefaultElementFallback();
        $this->addFormValuesManipulator($manipulator);

        parent::__construct('', $postVar);

        $this->addFormValuesManipulator($converter);

        $this->setHtmlListTag(parent::HTML_LIST_TAG_UL);
        $this->setCssListClass($this->getCssListClass() . ' ' . self::ILC_CSS_CLASS_LIST);
        $this->setCssItemClass($this->getCssItemClass() . ' ' . self::ILC_CSS_CLASS_ITEM);
        $this->setCssHandleClass($this->getCssHandleClass());
    }

    public function setElementList(ilAssOrderingElementList $elementList): void
    {
        $this->setIdentifiedMultiValues($elementList->getRandomIdentifierIndexedElements());
    }

    public function getElementList($questionId): ilAssOrderingElementList
    {
        require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssOrderingElementList.php';
        return ilAssOrderingElementList::buildInstance($questionId, $this->getIdentifiedMultiValues());
    }

    public function prepareReprintable(assQuestion $question): void
    {
        $elementList = $this->getElementList($question->getId());

        $elementList->completeContentsFromElementList(
            $question->getOrderingElementList()
        );

        $this->setElementList($elementList);
    }

    public function getInstanceId(): string
    {
        if (!$this->getContext() || !$this->getUniquePrefix()) {
            return parent::getInstanceId();
        }

        return $this->getContext() . '_' . $this->getUniquePrefix();
    }

    public function getContext(): ?string
    {
        return $this->context;
    }

    public function setContext($context): void
    {
        $this->context = $context;
    }

    public function getUniquePrefix()
    {
        return $this->uniquePrefix;
    }

    public function setUniquePrefix($uniquePrefix): void
    {
        $this->uniquePrefix = $uniquePrefix;
    }

    public function setOrderingType($orderingType): void
    {
        $this->orderingType = $orderingType;
    }

    public function getOrderingType()
    {
        return $this->orderingType;
    }

    public function setElementImagePath($elementImagePath): void
    {
        $this->elementImagePath = $elementImagePath;
    }

    public function getElementImagePath(): ?string
    {
        return $this->elementImagePath;
    }

    public function setThumbPrefix($thumbnailFilenamePrefix): void
    {
        $this->thumbnailFilenamePrefix = $thumbnailFilenamePrefix;
    }

    public function getThumbPrefix(): string
    {
        return $this->thumbnailFilenamePrefix;
    }

    public function setShowCorrectnessIconsEnabled($showCorrectnessIconsEnabled): void
    {
        $this->showCorrectnessIconsEnabled = $showCorrectnessIconsEnabled;
    }

    public function isShowCorrectnessIconsEnabled(): bool
    {
        return $this->showCorrectnessIconsEnabled;
    }

    public function getCorrectnessTrueElementList(): ?ilAssOrderingElementList
    {
        return $this->correctnessTrueElementList;
    }

    public function setCorrectnessTrueElementList(ilAssOrderingElementList $correctnessTrueElementList): void
    {
        $this->correctnessTrueElementList = $correctnessTrueElementList;
    }

    protected function getCorrectness($identifier): bool
    {
        return $this->getCorrectnessTrueElementList()->elementExistByRandomIdentifier($identifier);
    }

    private function getCorrectnessIcon($correctness): string
    {
        $icon_name = 'icon_not_ok.svg';
        $label = $this->lng->txt("answer_is_wrong");
        if ($correctness === 'correct') {
            $icon_name = 'icon_ok.svg';
            $label = $this->lng->txt("answer_is_right");
        }
        $path = ilUtil::getImagePath($icon_name);
        $icon = $this->ui->factory()->symbol()->icon()->custom(
            $path,
            $label
        );
        return $this->ui->renderer()->render($icon);
    }

    protected function getItemTemplate(): ilTemplate
    {
        return new ilTemplate('tpl.prop_ass_nested_order_elem.html', true, true, 'Modules/TestQuestionPool');
    }

    protected function getThumbnailFilename($element): string
    {
        return $this->getThumbPrefix() . $element['content'];
    }

    protected function getThumbnailSource($element): string
    {
        return $this->getElementImagePath() . $this->getThumbnailFilename($element);
    }

    protected function getItemHtml($element, $identifier, $position, $itemSubFieldPostVar, $itemSubFieldId): string
    {
        $tpl = $this->getItemTemplate();

        switch ($this->getOrderingType()) {
            case assOrderingQuestion::OQ_TERMS:
            case assOrderingQuestion::OQ_NESTED_TERMS:

                $tpl->setCurrentBlock('item_text');
                $tpl->setVariable("ITEM_CONTENT", ilLegacyFormElementsUtil::prepareFormOutput($element['content']));
                $tpl->parseCurrentBlock();
                break;

            case assOrderingQuestion::OQ_PICTURES:
            case assOrderingQuestion::OQ_NESTED_PICTURES:

                $tpl->setCurrentBlock('item_image');
                $tpl->setVariable("ITEM_SOURCE", $this->getThumbnailSource($element));
                $tpl->setVariable("ITEM_CONTENT", $this->getThumbnailFilename($element));
                $tpl->parseCurrentBlock();
                break;
        }

        if ($this->isShowCorrectnessIconsEnabled()) {
            $correctness = 'not_correct';
            if ($this->getCorrectness($identifier)) {
                $correctness = 'correct';
            }
            $tpl->setCurrentBlock('correctness_icon');

            $tpl->setVariable("ICON_OK", $this->getCorrectnessIcon($correctness));
            $tpl->parseCurrentBlock();
        }

        $tpl->setCurrentBlock('item');
        $tpl->setVariable("ITEM_ID", $itemSubFieldId);
        $tpl->setVariable("ITEM_POSTVAR", $itemSubFieldPostVar);
        $tpl->setVariable("ITEM_CONTENT", ilLegacyFormElementsUtil::prepareFormOutput($element['content']));
        $tpl->parseCurrentBlock();

        return $tpl->get();
    }

    protected function getCurrentIndentation($elementValues, $elementCounter): int
    {
        if (!isset($elementValues[$elementCounter])) {
            return 0;
        }

        return $elementValues[$elementCounter]['ordering_indentation'];
    }

    protected function getNextIndentation($elementValues, $elementCounter): int
    {
        if (!isset($elementValues[$elementCounter + 1])) {
            return 0;
        }

        return $elementValues[$elementCounter + 1]['ordering_indentation'];
    }

    public function isPostSubmit($data): bool
    {
        if (!is_array($data)) {
            return false;
        }

        if (!isset($data[$this->getPostVar()])) {
            return false;
        }

        if (!count($data[$this->getPostVar()])) {
            return false;
        }

        return true;
    }
}