class.ilObjTestDynamicQuestionSetConfig.php

Go to the documentation of this file.

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

require_once 'Modules/Test/classes/class.ilTestQuestionSetConfig.php';

class ilObjTestDynamicQuestionSetConfig extends ilTestQuestionSetConfig
{
        private $sourceQuestionPoolId = null;

        private $answerStatusFilterEnabled = null;
        
        private $taxonomyFilterEnabled = null;

        private $orderingTaxonomyId = null;

        private $previousQuestionsListEnabled = null;
        
        public function getSourceQuestionPoolId()
        {
                return $this->sourceQuestionPoolId;
        }

        public function setSourceQuestionPoolId($sourceQuestionPoolId)
        {
                $this->sourceQuestionPoolId = (int)$sourceQuestionPoolId;
        }
        
        public function getSourceQuestionPoolTitle()
        {
                return $this->sourceQuestionPoolTitle;
        }

        public function setSourceQuestionPoolTitle($sourceQuestionPoolTitle)
        {
                $this->sourceQuestionPoolTitle = $sourceQuestionPoolTitle;
        }

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

        public function setAnswerStatusFilterEnabled($answerStatusFilterEnabled)
        {
                $this->answerStatusFilterEnabled = $answerStatusFilterEnabled;
        }

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

        public function setTaxonomyFilterEnabled($taxonomyFilterEnabled)
        {
                $this->taxonomyFilterEnabled = (bool)$taxonomyFilterEnabled;
        }
        
        public function getOrderingTaxonomyId()
        {
                return $this->orderingTaxonomyId;
        }
        
        public function setOrderingTaxonomyId($orderingTaxonomyId)
        {
                $this->orderingTaxonomyId = $orderingTaxonomyId;
        }

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

        public function setPreviousQuestionsListEnabled($previousQuestionsListEnabled)
        {
                $this->previousQuestionsListEnabled = $previousQuestionsListEnabled;
        }
        
        public function initFromArray($dataArray)
        {
                foreach($dataArray as $field => $value)
                {
                        switch($field)
                        {
                                case 'source_qpl_fi':                           $this->setSourceQuestionPoolId($value);                 break;
                                case 'source_qpl_title':                        $this->setSourceQuestionPoolTitle($value);              break;
                                case 'answer_filter_enabled':           $this->setAnswerStatusFilterEnabled($value);    break;
                                case 'tax_filter_enabled':                      $this->setTaxonomyFilterEnabled($value);                break;
                                case 'order_tax':                                       $this->setOrderingTaxonomyId($value);                   break;
                                case 'prev_quest_list_enabled':         $this->setPreviousQuestionsListEnabled($value); break;
                        }
                }
        }
        
        public function loadFromDb()
        {
                $res = $this->db->queryF(
                                "SELECT * FROM tst_dyn_quest_set_cfg WHERE test_fi = %s",
                                array('integer'), array($this->testOBJ->getTestId())
                );
                
                while( $row = $this->db->fetchAssoc($res) )
                {
                        $this->initFromArray($row);
                        
                        return true;
                }
                
                return false;
        }
        
        public function saveToDb()
        {
                if( $this->dbRecordExists($this->testOBJ->getTestId()) )
                {
                        $this->updateDbRecord($this->testOBJ->getTestId());
                }
                else
                {
                        $this->insertDbRecord($this->testOBJ->getTestId());
                }
        }

        public function cloneToDbForTestId($testId)
        {
                $this->insertDbRecord($testId);
        }

        public function deleteFromDb()
        {
                $aff = $this->db->manipulateF(
                        "DELETE FROM tst_dyn_quest_set_cfg WHERE test_fi = %s",
                        array('integer'), array($this->testOBJ->getTestId())
                );

                return (bool)$aff;
        }

        private function dbRecordExists($testId)
        {
                $res = $this->db->queryF(
                        "SELECT COUNT(*) cnt FROM tst_dyn_quest_set_cfg WHERE test_fi = %s",
                        array('integer'), array($testId)
                );
                
                $row = $this->db->fetchAssoc($res);
                
                return (bool)$row['cnt'];
        }

        private function updateDbRecord($testId)
        {
                $this->db->update('tst_dyn_quest_set_cfg',
                        array(
                                'source_qpl_fi' => array('integer', $this->getSourceQuestionPoolId()),
                                'source_qpl_title' => array('text', $this->getSourceQuestionPoolTitle()),
                                'answer_filter_enabled' => array('integer', $this->isAnswerStatusFilterEnabled()),
                                'tax_filter_enabled' => array('integer', $this->isTaxonomyFilterEnabled()),
                                'order_tax' => array('integer', $this->getOrderingTaxonomyId()),
                                'prev_quest_list_enabled' => array('integer', $this->isPreviousQuestionsListEnabled())
                        ),
                        array(
                                'test_fi' => array('integer', $testId)
                        )
                );
        }

        private function insertDbRecord($testId)
        {
                $this->db->insert('tst_dyn_quest_set_cfg', array(
                                'test_fi' => array('integer', $testId),
                                'source_qpl_fi' => array('integer', $this->getSourceQuestionPoolId()),
                                'source_qpl_title' => array('text', $this->getSourceQuestionPoolTitle()),
                                'answer_filter_enabled' => array('integer', $this->isAnswerStatusFilterEnabled()),
                                'tax_filter_enabled' => array('integer', $this->isTaxonomyFilterEnabled()),
                                'order_tax' => array('integer', $this->getOrderingTaxonomyId()),
                                'prev_quest_list_enabled' => array('integer', $this->isPreviousQuestionsListEnabled())
                ));
        }
        
        public function isQuestionSetConfigured()
        {
                return $this->getSourceQuestionPoolId() > 0;
        }
        
        public function doesQuestionSetRelatedDataExist()
        {
                return $this->isQuestionSetConfigured();
        }
        
        public function removeQuestionSetRelatedData()
        {
                $this->deleteFromDb();
        }

        public function resetQuestionSetRelatedTestSettings()
        {
                // nothing to do
        }

        public function cloneQuestionSetRelatedData($cloneTestOBJ)
        {
                $this->loadFromDb();
                $this->cloneToDbForTestId($cloneTestOBJ->getTestId());
        }

        public function getSourceQuestionPoolSummaryString(ilLanguage $lng)
        {
                $poolRefs = $this->getSourceQuestionPoolRefIds();
                
                if( !count($poolRefs) )
                {
                        $sourceQuestionPoolSummaryString = sprintf(
                                        $lng->txt('tst_dyn_quest_set_src_qpl_summary_string_deleted'),
                                        $this->getSourceQuestionPoolTitle()
                        );
                        
                        return $sourceQuestionPoolSummaryString;
                }
                
                foreach($poolRefs as $refId)
                {
                        if( !$this->tree->isDeleted($refId) )
                        {
                                $sourceQuestionPoolSummaryString = sprintf(
                                        $lng->txt('tst_dynamic_question_set_source_questionpool_summary_string'),
                                        $this->getSourceQuestionPoolTitle(),
                                        $this->getQuestionPoolPathString($this->getSourceQuestionPoolId()),
                                        $this->getSourceQuestionPoolNumQuestions()
                                );
                                
                                return $sourceQuestionPoolSummaryString;
                        }
                }
                
                $sourceQuestionPoolSummaryString = sprintf(
                                $lng->txt('tst_dyn_quest_set_src_qpl_summary_string_trashed'),
                                $this->getSourceQuestionPoolTitle(),
                                $this->getSourceQuestionPoolNumQuestions()
                );
                
                return $sourceQuestionPoolSummaryString;
        }
                
        private function getSourceQuestionPoolNumQuestions()
        {
                $query = "
                        SELECT COUNT(*) num from qpl_questions
                        WHERE obj_fi = %s AND original_id IS NULL
                ";
                
                $res = $this->db->queryF(
                                $query, array('integer'), array($this->getSourceQuestionPoolId())
                );
                
                $row = $this->db->fetchAssoc($res);
                
                return $row['num'];
        }
        
        public function areDepenciesInVulnerableState()
        {
                if( !$this->getSourceQuestionPoolId() )
                {
                        return false;
                }
                
                $poolRefs = $this->getSourceQuestionPoolRefIds();
                
                foreach( $poolRefs as $refId )
                {
                        if( !$this->tree->isDeleted($refId) )
                        {
                                return false;
                        }
                }
                
                return true;
        }
        
        public function getDepenciesInVulnerableStateMessage(ilLanguage $lng)
        {
                $msg = sprintf(
                                $lng->txt('tst_dyn_quest_set_pool_trashed'), $this->getSourceQuestionPoolTitle()
                );
                
                return $msg;
        }
        
        public function areDepenciesBroken()
        {
                if( !$this->getSourceQuestionPoolId() )
                {
                        return false;
                }
                
                $poolRefs = $this->getSourceQuestionPoolRefIds();

                if( count($poolRefs) )
                {
                        return false;
                }
                
                return true;
        }
        
        public function getDepenciesBrokenMessage(ilLanguage $lng)
        {
                $msg = sprintf(
                                $lng->txt('tst_dyn_quest_set_pool_deleted'), $this->getSourceQuestionPoolTitle()
                );
                
                return $msg;
        }

        public function isValidRequestOnBrokenQuestionSetDepencies($nextClass, $cmd)
        {
                //vd($nextClass, $cmd);

                if( !$this->testOBJ->participantDataExist() )
                {
                        return true;
                }

                switch( $nextClass )
                {
                        case 'ilobjtestdynamicquestionsetconfiggui':

                        case 'ilmdeditorgui':
                        case 'ilpermissiongui':

                                return true;

                        case 'ilobjtestgui':
                        case '':

                                $cmds = array(
                                        'infoScreen', 'participants', 'npSetFilter', 'npResetFilter',
                                        'deleteAllUserResults', 'confirmDeleteAllUserResults',
                                        'deleteSingleUserResults', 'confirmDeleteSelectedUserData', 'cancelDeleteSelectedUserData'
                                );

                                if( in_array($cmd, $cmds) )
                                {
                                        return true;
                                }

                                break;
                }

                return false;
        }

        public function getHiddenTabsOnBrokenDepencies()
        {
                return array(
                        'settings', 'manscoring', 'scoringadjust', 'statistics', 'history', 'export'
                );
        }
        
        private $sourceQuestionPoolRefIds = null;
        
        public function getSourceQuestionPoolRefIds()
        {
                if( $this->sourceQuestionPoolRefIds === null )
                {
                        $this->sourceQuestionPoolRefIds = ilObject::_getAllReferences($this->getSourceQuestionPoolId());
                }
                
                return $this->sourceQuestionPoolRefIds;
        }
        
        public static function getPoolQuestionChangeListener(ilDB $db, $poolObjId)
        {
                $query = "
                        SELECT obj_fi
                        FROM tst_dyn_quest_set_cfg
                        INNER JOIN tst_tests
                        ON tst_tests.test_id = tst_dyn_quest_set_cfg.test_fi
                        WHERE source_qpl_fi = %s
                ";
                
                $res = $db->queryF($query, array('integer'), array($poolObjId));
                
                require_once 'Modules/Test/classes/class.ilDynamicTestQuestionChangeListener.php';
                $questionChangeListener = new ilDynamicTestQuestionChangeListener($db);
                
                while( $row = $db->fetchAssoc($res) )
                {
                        $questionChangeListener->addTestObjId( $row['obj_fi'] );
                }
                
                return $questionChangeListener;
        }

        public function isResultTaxonomyFilterSupported()
        {
                return false;
        }
        
        public function isAnyQuestionFilterEnabled()
        {
                if( $this->isTaxonomyFilterEnabled() )
                {
                        return true;
                }
                
                if( $this->isAnswerStatusFilterEnabled() )
                {
                        return true;
                }
                
                return false;
        }
}