ilAssQuestionHintTracking Class Reference

Collaboration diagram for ilAssQuestionHintTracking:

Public Member Functions
	__construct ($questionId, $activeId, $pass)
	setActiveId ($activeId)
	getActiveId ()
	setPass ($pass)
	getPass ()
	setQuestionId ($questionId)
	getQuestionId ()
	requestsExist ()
	Returns the fact wether there exists hint requests for the given question relating to the given testactive and testpass or not. More...
	getNumExistingRequests ()
	Returns the number existing hint requests for the given question relating to the given testactive and testpass or not. More...
	requestsPossible ()
	Returns the fact wether (further) hint requests are possible for the given question relating to the given testactive and testpass or not. More...
	isRequested ($hintId)
	Returns the fact wether the hint for given id is requested for the given testactive and testpass. More...
	getNextRequestableHint ()
	Returns the next requestable hint for given question relating to given testactive and testpass. More...
	getRequestedHintsList ()
	Returns an object of class ilAssQuestionHintList containing objects of class ilAssQuestionHint for all allready requested hints relating to the given question, testactive and testpass. More...
	storeRequest (ilAssQuestionHint $questionHint)
	Tracks the given hint as requested for the given question, testactive and testpass. More...
	getRequestStatisticDataByQuestionAndTestpass ()
	Returns a question hint request statistic data container containing the statistics for all requests relating to given ... More...

Static Public Member Functions
static	getRequestRequestStatisticDataRegisterByActiveId ($activeId)
static	deleteRequestsByActiveIds ($activeIds)
	Deletes all hint requests relating to a testactive included in given active ids. More...

Private Attributes
	$questionId
	$activeId
	$pass

Detailed Description

Definition at line 27 of file class.ilAssQuestionHintTracking.php.

Constructor & Destructor Documentation

__construct()

ilAssQuestionHintTracking::__construct	(		$questionId,
			$activeId,
			$pass
	)

Definition at line 35 of file class.ilAssQuestionHintTracking.php.

References $activeId, $pass, and $questionId.

    {
        $this->questionId = $questionId;
        $this->activeId = $activeId;
        $this->pass = $pass;
    }

Member Function Documentation

deleteRequestsByActiveIds()

static ilAssQuestionHintTracking::deleteRequestsByActiveIds (   $activeIds )

static

Deletes all hint requests relating to a testactive included in given active ids.

public ilDBInterface $ilDB

Parameters

array[integer]

$activeIds

Definition at line 451 of file class.ilAssQuestionHintTracking.php.

References $DIC, $ilDB, and $query.

Referenced by ilObjTest\removeTestResultsByActiveIds().

                                                                : void
    {
        global $DIC;
        $ilDB = $DIC['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);
    }

Here is the caller graph for this function:

getActiveId()

ilAssQuestionHintTracking::getActiveId

(

)

Definition at line 47 of file class.ilAssQuestionHintTracking.php.

References $activeId.

Referenced by getNextRequestableHint(), getNumExistingRequests(), getRequestedHintsList(), getRequestStatisticDataByQuestionAndTestpass(), isRequested(), requestsExist(), requestsPossible(), and storeRequest().

    {
        return $this->activeId;
    }

Here is the caller graph for this function:

getNextRequestableHint()

ilAssQuestionHintTracking::getNextRequestableHint

(

)

Returns the next requestable hint for given question relating to given testactive and testpass.

public ilDBInterface $ilDB

Returns

ilAssQuestionHint $nextRequestableHint

Exceptions

ilTestException

Definition at line 213 of file class.ilAssQuestionHintTracking.php.

References $DIC, $ilDB, $query, $res, getActiveId(), ilAssQuestionHint\getInstanceById(), getPass(), and getQuestionId().

                                            : ilAssQuestionHint
    {
        global $DIC;
        $ilDB = $DIC['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()}"
        );
    }

Here is the call graph for this function:

getNumExistingRequests()

ilAssQuestionHintTracking::getNumExistingRequests

(

)

Returns the number existing hint requests for the given question relating to the given testactive and testpass or not.

public ilDBInterface $ilDB

Returns

integer $numExisingRequests

Definition at line 97 of file class.ilAssQuestionHintTracking.php.

References $DIC, $ilDB, $query, $res, getActiveId(), getPass(), and getQuestionId().

                                            : int
    {
        global $DIC;
        $ilDB = $DIC['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'];
    }

Here is the call graph for this function:

getPass()

ilAssQuestionHintTracking::getPass

(

)

Definition at line 57 of file class.ilAssQuestionHintTracking.php.

References $pass.

Referenced by getNextRequestableHint(), getNumExistingRequests(), getRequestedHintsList(), getRequestStatisticDataByQuestionAndTestpass(), isRequested(), requestsExist(), requestsPossible(), and storeRequest().

    {
        return $this->pass;
    }

Here is the caller graph for this function:

getQuestionId()

ilAssQuestionHintTracking::getQuestionId

(

)

Definition at line 67 of file class.ilAssQuestionHintTracking.php.

References $questionId.

Referenced by getNextRequestableHint(), getNumExistingRequests(), getRequestedHintsList(), getRequestStatisticDataByQuestionAndTestpass(), requestsExist(), requestsPossible(), and storeRequest().

    {
        return $this->questionId;
    }

Here is the caller graph for this function:

getRequestedHintsList()

ilAssQuestionHintTracking::getRequestedHintsList

(

)

Returns an object of class ilAssQuestionHintList containing objects of class ilAssQuestionHint for all allready requested hints relating to the given question, testactive and testpass.

public ilDBInterface $ilDB

Returns

ilAssQuestionHintList $requestedHintsList

Definition at line 264 of file class.ilAssQuestionHintTracking.php.

References $DIC, $ilDB, $query, $res, getActiveId(), ilAssQuestionHintList\getListByHintIds(), getPass(), and getQuestionId().

                                           : ilAssQuestionHintList
    {
        global $DIC;
        $ilDB = $DIC['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;
    }

Here is the call graph for this function:

getRequestRequestStatisticDataRegisterByActiveId()

static ilAssQuestionHintTracking::getRequestRequestStatisticDataRegisterByActiveId (   $activeId )

static

Parameters

integer

$activeId

Returns

ilAssQuestionHintRequestStatisticRegister

Definition at line 375 of file class.ilAssQuestionHintTracking.php.

References $activeId, $DIC, $ilDB, $query, and $res.

Referenced by ilTestServiceGUI\getPassOverviewTableData().

                                                                                      : ilAssQuestionHintRequestStatisticRegister
    {
        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;
    }

Here is the caller graph for this function:

getRequestStatisticDataByQuestionAndTestpass()

ilAssQuestionHintTracking::getRequestStatisticDataByQuestionAndTestpass

(

)

Returns a question hint request statistic data container containing the statistics for all requests relating to given ...

• question
• testactive
• testpass

public ilDBInterface $ilDB

Returns

ilAssQuestionHintRequestStatisticData $requestsStatisticData

Definition at line 331 of file class.ilAssQuestionHintTracking.php.

References $DIC, $ilDB, $query, $res, getActiveId(), getPass(), and getQuestionId().

                                                                  : ilAssQuestionHintRequestStatisticData
    {
        global $DIC;
        $ilDB = $DIC['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;
    }

Here is the call graph for this function:

isRequested()

ilAssQuestionHintTracking::isRequested

(

$hintId

)

Returns the fact wether the hint for given id is requested for the given testactive and testpass.

public ilDBInterface $ilDB

Parameters

integer

$hintId

Returns

boolean $isRequested

Definition at line 174 of file class.ilAssQuestionHintTracking.php.

References $DIC, $ilDB, $query, $res, getActiveId(), and getPass().

                                        : bool
    {
        global $DIC;
        $ilDB = $DIC['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;
    }

Here is the call graph for this function:

requestsExist()

ilAssQuestionHintTracking::requestsExist

(

)

Returns the fact wether there exists hint requests for the given question relating to the given testactive and testpass or not.

public ilDBInterface $ilDB

Returns

boolean $requestsExist

Definition at line 80 of file class.ilAssQuestionHintTracking.php.

References getActiveId(), getPass(), and getQuestionId().

                                   : bool
    {
        if (self::getNumExistingRequests($this->getQuestionId(), $this->getActiveId(), $this->getPass()) > 0) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

requestsPossible()

ilAssQuestionHintTracking::requestsPossible

(

)

Returns the fact wether (further) hint requests are possible for the given question relating to the given testactive and testpass or not.

public ilDBInterface $ilDB

Returns

boolean $requestsPossible

Definition at line 131 of file class.ilAssQuestionHintTracking.php.

References $DIC, $ilDB, $query, $res, getActiveId(), getPass(), and getQuestionId().

                                      : bool
    {
        global $DIC;
        $ilDB = $DIC['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;
    }

Here is the call graph for this function:

setActiveId()

ilAssQuestionHintTracking::setActiveId

(

$activeId

)

Definition at line 42 of file class.ilAssQuestionHintTracking.php.

References $activeId.

                                          : void
    {
        $this->activeId = $activeId;
    }

setPass()

ilAssQuestionHintTracking::setPass

(

$pass

)

Definition at line 52 of file class.ilAssQuestionHintTracking.php.

References $pass.

                                  : void
    {
        $this->pass = $pass;
    }

setQuestionId()

ilAssQuestionHintTracking::setQuestionId

(

$questionId

)

Definition at line 62 of file class.ilAssQuestionHintTracking.php.

References $questionId.

                                              : void
    {
        $this->questionId = $questionId;
    }

storeRequest()

ilAssQuestionHintTracking::storeRequest

(

ilAssQuestionHint

$questionHint

)

Tracks the given hint as requested for the given question, testactive and testpass.

public ilDBInterface $ilDB

Parameters

ilAssQuestionHint

$questionHint

Definition at line 304 of file class.ilAssQuestionHintTracking.php.

References $DIC, $ilDB, getActiveId(), ilAssQuestionHint\getId(), getPass(), and getQuestionId().

                                                                 : void
    {
        global $DIC;
        $ilDB = $DIC['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()),
        ));
    }

Here is the call graph for this function:

Field Documentation

$activeId

ilAssQuestionHintTracking::$activeId

private

Definition at line 31 of file class.ilAssQuestionHintTracking.php.

Referenced by __construct(), getActiveId(), getRequestRequestStatisticDataRegisterByActiveId(), and setActiveId().

$pass

ilAssQuestionHintTracking::$pass

private

Definition at line 33 of file class.ilAssQuestionHintTracking.php.

Referenced by __construct(), getPass(), and setPass().

$questionId

ilAssQuestionHintTracking::$questionId

private

Definition at line 29 of file class.ilAssQuestionHintTracking.php.

Referenced by __construct(), getQuestionId(), and setQuestionId().

---

The documentation for this class was generated from the following file:

• Modules/TestQuestionPool/classes/class.ilAssQuestionHintTracking.php