class.ilTestQuestionHeaderBlockBuilder.php

Go to the documentation of this file.

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

require_once 'Modules/TestQuestionPool/interfaces/interface.ilQuestionHeaderBlockBuilder.php';

class ilTestQuestionHeaderBlockBuilder implements ilQuestionHeaderBlockBuilder
{
        protected $lng;

        protected $headerMode;

        protected $questionTitle;

        protected $questionPoints;

        protected $questionPosition;

        protected $questionCount;

        protected $questionPostponed;

        protected $questionObligatory;

        protected $questionRelatedObjectives;

// fau: testNav - answer status variable
        protected $questionAnswered;
// fau.

        function __construct(ilLanguage $lng)
        {
                $this->lng = $lng;
                
                $this->headerMode = null;
                $this->questionTitle = '';
                $this->questionPoints = 0.0;
                $this->questionPosition = 0;
                $this->questionCount = 0;
                $this->questionPostponed = false;
                $this->questionObligatory = false;
                $this->questionRelatedObjectives = '';
        }

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

        public function setHeaderMode($headerMode)
        {
                $this->headerMode = $headerMode;
        }

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

        public function setQuestionTitle($questionTitle)
        {
                $this->questionTitle = $questionTitle;
        }

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

        public function setQuestionPoints($questionPoints)
        {
                $this->questionPoints = $questionPoints;
        }

// fau: testNav - setter for question answered
        public function setQuestionAnswered($questionAnswered)
        {
                $this->questionAnswered = $questionAnswered;
        }
// fau.
        public function getQuestionPosition()
        {
                return $this->questionPosition;
        }

        public function setQuestionPosition($questionPosition)
        {
                $this->questionPosition = $questionPosition;
        }

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

        public function setQuestionCount($questionCount)
        {
                $this->questionCount = $questionCount;
        }

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

// fau: testNav - get question answered status
        public function isQuestionAnswered()
        {
                return $this->questionAnswered;
        }
// fau.

        public function setQuestionPostponed($questionPostponed)
        {
                $this->questionPostponed = $questionPostponed;
        }

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

        public function setQuestionObligatory($questionObligatory)
        {
                $this->questionObligatory = $questionObligatory;
        }

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

        public function setQuestionRelatedObjectives($questionRelatedObjectives)
        {
                $this->questionRelatedObjectives = $questionRelatedObjectives;
        }
        
        protected function buildQuestionPositionString()
        {
                if( !$this->getQuestionPosition() )
                {
                        return '';
                }
                
                if( $this->getQuestionCount() )
                {
                        return sprintf($this->lng->txt("tst_position"), $this->getQuestionPosition(), $this->getQuestionCount());
                }

                return sprintf($this->lng->txt("tst_position_without_total"), $this->getQuestionPosition());
        }

// fau: testNav - remove HTML from building strings (is now in tpl.tst_question_info.html)
        protected function buildQuestionPointsString()
        {
                if( $this->getQuestionPoints() == 1 )
                {
                        return "{$this->getQuestionPoints()} {$this->lng->txt('point')}";
                }

                return "{$this->getQuestionPoints()} {$this->lng->txt('points')}";
        }
        
        protected function buildQuestionPostponedString()
        {
                if( $this->isQuestionPostponed() )
                {
                        return $this->lng->txt("postponed");
                }
                
                return '';
        }
        
        protected function buildQuestionObligatoryString()
        {
                if( $this->isQuestionObligatory() )
                {
                        return $this->lng->txt("tst_you_have_to_answer_this_question");
                }
                
                return '';
        }
        
        protected function buildQuestionRelatedObjectivesString()
        {
                if( strlen($this->getQuestionRelatedObjectives()) )
                {
                        $label = $this->lng->txt('tst_res_lo_objectives_header');
                        return $label.': '.$this->getQuestionRelatedObjectives();
                }
                
                return '';
        }
// fau.


// fau: testNav - split generation of presentation title and question info

        public function getPresentationTitle()
        {
                switch( $this->getHeaderMode() )
                {
                        case 2:         // neither titles nor points => show position as title
                                return $this->buildQuestionPositionString();
                                break;

                        case 0:         // titles and points => show title here
                        case 1:         // only titles => show title here
                        default:
                                return $this->getQuestionTitle();
                }
        }


        public function getQuestionInfoHTML()
        {
                $tpl = new ilTemplate('tpl.tst_question_info.html', true, true, 'Modules/Test');

                // position and/or points
                switch( $this->getHeaderMode() )
                {
                        case 1: // only titles =>  show position here
                                $text = $this->buildQuestionPositionString();
                                break;

                        case 2: //      neither titles nor points => position is separate title, show nothing here
                                $text = '';
                                break;

                        case 0: //  titles and points => show position and points here
                        default:
                                $text = $this->buildQuestionPositionString() . ' (' . $this->buildQuestionPointsString() . ')';
                }
                if ($this->isQuestionPostponed())
                {
                        $text .= ($text ? ', ' : '') . $this->buildQuestionPostponedString();
                }

                $tpl->setVariable('TXT_POSITION_POINTS',$text);

                // obligatory
                if ($this->isQuestionObligatory() && !$this->isQuestionAnswered())
                {
                        $tpl->setVariable('TXT_OBLIGATORY', $this->buildQuestionObligatoryString());
                }

                // objectives
                if (strlen($this->getQuestionRelatedObjectives()) )
                {
                        $tpl->setVariable('TXT_OBJECTIVES', $this->buildQuestionRelatedObjectivesString());
                }

                // answer status
                if ($this->isQuestionAnswered())
                {
                        $tpl->setVariable('HIDDEN_NOT_ANSWERED', 'hidden');
                }
                else
                {
                        $tpl->setVariable('HIDDEN_ANSWERED', 'hidden');
                }

                $tpl->setVariable('SRC_ANSWERED', ilUtil::getImagePath('answered.svg'));
                $tpl->setVariable('SRC_NOT_ANSWERED', ilUtil::getImagePath('answered_not.svg'));
                $tpl->setVariable('TXT_ANSWERED', $this->lng->txt('tst_answer_status_answered'));
                $tpl->setVariable('TXT_NOT_ANSWERED', $this->lng->txt('tst_answer_status_not_answered'));
                $tpl->setVariable('TXT_EDITING', $this->lng->txt('tst_answer_status_editing'));

                return $tpl->get();
        }
// fau.

        public function getHTML()
        {
                $headerBlock = $this->buildQuestionPositionString();

                switch( $this->getHeaderMode() )
                {
                        case 1: 

                                $headerBlock .= " - ".$this->getQuestionTitle();
                                $headerBlock .= $this->buildQuestionPostponedString();  
                                $headerBlock .= $this->buildQuestionObligatoryString();  
                                break;
                        
                        case 2:

                                $headerBlock .= $this->buildQuestionPostponedString();
                                $headerBlock .= $this->buildQuestionObligatoryString();
                                break;
                        
                        case 0:
                        default:

                                $headerBlock .= " - ".$this->getQuestionTitle();
                                $headerBlock .= $this->buildQuestionPostponedString();
// fau: testNav - put the points in parentheses here, not in building the string
                                $headerBlock .= ' ('.$this->buildQuestionPointsString().')';
// fau.
                                $headerBlock .= $this->buildQuestionObligatoryString();
                }

                $headerBlock .= $this->buildQuestionRelatedObjectivesString();

                return $headerBlock;
        }
}