class.ilAssQuestionHintTracking.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.ilAssQuestionHintList.php';

class ilAssQuestionHintTracking
{
        private $questionId;
        
        private $activeId;
        
        private $pass;
        
        public function __construct($questionId, $activeId, $pass)
        {
                $this->questionId = $questionId;
                $this->activeId = $activeId;
                $this->pass = $pass;
        }

        public function setActiveId($activeId)
        {
                $this->activeId = $activeId;
        }

        public function getActiveId()
        {
                return $this->activeId;
        }

        public function setPass($pass)
        {
                $this->pass = $pass;
        }

        public function getPass()
        {
                return $this->pass;
        }

        public function setQuestionId($questionId)
        {
                $this->questionId = $questionId;
        }

        public function getQuestionId()
        {
                return $this->questionId;
        }
        
        public function requestsExist()
        {
                if( self::getNumExistingRequests($this->getQuestionId(), $this->getActiveId(), $this->getPass()) > 0 )
                {
                        return true;
                }
                
                return false;
        }

        public function getNumExistingRequests()
        {
                global $ilDB;
                
                $query = "
                        SELECT          COUNT(qhtr_track_id) cnt
                        
                        FROM            qpl_hint_tracking
                        
                        WHERE           qhtr_question_fi = %s
                        AND                     qhtr_active_fi = %s
                        AND                     qhtr_pass = %s
                ";
                
                $res = $ilDB->queryF(
                                $query, array('integer', 'integer', 'integer'),
                                array($this->getQuestionId(), $this->getActiveId(), $this->getPass())
                );
                
                $row = $ilDB->fetchAssoc($res);
                
                return $row['cnt'];
        }

        public function requestsPossible()
        {
                global $ilDB;
                
                $query = "
                        SELECT          COUNT(qht_hint_id) cnt_available,
                                                COUNT(qhtr_track_id) cnt_requested
                        
                        FROM            qpl_hints
                        
                        LEFT JOIN       qpl_hint_tracking
                        ON                      qhtr_hint_fi = qht_hint_id
                        AND                     qhtr_active_fi = %s
                        AND                     qhtr_pass = %s
                        
                        WHERE           qht_question_fi = %s
                ";
                
                $res = $ilDB->queryF(
                                $query, array('integer', 'integer', 'integer'),
                                array($this->getActiveId(), $this->getPass(), $this->getQuestionId())
                );
                
                $row = $ilDB->fetchAssoc($res);
                
                if( $row['cnt_available'] > $row['cnt_requested'] )
                {
                        return true;
                }
                
                return false;
        }
        
        public function isRequested($hintId)
        {
                global $ilDB;
                
                $query = "
                        SELECT          COUNT(qhtr_track_id) cnt
                        
                        FROM            qpl_hint_tracking
                        
                        WHERE           qhtr_hint_fi = %s
                        AND                     qhtr_active_fi = %s
                        AND                     qhtr_pass = %s
                ";
                
                $res = $ilDB->queryF(
                                $query, array('integer', 'integer', 'integer'), array($hintId, $this->getActiveId(), $this->getPass())
                );
                
                $row = $ilDB->fetchAssoc($res);
                
                if( $row['cnt'] > 0 )
                {
                        return true;
                }
                
                return false;
        }
        
        public function getNextRequestableHint()
        {
                global $ilDB;
                
                $query = "
                        SELECT          qht_hint_id
                        
                        FROM            qpl_hints
                        
                        LEFT JOIN       qpl_hint_tracking
                        ON                      qhtr_hint_fi = qht_hint_id
                        AND                     qhtr_active_fi = %s
                        AND                     qhtr_pass = %s
                        
                        WHERE           qht_question_fi = %s
                        AND                     qhtr_track_id IS NULL
                        
                        ORDER BY        qht_hint_index ASC
                ";
                
                $ilDB->setLimit(1);
                
                $res = $ilDB->queryF(
                                $query, array('integer', 'integer', 'integer'),
                                array($this->getActiveId(), $this->getPass(), $this->getQuestionId())
                );
                
                while( $row = $ilDB->fetchAssoc($res) )
                {
                        $nextHint = ilAssQuestionHint::getInstanceById($row['qht_hint_id']);
                        
                        return $nextHint;
                }
                
                require_once 'Modules/Test/exceptions/class.ilTestNoNextRequestableHintExistsException.php';
                
                throw new ilTestNoNextRequestableHintExistsException(
                        "no next hint found for questionId={$this->getQuestionId()}, activeId={$this->getActiveId()}, pass={$this->getPass()}"
                );
        }
        
        public function getRequestedHintsList()
        {
                global $ilDB;
                
                $query = "
                        SELECT          qhtr_hint_fi
                        
                        FROM            qpl_hint_tracking
                        
                        WHERE           qhtr_question_fi = %s
                        AND                     qhtr_active_fi = %s
                        AND                     qhtr_pass = %s
                ";
                
                $res = $ilDB->queryF(
                                $query, array('integer', 'integer', 'integer'),
                                array($this->getQuestionId(), $this->getActiveId(), $this->getPass())
                );
                
                $hintIds = array();
                
                while( $row = $ilDB->fetchAssoc($res) )
                {
                        $hintIds[] = $row['qhtr_hint_fi'];
                }
                
                $requestedHintsList = ilAssQuestionHintList::getListByHintIds($hintIds);
                
                return $requestedHintsList;
        }
        
        public function storeRequest(ilAssQuestionHint $questionHint)
        {
                global $ilDB;
                
                $trackId = $ilDB->nextId('qpl_hint_tracking');
                
                $ilDB->insert('qpl_hint_tracking', array(
                        'qhtr_track_id'         => array('integer', $trackId),
                        'qhtr_active_fi'        => array('integer', $this->getActiveId()),
                        'qhtr_pass'                     => array('integer', $this->getPass()),
                        'qhtr_question_fi'      => array('integer', $this->getQuestionId()),
                        'qhtr_hint_fi'          => array('integer', $questionHint->getId()),
                ));
        }
        
        public function getRequestStatisticDataByQuestionAndTestpass()
        {
                global $ilDB;
                
                $query = "
                        SELECT          COUNT(qhtr_track_id) requests_count,
                                                SUM(qht_hint_points) requests_points
                        
                        FROM            qpl_hint_tracking
                        
                        INNER JOIN      qpl_hints
                        ON                      qht_hint_id = qhtr_hint_fi
                        
                        WHERE           qhtr_question_fi = %s
                        AND                     qhtr_active_fi = %s
                        AND                     qhtr_pass = %s
                ";
                
                $res = $ilDB->queryF(
                                $query, array('integer', 'integer', 'integer'),
                                array($this->getQuestionId(), $this->getActiveId(), $this->getPass())
                );
                
                $row = $ilDB->fetchAssoc($res);
                
                if( $row['requests_points'] === null )
                {
                        $row['requests_points'] = 0;
                }
                
                require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintRequestStatisticData.php';
                
                $requestsStatisticData = new ilAssQuestionHintRequestStatisticData();
                $requestsStatisticData->setRequestsCount($row['requests_count']);
                $requestsStatisticData->setRequestsPoints($row['requests_points']);
                
                return $requestsStatisticData;
        }
        
        public static function getRequestRequestStatisticDataRegisterByActiveId($activeId)
        {
                require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintRequestStatisticRegister.php';
                require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintRequestStatisticData.php';
                
                /* @var ILIAS\DI\Container $DIC */ global $DIC; $db = $DIC->database();
                
                $query = "
                        SELECT          qhtr_pass requests_pass,
                                                qhtr_question_fi requests_question,
                                                COUNT(qhtr_track_id) requests_count,
                                                SUM(qht_hint_points) requests_points
                        
                        FROM            qpl_hint_tracking
                        
                        INNER JOIN      qpl_hints
                        ON                      qht_hint_id = qhtr_hint_fi
                        
                        WHERE           qhtr_active_fi = %s
                        
                        GROUP BY        qhtr_pass, qhtr_question_fi
                ";
                
                $res = $db->queryF(
                        $query, array('integer'), array($activeId)
                );
                
                $register = new ilAssQuestionHintRequestStatisticRegister();
                
                while( $row = $db->fetchAssoc($res) )
                {
                        if( $row['requests_points'] === null )
                        {
                                $row['requests_points'] = 0;
                        }
                        
                        $requestsStatisticData = new ilAssQuestionHintRequestStatisticData();
                        $requestsStatisticData->setRequestsCount($row['requests_count']);
                        $requestsStatisticData->setRequestsPoints($row['requests_points']);
                        
                        $register->addRequestByTestPassIndexAndQuestionId($row['requests_pass'], $row['requests_question'], $requestsStatisticData);
                }
                
                return $register;
        }
        
        public static function deleteRequestsByQuestionIds($questionIds)
        {
                global $ilDB;

                $__question_fi__IN__questionIds = $ilDB->in('qhtr_question_fi', $questionIds, false, 'integer');

                $query = "
                        DELETE FROM     qpl_hint_tracking
                        WHERE           $__question_fi__IN__questionIds
                ";

                $ilDB->manipulate($query);
        }
        
        public static function deleteRequestsByActiveIds($activeIds)
        {
                global $ilDB;
                
                $__active_fi__IN__activeIds = $ilDB->in('qhtr_active_fi', $activeIds, false, 'integer');
                
                $query = "
                        DELETE FROM     qpl_hint_tracking
                        WHERE           $__active_fi__IN__activeIds
                ";
                
                $ilDB->manipulate($query);
        }
}