class.ilTestQuestionNavigationGUI.php

Go to the documentation of this file.

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


class ilTestQuestionNavigationGUI
{
        const CSS_CLASS_SUBMIT_BUTTONS = 'ilc_qsubmit_Submit';
        
        protected $lng;

        private $editSolutionCommand = '';

        private $questionWorkedThrough = false;

        private $submitSolutionCommand = '';

        private $discardSolutionButtonEnabled = false;

        private $skipQuestionLinkTarget = '';

        private $instantFeedbackCommand = '';

        private $answerFreezingEnabled = false;

        private $forceInstantResponseEnabled = false;

        private $requestHintCommand = '';

        private $showHintsCommand = '';

        private $hintRequestsExist = false;

        private $questionMarkCommand = '';

        private $questionMarked = false;

        private $charSelectorEnabled = false;

        private $anythingRendered = false;
        
        public function __construct(ilLanguage $lng)
        {
                $this->lng = $lng;
        }

        public function getEditSolutionCommand()
        {
                return $this->editSolutionCommand;
        }

        public function setEditSolutionCommand($editSolutionCommand)
        {
                $this->editSolutionCommand = $editSolutionCommand;
        }

        public function isQuestionWorkedThrough()
        {
                return $this->questionWorkedThrough;
        }

        public function setQuestionWorkedThrough($questionWorkedThrough)
        {
                $this->questionWorkedThrough = $questionWorkedThrough;
        }

        public function getSubmitSolutionCommand()
        {
                return $this->submitSolutionCommand;
        }

        public function setSubmitSolutionCommand($submitSolutionCommand)
        {
                $this->submitSolutionCommand = $submitSolutionCommand;
        }

        public function isDiscardSolutionButtonEnabled()
        {
                return $this->discardSolutionButtonEnabled;
        }

        public function setDiscardSolutionButtonEnabled($discardSolutionButtonEnabled)
        {
                $this->discardSolutionButtonEnabled = $discardSolutionButtonEnabled;
        }

        public function getSkipQuestionLinkTarget()
        {
                return $this->skipQuestionLinkTarget;
        }

        public function setSkipQuestionLinkTarget($skipQuestionLinkTarget)
        {
                $this->skipQuestionLinkTarget = $skipQuestionLinkTarget;
        }

        public function getInstantFeedbackCommand()
        {
                return $this->instantFeedbackCommand;
        }

        public function setInstantFeedbackCommand($instantFeedbackCommand)
        {
                $this->instantFeedbackCommand = $instantFeedbackCommand;
        }

        public function isAnswerFreezingEnabled()
        {
                return $this->answerFreezingEnabled;
        }

        public function isForceInstantResponseEnabled()
        {
                return $this->forceInstantResponseEnabled;
        }

        public function setForceInstantResponseEnabled($forceInstantResponseEnabled)
        {
                $this->forceInstantResponseEnabled = $forceInstantResponseEnabled;
        }

        public function setAnswerFreezingEnabled($answerFreezingEnabled)
        {
                $this->answerFreezingEnabled = $answerFreezingEnabled;
        }

        public function getRequestHintCommand()
        {
                return $this->requestHintCommand;
        }

        public function setRequestHintCommand($requestHintCommand)
        {
                $this->requestHintCommand = $requestHintCommand;
        }

        public function getShowHintsCommand()
        {
                return $this->showHintsCommand;
        }

        public function setShowHintsCommand($showHintsCommand)
        {
                $this->showHintsCommand = $showHintsCommand;
        }

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

        public function setHintRequestsExist($hintRequestsExist)
        {
                $this->hintRequestsExist = $hintRequestsExist;
        }

        public function getQuestionMarkCommand()
        {
                return $this->questionMarkCommand;
        }

        public function setQuestionMarkCommand($questionMarkCommand)
        {
                $this->questionMarkCommand = $questionMarkCommand;
        }

        public function isQuestionMarked()
        {
                return $this->questionMarked;
        }

        public function setQuestionMarked($questionMarked)
        {
                $this->questionMarked = $questionMarked;
        }

        public function isAnythingRendered()
        {
                return $this->anythingRendered;
        }

        public function setAnythingRendered()
        {
                $this->anythingRendered = true;
        }

        public function isCharSelectorEnabled()
        {
                return $this->charSelectorEnabled;
        }

        public function setCharSelectorEnabled($charSelectorEnabled)
        {
                $this->charSelectorEnabled = $charSelectorEnabled;
        }
        
        public function getHTML()
        {
                $tpl = $this->getTemplate();
                
                if( $this->getEditSolutionCommand() )
                {
                        $this->renderSubmitButton(
                                $tpl, $this->getEditSolutionCommand(), $this->getEditSolutionButtonLabel()
                        );
                }
                
                if( $this->getSubmitSolutionCommand() )
                {
                        $this->renderSubmitButton(
                                $tpl, $this->getSubmitSolutionCommand(), $this->getSubmitSolutionButtonLabel(), true
                        );
                }

                if( $this->isDiscardSolutionButtonEnabled() )
                {
                        $this->renderJsLinkedButton($tpl, 'tst_discard_answer_button', 'discard_answer', '');
                }
                
                if( $this->getSkipQuestionLinkTarget() )
                {
                        $this->renderLinkButton($tpl, $this->getSkipQuestionLinkTarget(), 'skip_question');
                }

                if( $this->getInstantFeedbackCommand() && !$this->isForceInstantResponseEnabled() )
                {
                        $this->renderSubmitButton(
                                $tpl, $this->getInstantFeedbackCommand(), $this->getCheckButtonLabel()
                        );
                }

                if( $this->getRequestHintCommand() )
                {
                        $this->renderSubmitButton(
                                $tpl, $this->getRequestHintCommand(), $this->getRequestHintButtonLabel()
                        );
                }

                if( $this->getShowHintsCommand() )
                {
                        $this->renderSubmitButton(
                                $tpl, $this->getShowHintsCommand(), 'button_show_requested_question_hints'
                        );
                }

                if( $this->getQuestionMarkCommand() )
                {
                        $this->renderIcon(
                                $tpl, $this->getQuestionMarkCommand(), $this->getQuestionMarkIconSource(),
                                $this->getQuestionMarkIconLabel(), 'ilTstMarkQuestionButton'
                        );
                }
                
                if( $this->isCharSelectorEnabled() )
                {
                        $this->renderJsLinkedButton($tpl,
                                'charselectorbutton', 'char_selector_btn_label', 'ilCharSelectorToggle'
                        );
                }
                
                if( $this->isAnythingRendered() )
                {
                        $this->parseNavigation($tpl);
                }
                
                return $tpl->get();
        }

        private function getEditSolutionButtonLabel()
        {
                if( $this->isQuestionWorkedThrough() )
                {
                        return 'edit_answer';
                }

                return 'answer_question';
        }

        private function getSubmitSolutionButtonLabel()
        {
                if( $this->isForceInstantResponseEnabled() )
                {
                        return 'submit_and_check';
                }

                return 'submit_answer';
        }
        
        private function getCheckButtonLabel()
        {
                if( $this->isAnswerFreezingEnabled() )
                {
                        return 'submit_and_check';
                }
                
                return 'check';
        }
        
        private function getRequestHintButtonLabel()
        {
                if( $this->hintRequestsExist() )
                {
                        return 'button_request_next_question_hint';
                }
                
                return 'button_request_question_hint';
        }

        private function getQuestionMarkIconLabel()
        {
                if( $this->isQuestionMarked() )
                {
                        return $this->lng->txt('tst_remove_mark');
                }

                return $this->lng->txt('tst_question_mark');
        }

        private function getQuestionMarkIconSource()
        {
                if( $this->isQuestionMarked() )
                {
                        return ilUtil::getImagePath('marked.svg');
                }

                return ilUtil::getImagePath('marked_.svg');
        }

        private function getTemplate()
        {
                return new ilTemplate(
                        'tpl.tst_question_navigation.html', true, true, 'Modules/Test'
                );
        }

        private function parseNavigation(ilTemplate $tpl)
        {
                $tpl->setCurrentBlock('question_related_navigation');
                $tpl->parseCurrentBlock();
        }

        private function parseButtonsBlock(ilTemplate $tpl)
        {
                $tpl->setCurrentBlock('buttons');
                $tpl->parseCurrentBlock();
        }

        private function renderButtonInstance(ilTemplate $tpl, $button)
        {
                $tpl->setCurrentBlock("button_instance");
                $tpl->setVariable("BUTTON_INSTANCE", $button->render());
                $tpl->parseCurrentBlock();

                $this->parseButtonsBlock($tpl);
                $this->setAnythingRendered();
        }

        private function renderSubmitButton(ilTemplate $tpl, $command, $label, $primary = false)
        {
                $button = ilSubmitButton::getInstance();
                $button->setCommand($command);
                $button->setCaption($label);
                $button->setPrimary($primary);
                $button->addCSSClass(self::CSS_CLASS_SUBMIT_BUTTONS);
                
                $this->renderButtonInstance($tpl, $button);
        }

        private function renderLinkButton(ilTemplate $tpl, $href, $label)
        {
                $button = ilLinkButton::getInstance();
                $button->setUrl($href);
                $button->setCaption($label);

                $this->renderButtonInstance($tpl, $button);
        }

        private function renderJsLinkedButton(ilTemplate $tpl, $htmlId, $label, $cssClass)
        {
                $button = ilLinkButton::getInstance();
                $button->setId($htmlId);
                $button->addCSSClass($cssClass);
                $button->setCaption($label);

                $this->renderButtonInstance($tpl, $button);
        }

        private function renderIcon(ilTemplate $tpl, $command, $iconSrc, $label, $cssClass)
        {
                $tpl->setCurrentBlock("submit_icon");
                $tpl->setVariable("SUBMIT_ICON_CMD", $command);
                $tpl->setVariable("SUBMIT_ICON_SRC", $iconSrc);
                $tpl->setVariable("SUBMIT_ICON_TEXT", $label);
                $tpl->setVariable("SUBMIT_ICON_CLASS", $cssClass);
                $tpl->parseCurrentBlock();

                $this->parseButtonsBlock($tpl);
                $this->setAnythingRendered();
        }
}