class.ilAssLacLegendGUI.php

Go to the documentation of this file.

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

include_once 'Modules/TestQuestionPool/interfaces/interface.iQuestionCondition.php';
include_once 'Services/UIComponent/Overlay/classes/class.ilOverlayGUI.php';

class ilAssLacLegendGUI extends ilOverlayGUI
{
        protected $lng;
        
        protected $tpl;
        
        private $initialVisibilityEnabled;

        private $questionOBJ;
        
        private $examplesByQuestionType = array(
                'assQuestion' => array('PercentageResultExpression', 'EmptyAnswerExpression'),
                'assSingleChoice' => array('NumberOfResultExpression'),
                'assMultipleChoice' => array('NumberOfResultExpression', 'ExclusiveResultExpression'),
                'assErrorText' => array('NumberOfResultExpression', 'ExclusiveResultExpression'),
                'assImagemapQuestion' => array('NumberOfResultExpression', 'ExclusiveResultExpression'),
                'assNumeric' => array('NumericResultExpression'),
                'assOrderingQuestion' => array('OrderingResultExpression'),
                'assOrderingHorizontal' => array('OrderingResultExpression'),
                'assMatchingQuestion' => array('MatchingResultExpression'),
                'assTextSubset' => array('StringResultExpression'),
                'assFormulaQuestion' => array('NumericResultExpression'),
                
                'assClozeTest' => array(
                        'StringResultExpression_1', 'StringResultExpression_2',
                        'NumberOfResultExpression', 'NumericResultExpression'
                ),
        );
        
        public function __construct(ilLanguage $lng, ilTemplate $tpl)
        {
                $this->lng = $lng;
                $this->tpl = $tpl;
                
                $this->initialVisibilityEnabled = false;

                $this->questionOBJ = null;

                parent::__construct('qpl_lac_legend');
        }

        public function getQuestionOBJ()
        {
                return $this->questionOBJ;
        }

        public function setQuestionOBJ(iQuestionCondition $questionOBJ)
        {
                $this->questionOBJ = $questionOBJ;
        }

        public function isInitialVisibilityEnabled()
        {
                return $this->initialVisibilityEnabled;
        }

        public function setInitialVisibilityEnabled($initialVisibilityEnabled)
        {
                $this->initialVisibilityEnabled = $initialVisibilityEnabled;
        }
        
        public function getHTML()
        {
                $this->initOverlay();

                $tpl = $this->getTemplate();
                
                $this->renderCloseIcon($tpl);
                $this->renderCommonLegendPart($tpl);
                $this->renderQuestSpecificLegendPart($tpl);
                $this->renderQuestSpecificExamples($tpl);
                
                $this->populateVisibilityCss($tpl);
                $this->populateTriggerDepencies($tpl);
                
                return $tpl->get();
        }
        
        protected function renderCloseIcon($tpl)
        {
                $tpl->setVariable('CLOSE_ICON', ilGlyphGUI::get(ilGlyphGUI::CLOSE));
        }
        
        protected function initOverlay()
        {
                include_once 'Services/YUI/classes/class.ilYuiUtil.php';
                ilYuiUtil::initOverlay();

                $this->tpl->addCss('Modules/TestQuestionPool/templates/default/lac_legend.css');
                
                //$this->setAnchor('fixed_content', 'tr', 'tr');
                // we use css instead, does not hoppel over screen for initially visible overlays

                //$this->setTrigger('lac_legend_toggle_btn', 'click');
                // is done by own listener that also changes the toggle label
                
                $this->setVisible($this->isInitialVisibilityEnabled());
                $this->setAutoHide(false);

                $this->add();
        }

        protected function getTemplate()
        {
                return new ilTemplate(
                        'tpl.qpl_logical_answer_compare_legend.html', true, true, 'Modules/TestQuestionPool'
                );
        }
        
        protected function renderCommonLegendPart(ilTemplate $tpl)
        {
                $tpl->setVariable(
                        'COMMON_ELEMENTS_HEADER', $this->lng->txt('qpl_lac_legend_header_common')
                );

                foreach($this->getCommonElements() as $element => $description)
                {
                        $tpl->setCurrentBlock('common_elements');
                        $tpl->setVariable('CE_ELEMENT', $element);
                        $tpl->setVariable('CE_DESCRIPTION', $description);
                        $tpl->parseCurrentBlock();
                }
        }

        protected function renderQuestSpecificLegendPart(ilTemplate $tpl)
        {
                $tpl->setVariable(
                        'QUEST_SPECIFIC_ELEMENTS_HEADER', $this->lng->txt('qpl_lac_legend_header_quest_specific')
                );
                
                foreach($this->getQuestionTypeSpecificExpressions() as $expression => $description)
                {
                        $tpl->setCurrentBlock('quest_specific_elements');
                        $tpl->setVariable('QSE_ELEMENT', $expression);
                        $tpl->setVariable('QSE_DESCRIPTION', $this->lng->txt($description));
                        $tpl->setVariable('QSE_OPERATORS_TXT', $this->lng->txt('qpl_lac_legend_label_operators'));
                        $tpl->setVariable('QSE_OPERATORS', implode(', ', $this->getQuestionOBJ()->getOperators($expression)));
                        $tpl->parseCurrentBlock();
                }
        }

        protected function renderQuestSpecificExamples(ilTemplate $tpl)
        {
                $tpl->setVariable(
                        'QUEST_SPECIFIC_EXAMPLES_HEADER', $this->lng->txt('lacex_example_header')
                );

                $questionTypes = array(
                        'assQuestion', $this->getQuestionOBJ()->getQuestionType()
                );
                
                foreach($questionTypes as $questionType)
                {
                        $examples = $this->getExpressionTypeExamplesByQuestionType($questionType);
                        $this->renderExamples($tpl, $examples, $questionType);
                }
        }

        protected function buildLangVarsByExampleCode($questionType, $exampleCode)
        {
                $langVar = 'lacex_'.$questionType.'_'.$exampleCode;
                return array($langVar.'_e', $langVar.'_d');
        }

        protected function renderExample(ilTemplate $tpl, $langVarE, $langVarD)
        {
                $tpl->setCurrentBlock('quest_specific_examples');
                $tpl->setVariable('QSEX_ELEMENT', $this->lng->txt($langVarE));
                $tpl->setVariable('QSEX_DESCRIPTION', $this->lng->txt($langVarD));
                $tpl->parseCurrentBlock();
        }

        protected function populateVisibilityCss(ilTemplate $tpl)
        {
                if( !$this->isInitialVisibilityEnabled() )
                {
                        $tpl->setVariable('CSS_DISPLAY_NONE', 'display:none;');
                }
        }
        
        protected function populateTriggerDepencies(ilTemplate $tpl)
        {
                require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionSkillAssignment.php';

                $tpl->setVariable(
                        'TOGGLE_BTN_SHOW_LABEL', $this->lng->txt('ass_lac_show_legend_btn')
                );
                
                $tpl->setVariable(
                        'TOGGLE_BTN_HIDE_LABEL', $this->lng->txt('ass_lac_hide_legend_btn')
                );
                
                $tpl->setVariable(
                        'SKILL_POINT_EVAL_MODE_BY_RESULT', ilAssQuestionSkillAssignment::EVAL_MODE_BY_QUESTION_RESULT
                );
                
                $tpl->setVariable(
                        'SKILL_POINT_EVAL_MODE_BY_SOLUTION', ilAssQuestionSkillAssignment::EVAL_MODE_BY_QUESTION_SOLUTION
                );
        }
        
        public function getTriggerElement()
        {
                return "<div id=\"qpl_lac_legend_trigger\"><a href=\"#\">".$this->lng->txt("qpl_lac_legend_link")."</a></div>";
        }

        protected function getQuestionTypeSpecificExpressions()
        {
                $availableExpressionTypes = $this->getAvailableExpressionTypes();

                $expressionTypes = array();

                foreach($this->getQuestionOBJ()->getExpressionTypes() as $expressionType)
                {
                        $expressionTypes[$expressionType] = $availableExpressionTypes[$expressionType];
                }

                return $expressionTypes;
        }

        protected function getCommonElements()
        {
                return array(
                        '&' => $this->lng->txt('qpl_lac_desc_logical_and'),
                        '|' => $this->lng->txt('qpl_lac_desc_logical_or'),
                        '!' => $this->lng->txt('qpl_lac_desc_negation'),
                        '()' => $this->lng->txt('qpl_lac_desc_brackets'),
                        //'Qn' => $this->lng->txt('qpl_lac_desc_res_of_quest_n'),
                        //'Qn[m]' => $this->lng->txt('qpl_lac_desc_res_of_answ_m_of_quest_n'),
                        'R' => $this->lng->txt('qpl_lac_desc_res_of_cur_quest'),
                        'R[m]' => $this->lng->txt('qpl_lac_desc_res_of_answ_m_of_cur_quest')
                );
        }

        protected function getAvailableExpressionTypes()
        {
                return array(
                        iQuestionCondition::PercentageResultExpression => 'qpl_lac_desc_compare_with_quest_res',
                        iQuestionCondition::NumericResultExpression => 'qpl_lac_desc_compare_with_number', 
                        iQuestionCondition::StringResultExpression => 'qpl_lac_desc_compare_with_text',
                        iQuestionCondition::MatchingResultExpression => 'qpl_lac_desc_compare_with_assignment',
                        iQuestionCondition::OrderingResultExpression => 'qpl_lac_desc_compare_with_sequence',
                        iQuestionCondition::NumberOfResultExpression => 'qpl_lac_desc_compare_with_answer_n',
                        iQuestionCondition::ExclusiveResultExpression => 'qpl_lac_desc_compare_with_exact_sequence',
                        iQuestionCondition::EmptyAnswerExpression => 'qpl_lac_desc_compare_answer_exist'
                );
        }
        
        public function getExpressionTypeExamplesByQuestionType($questionType)
        {
                if( !isset($this->examplesByQuestionType[$questionType]) )
                {
                        return array();
                }
                
                return $this->examplesByQuestionType[$questionType]; 
        }

        protected function renderExamples(ilTemplate $tpl, $examples, $questionType)
        {
                foreach($examples as $exampleCode)
                {
                        list($langVarE, $langVarD) = $this->buildLangVarsByExampleCode($questionType, $exampleCode);
                        $this->renderExample($tpl, $langVarE, $langVarD);
                }
        }
}