class.ilAssNestedOrderingElementsInputGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/Form/classes/class.ilMultipleNestedOrderingElementsInputGUI.php';

class ilAssNestedOrderingElementsInputGUI extends ilMultipleNestedOrderingElementsInputGUI
{
    const CONTEXT_QUESTION_PREVIEW = 'QuestionPreview';
    const CONTEXT_CORRECT_SOLUTION_PRESENTATION = 'CorrectSolutionPresent';
    const CONTEXT_USER_SOLUTION_PRESENTATION = 'UserSolutionPresent';
    const CONTEXT_USER_SOLUTION_SUBMISSION = 'UserSolutionSubmit';
    
    const ILC_CSS_CLASS_LIST = 'ilc_qordul_OrderList';
    const ILC_CSS_CLASS_ITEM = 'ilc_qordli_OrderListItem';
    const ILC_CSS_CLASS_HANDLE = 'ilc_qanswer_Answer';
    
    protected $context = null;
    
    protected $uniquePrefix = null;
    
    protected $orderingType = null;
    
    const DEFAULT_THUMBNAIL_PREFIX = 'thumb.';
    
    protected $thumbnailFilenamePrefix = self::DEFAULT_THUMBNAIL_PREFIX;
    
    protected $elementImagePath = null;
    
    const CORRECTNESS_ICON_TRUE = 'icon_ok.svg';
    const CORRECTNESS_LNGVAR_TRUE = 'answer_is_right';
    
    const CORRECTNESS_ICON_FALSE = 'icon_not_ok.svg';
    const CORRECTNESS_LNGVAR_FALSE = 'answer_is_wrong';
    
    protected $correctnessIcons = array(
        true => self::CORRECTNESS_ICON_TRUE, false => self::CORRECTNESS_ICON_FALSE
    );
    
    protected $correctnessLngVars = array(
        true => self::CORRECTNESS_LNGVAR_TRUE, false => self::CORRECTNESS_LNGVAR_FALSE
    );
    
    protected $showCorrectnessIconsEnabled = false;
    
    protected $correctnessTrueElementList = null;
    
    public function __construct(ilAssOrderingFormValuesObjectsConverter $converter, $postVar)
    {
        require_once 'Modules/TestQuestionPool/classes/forms/class.ilAssOrderingDefaultElementFallback.php';
        $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() . ' ' . self::ILC_CSS_CLASS_HANDLE);
    }
    
    public function setElementList(ilAssOrderingElementList $elementList)
    {
        $this->setIdentifiedMultiValues($elementList->getRandomIdentifierIndexedElements());
    }
    
    public function getElementList($questionId)
    {
        require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssOrderingElementList.php';
        return ilAssOrderingElementList::buildInstance($questionId, $this->getIdentifiedMultiValues());
    }
    
    public function prepareReprintable(assQuestion $question)
    {
        $elementList = $this->getElementList($question->getId());
        
        $elementList->completeContentsFromElementList(
            $question->getOrderingElementList()
        );

        $this->setElementList($elementList);
    }
    
    public function getInstanceId()
    {
        if (!$this->getContext() || !$this->getUniquePrefix()) {
            return parent::getInstanceId();
        }
        
        return $this->getContext() . '_' . $this->getUniquePrefix();
    }
    
    public function getContext()
    {
        return $this->context;
    }
    
    public function setContext($context)
    {
        $this->context = $context;
    }
    
    public function getUniquePrefix()
    {
        return $this->uniquePrefix;
    }
    
    public function setUniquePrefix($uniquePrefix)
    {
        $this->uniquePrefix = $uniquePrefix;
    }
    
    public function setOrderingType($orderingType)
    {
        $this->orderingType = $orderingType;
    }
    
    public function getOrderingType()
    {
        return $this->orderingType;
    }
    
    public function setElementImagePath($elementImagePath)
    {
        $this->elementImagePath = $elementImagePath;
    }
    
    public function getElementImagePath()
    {
        return $this->elementImagePath;
    }
    
    public function setThumbPrefix($thumbnailFilenamePrefix)
    {
        $this->thumbnailFilenamePrefix = $thumbnailFilenamePrefix;
    }
    
    public function getThumbPrefix()
    {
        return $this->thumbnailFilenamePrefix;
    }
    
    public function setShowCorrectnessIconsEnabled($showCorrectnessIconsEnabled)
    {
        $this->showCorrectnessIconsEnabled = $showCorrectnessIconsEnabled;
    }
    
    public function isShowCorrectnessIconsEnabled()
    {
        return $this->showCorrectnessIconsEnabled;
    }
    
    public function getCorrectnessIconFilename($correctness)
    {
        return $this->correctnessIcons[(bool) $correctness];
    }
    
    public function setCorrectnessIconFilename($correctness, $iconFilename)
    {
        $this->correctnessIcons[(bool) $correctness] = $iconFilename;
    }
    
    public function getCorrectnessLangVar($correctness)
    {
        return $this->correctnessLngVars[(bool) $correctness];
    }
    
    public function setCorrectnessLangVar($correctness, $langVar)
    {
        $this->correctnessLngVars[(bool) $correctness] = $langVar;
    }
    
    public function getCorrectnessText($correctness)
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        $lng = $DIC['lng'];
        return $lng->txt($this->correctnessLngVars[(bool) $correctness]);
    }
    
    public function getCorrectnessTrueElementList()
    {
        return $this->correctnessTrueElementList;
    }
    
    public function setCorrectnessTrueElementList(ilAssOrderingElementList $correctnessTrueElementList)
    {
        $this->correctnessTrueElementList = $correctnessTrueElementList;
    }
    
    protected function getCorrectness($identifier)
    {
        return $this->getCorrectnessTrueElementList()->elementExistByRandomIdentifier($identifier);
    }
    
    protected function getItemTemplate()
    {
        return new ilTemplate('tpl.prop_ass_nested_order_elem.html', true, true, 'Modules/TestQuestionPool');
    }
    
    protected function getThumbnailFilename($element)
    {
        return $this->getThumbPrefix() . $element['content'];
    }
    
    protected function getThumbnailSource($element)
    {
        return $this->getElementImagePath() . $this->getThumbnailFilename($element);
    }
    
    protected function getItemHtml($element, $identifier, $position, $itemSubFieldPostVar, $itemSubFieldId)
    {
        $tpl = $this->getItemTemplate();
        
        switch ($this->getOrderingType()) {
            case OQ_TERMS:
            case OQ_NESTED_TERMS:
            
                $tpl->setCurrentBlock('item_text');
                $tpl->setVariable("ITEM_CONTENT", ilUtil::prepareFormOutput($element['content']));
                $tpl->parseCurrentBlock();
                break;
                
            case OQ_PICTURES:
            case 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()) {
            $tpl->setCurrentBlock('correctness_icon');
            $tpl->setVariable("ICON_SRC", $this->getCorrectnessIconFilename($this->getCorrectness($identifier)));
            $tpl->setVariable("ICON_TEXT", $this->getCorrectnessText($this->getCorrectness($identifier)));
            $tpl->parseCurrentBlock();
        }
        
        $tpl->setCurrentBlock('item');
        $tpl->setVariable("ITEM_ID", $itemSubFieldId);
        $tpl->setVariable("ITEM_POSTVAR", $itemSubFieldPostVar);
        $tpl->setVariable("ITEM_CONTENT", ilUtil::prepareFormOutput($element['content']));
        $tpl->parseCurrentBlock();

        return $tpl->get();
    }
    
    protected function getCurrentIndentation($elementValues, $elementCounter)
    {
        if (!isset($elementValues[$elementCounter])) {
            return 0;
        }
        
        return $elementValues[$elementCounter]['ordering_indentation'];
    }
    
    protected function getNextIndentation($elementValues, $elementCounter)
    {
        if (!isset($elementValues[$elementCounter + 1])) {
            return 0;
        }
        
        return $elementValues[$elementCounter + 1]['ordering_indentation'];
    }
    
    public function isPostSubmit($data)
    {
        if (!is_array($data)) {
            return false;
        }
        
        if (!isset($data[$this->getPostVar()])) {
            return false;
        }
        
        if (!count($data[$this->getPostVar()])) {
            return false;
        }
        
        return true;
    }
}