class.ilAssQuestionHintList.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/classes/class.ilAssQuestionHint.php';

class ilAssQuestionHintList implements Iterator
{
        private $questionHints = array();
        
        public function current() { return current($this->questionHints); }

        public function rewind() { return reset($this->questionHints); }
        
        public function next() { return next($this->questionHints); }
        
        public function key() { return key($this->questionHints); }
        
        public function valid() { return key($this->questionHints) !== null; }
        
        public function __construct() { }
        
        public function addHint(ilAssQuestionHint $questionHint)
        {
                $this->questionHints[] = $questionHint;
        }
        
        public function getHint($hintId)
        {
                foreach($this as $questionHint)
                {
                        /* @var $questionHint ilAssQuestionHint */

                        if( $questionHint->getId() == $hintId )
                        {
                                return $questionHint;
                        }
                }
                
                require_once 'Modules/TestQuestionPool/exceptions/class.ilTestQuestionPoolException.php';
                throw new ilTestQuestionPoolException("hint with id $hintId does not exist in this list");
        }
        
        public function hintExists($hintId)
        {
                foreach($this as $questionHint)
                {
                        /* @var $questionHint ilAssQuestionHint */

                        if( $questionHint->getId() == $hintId )
                        {
                                return true;
                        }
                }
                
                return false;
        }
        
        public function reIndex()
        {
                $counter = 0;
                
                foreach($this as $questionHint)
                {
                        /* @var $questionHint ilAssQuestionHint */
                        
                        $questionHint->setIndex(++$counter);
                        $questionHint->save();
                }
        }
        
        public static function duplicateListForQuestion($originalQuestionId, $duplicateQuestionId)
        {
                $hintIds = array();
                
                $questionHintList = self::getListByQuestionId($originalQuestionId);

                foreach($questionHintList as $questionHint)
                {
                        /* @var $questionHint ilAssQuestionHint */
                        
                        $originalHintId = $questionHint->getId();
                        
                        $questionHint->setId(null);
                        $questionHint->setQuestionId($duplicateQuestionId);
                        
                        $questionHint->save();
                        
                        $duplicateHintId = $questionHint->getId();
                        
                        $hintIds[$originalHintId] = $duplicateHintId;
                }
                
                return $hintIds;
        }
        
        public function getTableData()
        {
                $tableData = array();
                
                foreach($this as $questionHint)
                {
                        /* @var $questionHint ilAssQuestionHint */

                        $tableData[] = array(
                                'hint_id'               => $questionHint->getId(),
                                'hint_index'    => $questionHint->getIndex(),
                                'hint_points'   => $questionHint->getPoints(),
                                'hint_text'             => $questionHint->getText()
                        );
                }
                
                return $tableData;
        }
        
        public static function getListByQuestionId($questionId)
        {
                global $ilDB;
                
                $query = "
                        SELECT          qht_hint_id,
                                                qht_question_fi,
                                                qht_hint_index,
                                                qht_hint_points,
                                                qht_hint_text
                                        
                        FROM            qpl_hints
                        
                        WHERE           qht_question_fi = %s
                        
                        ORDER BY        qht_hint_index ASC
                ";
                
                $res = $ilDB->queryF(
                                $query, array('integer'), array((int)$questionId)
                );
                
                $questionHintList = new self();
                
                while( $row = $ilDB->fetchAssoc($res) )
                {
                        $questionHint = new ilAssQuestionHint();
                        
                        ilAssQuestionHint::assignDbRow($questionHint, $row);
                        
                        $questionHintList->addHint($questionHint);
                }
                
                return $questionHintList;
        }
        
        public static function getListByHintIds($hintIds)
        {
                global $ilDB;
                
                $qht_hint_id__IN__hintIds = $ilDB->in('qht_hint_id', $hintIds, false, 'integer');
                
                $query = "
                        SELECT          qht_hint_id,
                                                qht_question_fi,
                                                qht_hint_index,
                                                qht_hint_points,
                                                qht_hint_text
                                        
                        FROM            qpl_hints
                        
                        WHERE           $qht_hint_id__IN__hintIds
                        
                        ORDER BY        qht_hint_index ASC
                ";
                
                $res = $ilDB->query($query);
                
                $questionHintList = new self();
                
                while( $row = $ilDB->fetchAssoc($res) )
                {
                        $questionHint = new ilAssQuestionHint();
                        
                        ilAssQuestionHint::assignDbRow($questionHint, $row);
                        
                        $questionHintList->addHint($questionHint);
                }
                
                return $questionHintList;
        }
        
        public static function getNextIndexByQuestionId($questionId)
        {
                global $ilDB;
                                
                $query = "
                        SELECT          1 + COALESCE( MAX(qht_hint_index), 0 ) next_index
                                        
                        FROM            qpl_hints
                        
                        WHERE           qht_question_fi = %s
                ";
                
                $res = $ilDB->queryF(
                                $query, array('integer'), array((int)$questionId)
                );
                
                $row = $ilDB->fetchAssoc($res);
                
                return $row['next_index'];
        }
        
        public static function deleteHintsByQuestionIds($questionIds)
        {
                global $ilDB;
                
                $__qht_question_fi__IN__questionIds = $ilDB->in('qht_question_fi', $questionIds, false, 'integer');
                
                $query = "
                        DELETE FROM             qpl_hints
                        WHERE                   $__qht_question_fi__IN__questionIds
                ";
                
                return $ilDB->manipulate($query);
        }
}