class.ilTestResultHeaderLabelBuilder.php

Go to the documentation of this file.

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


class ilTestResultHeaderLabelBuilder
{
        const LO_TEST_TYPE_INITIAL = 'loTestInitial';
        const LO_TEST_TYPE_QUALIFYING = 'loTestQualifying';
        protected $lng;

        protected $objCache;

        protected $objectiveOrientedContainerId;

        protected $testObjId;

        protected $testRefId;

        protected $userId;

        protected $crsTitle;

        protected $testType;

        protected $objectives;

        public function __construct(ilLanguage $lng, ilObjectDataCache $objCache)
        {
                $this->lng = $lng;
                $this->objCache = $objCache;

                $this->objectiveOrientedContainerId = null;
                $this->testObjId = null;
                $this->testRefId = null;
                $this->userId = null;

                $this->testType = null;
                $this->crsTitle = null;
                
                $this->objectives = array();
        }

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

        public function setObjectiveOrientedContainerId($objectiveOrientedContainerId)
        {
                $this->objectiveOrientedContainerId = $objectiveOrientedContainerId;
        }

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

        public function setTestObjId($testObjId)
        {
                $this->testObjId = $testObjId;
        }

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

        public function setTestRefId($testRefId)
        {
                $this->testRefId = $testRefId;
        }

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

        public function setUserId($userId)
        {
                $this->userId = $userId;
        }
        
        public function initObjectiveOrientedMode()
        {
                $this->initTestType();
                $this->initObjectives();
                $this->initCourseTitle();
        }
        
        private function initTestType()
        {
                require_once 'Modules/Course/classes/Objectives/class.ilLOSettings.php';
                $loSettings = ilLOSettings::getInstanceByObjId($this->getObjectiveOrientedContainerId());
                
                if( $loSettings->getInitialTest() == $this->getTestRefId() )
                {
                        $this->testType = self::LO_TEST_TYPE_INITIAL;
                }
                elseif( $loSettings->getQualifiedTest() == $this->getTestRefId() )
                {
                        $this->testType = self::LO_TEST_TYPE_QUALIFYING;
                }
        }
        
        private function initObjectives()
        {
                require_once 'Modules/Course/classes/Objectives/class.ilLOTestRun.php';
                $loRuns = ilLOTestRun::getRun($this->getObjectiveOrientedContainerId(), $this->getUserId(), $this->getTestObjId());

                $this->objectives = array();

                foreach( $loRuns as $loRun )
                {
                        /* @var ilLOTestRun $loRun */
                        
                        $this->objectives[$loRun->getObjectiveId()] = $this->getObjectiveTitle($loRun);
                }
        }

        private function initCourseTitle()
        {
                $this->crsTitle = $this->objCache->lookupTitle($this->getObjectiveOrientedContainerId());
        }

        public function getPassOverviewHeaderLabel()
        {
                if( !$this->getObjectiveOrientedContainerId() )
                {
                        return $this->lng->txt('tst_results_overview');
                }
                
                if( $this->isInitialTestForAllObjectives() )
                {
                        return sprintf(
                                $this->lng->txt('tst_pass_overview_header_lo_initial_all_objectives'), $this->crsTitle
                        );
                }
                elseif( $this->isInitialTestPerObjective() )
                {
                        return sprintf(
                                $this->lng->txt('tst_pass_overview_header_lo_initial_per_objective'),
                                $this->getObjectivesString(), $this->crsTitle
                        );
                }
                elseif( $this->isQualifyingTestForAllObjectives() )
                {
                        return sprintf(
                                $this->lng->txt('tst_pass_overview_header_lo_qualifying_all_objectives'), $this->crsTitle
                        );
                }
                elseif( $this->isQualifyingTestPerObjective() )
                {
                        return sprintf(
                                $this->lng->txt('tst_pass_overview_header_lo_qualifying_per_objective'),
                                $this->getObjectivesString(), $this->crsTitle
                        );
                }

                return '';
        }

        public function getPassDetailsHeaderLabel($attemptNumber)
        {
                if( !$this->getObjectiveOrientedContainerId() )
                {
                        return sprintf(
                                $this->lng->txt('tst_pass_details_overview_table_title'), $attemptNumber
                        );
                }
                
                if( $this->isInitialTest() )
                {
                        return sprintf(
                                $this->lng->txt('tst_pass_details_header_lo_initial'),
                                $this->getObjectivesString(), $this->getAttemptLabel($attemptNumber)
                        );
                }
                elseif( $this->isQualifyingTest() )
                {
                        return sprintf(
                                $this->lng->txt('tst_pass_details_header_lo_qualifying'),
                                $this->getObjectivesString(), $this->getAttemptLabel($attemptNumber)
                        );
                }
                
                return '';
        }
        
        private function isInitialTest()
        {
                return $this->testType == self::LO_TEST_TYPE_INITIAL;
        }

        private function isQualifyingTest()
        {
                return $this->testType == self::LO_TEST_TYPE_QUALIFYING;
        }

        private function isInitialTestForAllObjectives()
        {
                if( $this->testType != self::LO_TEST_TYPE_INITIAL )
                {
                        return false;
                }

                if( count($this->objectives) <= 1 )
                {
                        return false;
                }

                return true;
        }

        private function isInitialTestPerObjective()
        {
                if( $this->testType != self::LO_TEST_TYPE_INITIAL )
                {
                        return false;
                }

                if( count($this->objectives) > 1 )
                {
                        return false;
                }

                return true;
        }

        private function isQualifyingTestForAllObjectives()
        {
                if( $this->testType != self::LO_TEST_TYPE_QUALIFYING )
                {
                        return false;
                }

                if( count($this->objectives) <= 1 )
                {
                        return false;
                }

                return true;
        }

        private function isQualifyingTestPerObjective()
        {
                if( $this->testType != self::LO_TEST_TYPE_QUALIFYING )
                {
                        return false;
                }

                if( count($this->objectives) > 1 )
                {
                        return false;
                }

                return true;
        }

        private function getObjectiveTitle(ilLOTestRun $loRun)
        {
                require_once 'Modules/Course/classes/class.ilCourseObjective.php';
                return ilCourseObjective::lookupObjectiveTitle($loRun->getObjectiveId());
        }
        
        private function getObjectivesString()
        {
                return implode(', ', $this->objectives);
        }
        
        private function getAttemptLabel($attemptNumber)
        {
                return sprintf($this->lng->txt('tst_res_lo_try_n'), $attemptNumber);
        }
        
        public function getListOfAnswersHeaderLabel($attemptNumber)
        {
                $langVar = 'tst_eval_results_by_pass';

                if( $this->getObjectiveOrientedContainerId() )
                {
                        $langVar = 'tst_eval_results_by_pass_lo';
                }

                return sprintf($this->lng->txt($langVar), $attemptNumber);
        }
        
        public function getVirtualListOfAnswersHeaderLabel()
        {
                return $this->lng->txt('tst_eval_results_lo');
        }
        
        public function getVirtualPassDetailsHeaderLabel($objectiveTitle)
        {
                if( $this->isInitialTest() )
                {
                        return sprintf(
                                $this->lng->txt('tst_virtual_pass_header_lo_initial'), $objectiveTitle
                        );
                }
                elseif( $this->isQualifyingTest() )
                {
                        return sprintf(
                                $this->lng->txt('tst_virtual_pass_header_lo_qualifying'), $objectiveTitle
                        );
                }
                
                return '';
        }
}