class.ilAssQuestionList.php

Go to the documentation of this file.

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

require_once 'Services/Taxonomy/interfaces/interface.ilTaxAssignedItemInfo.php';
require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssQuestionType.php';

class ilAssQuestionList implements ilTaxAssignedItemInfo
{
        protected $db = null;
        
        private $lng = null;
        
        private $pluginAdmin = null;

        private $parentObjIdsFilter = array();

        private $parentObjId = null;

        private $parentObjType = 'qpl';
        
        private $availableTaxonomyIds = array();
        
        private $fieldFilters = array();

        private $taxFilters = array();

        private $taxParentIds = array();
        
        private $taxParentTypes = array();
        
        private $answerStatusActiveId = null;

        private $forcedQuestionIds = array();

        protected $join_obj_data = true;


        const QUESTION_ANSWER_STATUS_NON_ANSWERED = 'nonAnswered';
        const QUESTION_ANSWER_STATUS_WRONG_ANSWERED = 'wrongAnswered';
        const QUESTION_ANSWER_STATUS_CORRECT_ANSWERED = 'correctAnswered';

        const ANSWER_STATUS_FILTER_ALL_NON_CORRECT = 'allNonCorrect';
        const ANSWER_STATUS_FILTER_NON_ANSWERED_ONLY = 'nonAnswered';
        const ANSWER_STATUS_FILTER_WRONG_ANSWERED_ONLY = 'wrongAnswered';
        
        private $answerStatusFilter = null;
        
        const QUESTION_INSTANCE_TYPE_ORIGINALS = 'QST_INSTANCE_TYPE_ORIGINALS';
        const QUESTION_INSTANCE_TYPE_DUPLICATES = 'QST_INSTANCE_TYPE_DUPLICATES';
        private $questionInstanceTypeFilter = self::QUESTION_INSTANCE_TYPE_ORIGINALS;
        
        private $includeQuestionIdsFilter = null;
        private $excludeQuestionIdsFilter = null;
        
        const QUESTION_COMPLETION_STATUS_COMPLETE = 'complete';
        const QUESTION_COMPLETION_STATUS_INCOMPLETE = 'incomplete';
        const QUESTION_COMPLETION_STATUS_BOTH = 'complete/incomplete';
        private $questionCompletionStatusFilter = self::QUESTION_COMPLETION_STATUS_BOTH;
        
        protected $questions = array();
        
        public function __construct(ilDBInterface $db, ilLanguage $lng, ilPluginAdmin $pluginAdmin)
        {
                $this->db = $db;
                $this->lng = $lng;
                $this->pluginAdmin = $pluginAdmin;
        }

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

        public function setParentObjId($parentObjId)
        {
                $this->parentObjId = $parentObjId;
        }

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

        public function setParentObjectType($parentObjType)
        {
                $this->parentObjType = $parentObjType;
        }

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

        public function setParentObjIdsFilter($parentObjIdsFilter)
        {
                $this->parentObjIdsFilter = $parentObjIdsFilter;
        }

        public function setQuestionInstanceTypeFilter($questionInstanceTypeFilter)
        {
                $this->questionInstanceTypeFilter = $questionInstanceTypeFilter;
        }

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

        public function setIncludeQuestionIdsFilter($questionIdsFilter)
        {
                $this->includeQuestionIdsFilter = $questionIdsFilter;
        }

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

        public function getExcludeQuestionIdsFilter()
        {
                return $this->excludeQuestionIdsFilter;
        }
        
        public function setExcludeQuestionIdsFilter($excludeQuestionIdsFilter)
        {
                $this->excludeQuestionIdsFilter = $excludeQuestionIdsFilter;
        }

        public function getQuestionCompletionStatusFilter()
        {
                return $this->questionCompletionStatusFilter;
        }
        
        public function setQuestionCompletionStatusFilter($questionCompletionStatusFilter)
        {
                $this->questionCompletionStatusFilter = $questionCompletionStatusFilter;
        }

        public function addFieldFilter($fieldName, $fieldValue)
        {
                $this->fieldFilters[$fieldName] = $fieldValue;
        }
        
        public function addTaxonomyFilter($taxId, $taxNodes, $parentObjId, $parentObjType)
        {
                $this->taxFilters[$taxId] = $taxNodes;
                $this->taxParentIds[$taxId] = $parentObjId;
                $this->taxParentTypes[$taxId] = $parentObjType;
        }
        
        public function setAvailableTaxonomyIds($availableTaxonomyIds)
        {
                $this->availableTaxonomyIds = $availableTaxonomyIds;
        }
        
        public function getAvailableTaxonomyIds()
        {
                return $this->availableTaxonomyIds;
        }

        public function setAnswerStatusActiveId($answerStatusActiveId)
        {
                $this->answerStatusActiveId = $answerStatusActiveId;
        }

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

        public function setAnswerStatusFilter($answerStatusFilter)
        {
                $this->answerStatusFilter = $answerStatusFilter;
        }

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

        public function setJoinObjectData($a_val)
        {
                $this->join_obj_data = $a_val;
        }
        
        public function getJoinObjectData()
        {
                return $this->join_obj_data;
        }
        
        public function setForcedQuestionIds($forcedQuestionIds)
        {
                $this->forcedQuestionIds = $forcedQuestionIds;
        }

        public function getForcedQuestionIds()
        {
                return $this->forcedQuestionIds;
        }
        
        private function getParentObjFilterExpression()
        {
                if( $this->getParentObjId() )
                {
                        return 'qpl_questions.obj_fi = '.$this->db->quote($this->getParentObjId(), 'integer');
                }
                
                if( count($this->getParentObjIdsFilter()) )
                {
                        return $this->db->in('qpl_questions.obj_fi', $this->getParentObjIdsFilter(), false, 'integer');
                }
                
                return null;
        }
        
        private function getFieldFilterExpressions()
        {
                $expressions = array();
                
                foreach($this->fieldFilters as $fieldName => $fieldValue)
                {
                        switch($fieldName)
                        {
                                case 'title':
                                case 'description':
                                case 'author':
                                        
                                        $expressions[] = $this->db->like('qpl_questions.' . $fieldName, 'text', "%%$fieldValue%%");
                                        break;
                                        
                                case 'type':
                                        
                                        $expressions[] = "qpl_qst_type.type_tag = {$this->db->quote($fieldValue, 'text')}";
                                        break;

                                case 'question_id':
                                        if ($fieldValue != "" && !is_array($fieldValue))
                                        {
                                                $fieldValue = array($fieldValue);
                                        }
                                        $expressions[] = $this->db->in("qpl_questions.question_id", $fieldValue, false, "integer");
                                        break;
                                
                                case 'parent_title':
                                        if ($this->join_obj_data)
                                        {
                                                $expressions[] = $this->db->like('object_data.title', 'text', "%%$fieldValue%%");
                                        }
                                        break;
                        }
                }
                
                return $expressions;
        }
        
        private function getTaxonomyFilterExpressions()
        {
                $expressions = array();

                require_once 'Services/Taxonomy/classes/class.ilTaxonomyTree.php';
                require_once 'Services/Taxonomy/classes/class.ilTaxNodeAssignment.php';

                foreach($this->taxFilters as $taxId => $taxNodes)
                {
                        $questionIds = array();

                        $forceBypass = true;

                        foreach($taxNodes as $taxNode)
                        {
                                $forceBypass = false;

                                $taxItemsByTaxParent = $this->getTaxItems(
                                        $this->taxParentTypes[$taxId], $this->taxParentIds[$taxId],
                                                $taxId, $taxNode
                                );

                                $taxItemsByParent = $this->getTaxItems(
                                        $this->parentObjType, $this->parentObjId,
                                        $taxId, $taxNode
                                );

                                $taxItems = array_merge($taxItemsByTaxParent, $taxItemsByParent);
                                foreach($taxItems as $taxItem)
                                {
                                        $questionIds[$taxItem['item_id']] = $taxItem['item_id'];
                                }
                        }

                        if( !$forceBypass )
                        {
                                $expressions[] = $this->db->in('question_id', $questionIds, false, 'integer');
                        }
                }

                return $expressions;
        }

        protected function getTaxItems($parentType, $parentObjId, $taxId, $taxNode)
        {
                $taxTree = new ilTaxonomyTree($taxId);

                $taxNodeAssignment   = new ilTaxNodeAssignment(
                        $parentType, $parentObjId, 'quest', $taxId
                );

                $subNodes            = $taxTree->getSubTreeIds($taxNode);
                $subNodes[]          = $taxNode;

                return $taxNodeAssignment->getAssignmentsOfNode($subNodes);
        }

        private function getQuestionInstanceTypeFilterExpression()
        {
                switch( $this->getQuestionInstanceTypeFilter() )
                {
                        case self::QUESTION_INSTANCE_TYPE_ORIGINALS:

                                return 'qpl_questions.original_id IS NULL';

                        case self::QUESTION_INSTANCE_TYPE_DUPLICATES:

                                return 'qpl_questions.original_id IS NOT NULL';
                }

                return null;
        }

        private function getQuestionIdsFilterExpressions()
        {
                $expressions = array();
                
                if( is_array($this->getIncludeQuestionIdsFilter()) )
                {
                        $expressions[] = $this->db->in(
                                'qpl_questions.question_id', $this->getIncludeQuestionIdsFilter(), false, 'integer'
                        );
                }

                if( is_array($this->getExcludeQuestionIdsFilter()) )
                {
                        $IN = $this->db->in(
                                'qpl_questions.question_id', $this->getExcludeQuestionIdsFilter(), true, 'integer'
                        );
                        
                        if($IN == ' 1=2 ') { $IN = ' 1=1 '; } // required for ILIAS < 5.0
                        
                        $expressions[] = $IN;
                }
                
                return $expressions;
        }
        
        private function getParentObjectIdFilterExpression()
        {
                if( $this->parentObjId )
                {
                        return "qpl_questions.obj_fi = {$this->db->quote($this->parentObjId, 'integer')}";
                }
                
                return null;
        }
        
        private function getAnswerStatusFilterExpressions()
        {
                $expressions = array();
                
                switch( $this->getAnswerStatusFilter() )
                {
                        case self::ANSWER_STATUS_FILTER_ALL_NON_CORRECT:
                                
                                $expressions[] = '
                                        (tst_test_result.question_fi IS NULL OR tst_test_result.points < qpl_questions.points)
                                ';
                                break;
                                
                        case self::ANSWER_STATUS_FILTER_NON_ANSWERED_ONLY:

                                $expressions[] = 'tst_test_result.question_fi IS NULL';
                                break;

                        case self::ANSWER_STATUS_FILTER_WRONG_ANSWERED_ONLY:
                                
                                $expressions[] = 'tst_test_result.question_fi IS NOT NULL';
                                $expressions[] = 'tst_test_result.points < qpl_questions.points';
                                break;
                }
                
                return $expressions;
        }
        
        private function getTableJoinExpression()
        {
                $tableJoin = "
                        INNER JOIN      qpl_qst_type
                        ON                      qpl_qst_type.question_type_id = qpl_questions.question_type_fi
                ";

                if ($this->join_obj_data)
                {
                        $tableJoin .= "
                                INNER JOIN      object_data
                                ON                      object_data.obj_id = qpl_questions.obj_fi
                        ";
                }
                
                if( $this->getAnswerStatusActiveId() )
                {
                        $tableJoin .= "
                                LEFT JOIN       tst_test_result
                                ON                      tst_test_result.question_fi = qpl_questions.question_id
                                AND                     tst_test_result.active_fi = {$this->db->quote($this->getAnswerStatusActiveId(), 'integer')}
                        ";
                }
                
                return $tableJoin;
        }
        
        private function getConditionalFilterExpression()
        {
                $CONDITIONS = array();

                if( $this->getQuestionInstanceTypeFilterExpression() !== null )
                {
                        $CONDITIONS[] = $this->getQuestionInstanceTypeFilterExpression();
                }
                
                if( $this->getParentObjFilterExpression() !== null )
                {
                        $CONDITIONS[] = $this->getParentObjFilterExpression();
                }

                if( $this->getParentObjectIdFilterExpression() !== null )
                {
                        $CONDITIONS[] = $this->getParentObjectIdFilterExpression();
                }
                
                $CONDITIONS = array_merge($CONDITIONS,
                        $this->getQuestionIdsFilterExpressions(),
                        $this->getFieldFilterExpressions(),
                        $this->getTaxonomyFilterExpressions(),
                        $this->getAnswerStatusFilterExpressions()
                );
                
                $CONDITIONS = implode(' AND ', $CONDITIONS);
                
                return strlen($CONDITIONS) ? 'AND '.$CONDITIONS : '';
        }
        
        private function getSelectFieldsExpression()
        {
                $selectFields = array(
                        'qpl_questions.*',
                        'qpl_qst_type.type_tag',
                        'qpl_qst_type.plugin',
                        'qpl_qst_type.plugin_name',
                        'qpl_questions.points max_points'
                );

                if ($this->join_obj_data)
                {
                        $selectFields[] = 'object_data.title parent_title';
                }

                if( $this->getAnswerStatusActiveId() )
                {
                        $selectFields[] = 'tst_test_result.points reached_points';
                        $selectFields[] = "CASE
                                        WHEN tst_test_result.points IS NULL THEN '".self::QUESTION_ANSWER_STATUS_NON_ANSWERED."'
                                        WHEN tst_test_result.points < qpl_questions.points THEN '".self::QUESTION_ANSWER_STATUS_WRONG_ANSWERED."'
                                        ELSE '".self::QUESTION_ANSWER_STATUS_CORRECT_ANSWERED."'
                                END question_answer_status
                        ";
                }

                $selectFields = implode(",\n\t\t\t\t", $selectFields);
                
                return "
                        SELECT          {$selectFields}
                ";
        }
        
        private function buildBasicQuery()
        {
                return "
                        {$this->getSelectFieldsExpression()}
                        
                        FROM            qpl_questions
                        
                        {$this->getTableJoinExpression()}
                        
                        WHERE           qpl_questions.tstamp > 0
                ";
        }
        
        private function buildQuery()
        {
                $query = $this->buildBasicQuery()."
                        {$this->getConditionalFilterExpression()}
                ";
                
                if( count($this->getForcedQuestionIds()) )
                {
                        $query .= "
                                UNION {$this->buildBasicQuery()}
                                AND     {$this->db->in('qpl_questions.question_id', $this->getForcedQuestionIds(), false, 'integer')}
                        ";
                }

                return $query;
        }
        
        public function load()
        {
                $this->checkFilters();
                
                $query = $this->buildQuery();

                #vd($query);

                $res = $this->db->query($query);

                //echo $this->db->db->last_query;

                #vd($this->db->db->last_query);
                
                while( $row = $this->db->fetchAssoc($res) )
                {
                        $row = ilAssQuestionType::completeMissingPluginName($row);
                        
                        if( !$this->isActiveQuestionType($row) )
                        {
                                continue;
                        }

                        $row['taxonomies'] = $this->loadTaxonomyAssignmentData($row['obj_fi'], $row['question_id']);
                        
                        $row['ttype'] = $this->lng->txt($row['type_tag']);
                        
                        $this->questions[ $row['question_id'] ] = $row;
                }
        }
        
        private function loadTaxonomyAssignmentData($parentObjId, $questionId)
        {
                $taxAssignmentData = array();

                foreach($this->getAvailableTaxonomyIds() as $taxId)
                {
                        require_once 'Services/Taxonomy/classes/class.ilTaxonomyTree.php';
                        require_once 'Services/Taxonomy/classes/class.ilTaxNodeAssignment.php';
                
                        $taxTree = new ilTaxonomyTree($taxId);
                        
                        $taxAssignment = new ilTaxNodeAssignment('qpl', $parentObjId, 'quest', $taxId);
                        
                        $assignments = $taxAssignment->getAssignmentsOfItem($questionId);
                        
                        foreach($assignments as $assData)
                        {
                                if( !isset($taxAssignmentData[ $assData['tax_id'] ]) )
                                {
                                        $taxAssignmentData[ $assData['tax_id'] ] = array();
                                }
                                
                                $nodeData = $taxTree->getNodeData($assData['node_id']);
                                
                                $assData['node_lft'] = $nodeData['lft'];
                                
                                $taxAssignmentData[ $assData['tax_id'] ][ $assData['node_id'] ] = $assData;
                        }
                }
                
                return $taxAssignmentData;
        }
        
        private function isActiveQuestionType($questionData)
        {
                if( !isset($questionData['plugin']) )
                {
                        return false;
                }
                
                if( !$questionData['plugin'] )
                {
                        return true;
                }
                
                return $this->pluginAdmin->isActive(IL_COMP_MODULE, 'TestQuestionPool', 'qst', $questionData['plugin_name']);
        }

        public function getDataArrayForQuestionId($questionId)
        {
                return $this->questions[$questionId];
        }

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

        public function isInList($questionId)
        {
                return isset($this->questions[$questionId]);
        }

        public function getTitle($a_comp_id, $a_item_type, $a_item_id)
        {
                if( $a_comp_id != 'qpl' || $a_item_type != 'quest' || !(int)$a_item_id )
                {
                        return '';
                }
                
                if( !isset($this->questions[$a_item_id]) )
                {
                        return '';
                }
                
                return $this->questions[$a_item_id]['title'];
        }
        
        private function checkFilters()
        {
                if( strlen($this->getAnswerStatusFilter()) && !$this->getAnswerStatusActiveId() )
                {
                        require_once 'Modules/TestQuestionPool/exceptions/class.ilTestQuestionPoolException.php';
                        
                        throw new ilTestQuestionPoolException(
                                'No active id given! You cannot use the answer status filter without giving an active id.'
                        );
                }
                
        }
}