Inheritance diagram for ilAssQuestionHintList:

Collaboration diagram for ilAssQuestionHintList:

Public Member Functions
	current ()

	rewind ()

	next ()

	key ()

	valid ()

	__construct ()

	addHint (ilAssQuestionHint $questionHint)

	getHint ($hintId)

	hintExists ($hintId)

	reIndex ()
	re-indexes the list's hints sequentially by current order (starting with index "1") ATTENTION: it also persists this index to db by performing an update of hint object via id. More...

	getTableData ()
	returns an array with data of the hints in this list that is adopted to be used as table gui data More...

Static Public Member Functions
static	duplicateListForQuestion ($originalQuestionId, $duplicateQuestionId)
	duplicates a hint list from given original question id to given duplicate question id and returns an array of duplicate hint ids mapped to the corresponding original hint ids More...

static	getListByQuestionId ($questionId)
	instantiates a question hint list for the passed question id More...

static	getListByHintIds ($hintIds)
	instantiates a question hint list for the passed hint ids More...

static	getNextIndexByQuestionId ($questionId)
	determines the next index to be used for a new hint that is to be added to the list of existing hints regarding to the question with passed question id More...

static	deleteHintsByQuestionIds (array $questionIds)
	Deletes all question hints relating to questions included in given question ids. More...

Private Attributes
array	$questionHints = []

Detailed Description

Definition at line 28 of file class.ilAssQuestionHintList.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionHintList::__construct ( )

Definition at line 58 of file class.ilAssQuestionHintList.php.

59 {

60 }

Member Function Documentation

◆ addHint()

ilAssQuestionHintList::addHint ( ilAssQuestionHint $questionHint )

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

Referenced by ilAssQuestionHintsGUI\pasteFromOrderingClipboardAfterCmd().

                                                             : void
     {
         $this->questionHints[] = $questionHint;
     }

Here is the caller graph for this function:

◆ current()

ilAssQuestionHintList::current ( )

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

                              : ilAssQuestionHint
     {
         return current($this->questionHints);
     }

◆ deleteHintsByQuestionIds()

static ilAssQuestionHintList::deleteHintsByQuestionIds ( array $questionIds )

static

Deletes all question hints relating to questions included in given question ids.

Parameters

list<int> $questionIds

Definition at line 286 of file class.ilAssQuestionHintList.php.

References $DIC, and $ilDB.

Referenced by assQuestion\delete().

                                                                        : int
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $__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);
     }

Here is the caller graph for this function:

◆ duplicateListForQuestion()

static ilAssQuestionHintList::duplicateListForQuestion	(	$originalQuestionId,
		$duplicateQuestionId
	)

static

duplicates a hint list from given original question id to given duplicate question id and returns an array of duplicate hint ids mapped to the corresponding original hint ids

Parameters

int	$originalQuestionId
int	$duplicateQuestionId

Returns: array<int, int> $hintIds containing the map from original hint ids to duplicate hint ids

Definition at line 124 of file class.ilAssQuestionHintList.php.

Referenced by assQuestion\duplicateQuestionHints().

                                                                                               : array
     {
         $hintIds = [];
 
         $questionHintList = self::getListByQuestionId($originalQuestionId);
 
         foreach ($questionHintList as $questionHint) {
             /* @var $questionHint ilAssQuestionHint */
 
             $originalHintId = $questionHint->getId();
 
             $questionHint->setId(0);
             $questionHint->setQuestionId($duplicateQuestionId);
 
             $questionHint->save();
 
             $duplicateHintId = $questionHint->getId();
 
             $hintIds[$originalHintId] = $duplicateHintId;
         }
 
         return $hintIds;
     }

Here is the caller graph for this function:

◆ getHint()

ilAssQuestionHintList::getHint ( $hintId )

Parameters

int $hintId

Definition at line 70 of file class.ilAssQuestionHintList.php.

                                     : ilAssQuestionHint
     {
         foreach ($this as $questionHint) {
             /* @var $questionHint ilAssQuestionHint */
 
             if ($questionHint->getId() == $hintId) {
                 return $questionHint;
             }
         }
 
         throw new ilTestQuestionPoolException("hint with id $hintId does not exist in this list");
     }

◆ getListByHintIds()

static ilAssQuestionHintList::getListByHintIds ( $hintIds )

static

instantiates a question hint list for the passed hint ids

Parameters

list<int> $hintIds

Definition at line 217 of file class.ilAssQuestionHintList.php.

References $DIC, $ilDB, $res, and ilAssQuestionHint\assignDbRow().

Referenced by ilAssQuestionPreviewHintTracking\getRequestedHintsList(), and ilAssQuestionHintTracking\getRequestedHintsList().

                                                      : ilAssQuestionHintList
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $qht_hint_id__IN__hintIds = $ilDB->in('qht_hint_id', (array) $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getListByQuestionId()

static ilAssQuestionHintList::getListByQuestionId ( $questionId )

static

instantiates a question hint list for the passed question id

Parameters

int $questionId

Definition at line 175 of file class.ilAssQuestionHintList.php.

References $DIC, $ilDB, $res, and ilAssQuestionHint\assignDbRow().

Referenced by assQuestionExport\addSolutionHints(), ilAssQuestionHintsGUI\checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure(), ilAssQuestionHintsGUI\confirmDeleteCmd(), assQuestion\getRTETextWithMediaObjects(), ilAssQuestionList\hasHints(), ilAssQuestionHintsGUI\pasteFromOrderingClipboardAfterCmd(), ilAssQuestionHintsGUI\pasteFromOrderingClipboardBeforeCmd(), ilAssQuestionHintsGUI\performDeleteCmd(), ilAssQuestionHintsGUI\saveListOrderCmd(), and ilAssQuestionHintsGUI\showListCmd().

                                                            : ilAssQuestionHintList
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $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,
             ['integer'],
             [(int) $questionId]
         );
 
         $questionHintList = new self();
 
         while ($row = $ilDB->fetchAssoc($res)) {
             $questionHint = new ilAssQuestionHint();
 
             ilAssQuestionHint::assignDbRow($questionHint, $row);
 
             $questionHintList->addHint($questionHint);
         }
 
         return $questionHintList;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNextIndexByQuestionId()

static ilAssQuestionHintList::getNextIndexByQuestionId ( $questionId )

static

determines the next index to be used for a new hint that is to be added to the list of existing hints regarding to the question with passed question id

Parameters

int $questionId

Definition at line 259 of file class.ilAssQuestionHintList.php.

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

Referenced by ilAssQuestionHintGUI\saveFormCmd().

                                                                 : int
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $query = "
                         SELECT          1 + COALESCE( MAX(qht_hint_index), 0 ) next_index
 
                         FROM            qpl_hints
 
                         WHERE           qht_question_fi = %s
                 ";
 
         $res = $ilDB->queryF(
             $query,
             ['integer'],
             [(int) $questionId]
         );
         $row = $ilDB->fetchAssoc($res);
 
         return is_array($row) ? (int) $row['next_index'] : 1;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableData()

ilAssQuestionHintList::getTableData ( )

returns an array with data of the hints in this list that is adopted to be used as table gui data

Returns: list<array{hint_id: null|int, hint_index: null|int, hint_points: null|float, hint_text: null|int}>

Definition at line 153 of file class.ilAssQuestionHintList.php.

Referenced by ilAssQuestionHintsTableGUI\__construct().

                                   : array
     {
         $tableData = [];
 
         foreach ($this as $questionHint) {
             /* @var $questionHint ilAssQuestionHint */
 
             $tableData[] = [
                 'hint_id' => $questionHint->getId(),
                 'hint_index' => $questionHint->getIndex(),
                 'hint_points' => $questionHint->getPoints(),
                 'hint_text' => $questionHint->getText()
             ];
         }
 
         return $tableData;
     }

Here is the caller graph for this function:

◆ hintExists()

ilAssQuestionHintList::hintExists ( $hintId )

Parameters

int $hintId

Definition at line 86 of file class.ilAssQuestionHintList.php.

                                        : bool
     {
         foreach ($this as $questionHint) {
             /* @var ilAssQuestionHint $questionHint */
             if ($questionHint->getId() == $hintId) {
                 return true;
             }
         }
 
         return false;
     }

◆ key()

ilAssQuestionHintList::key ( )

Definition at line 48 of file class.ilAssQuestionHintList.php.

Referenced by valid().

                          : int
     {
         return key($this->questionHints);
     }

Here is the caller graph for this function:

◆ next()

ilAssQuestionHintList::next ( )

Definition at line 43 of file class.ilAssQuestionHintList.php.

                           : void
     {
         next($this->questionHints);
     }

◆ reIndex()

ilAssQuestionHintList::reIndex ( )

re-indexes the list's hints sequentially by current order (starting with index "1") ATTENTION: it also persists this index to db by performing an update of hint object via id.

do not re-index any hint list objects unless this lists contain ALL hint objects for a SINGLE question and no more hints apart of that.

Definition at line 104 of file class.ilAssQuestionHintList.php.

                              : void
     {
         $counter = 0;
 
         foreach ($this as $questionHint) {
             /* @var $questionHint ilAssQuestionHint */
 
             $questionHint->setIndex(++$counter);
             $questionHint->save();
         }
     }

◆ rewind()

ilAssQuestionHintList::rewind ( )

Definition at line 38 of file class.ilAssQuestionHintList.php.

                             : void
     {
         reset($this->questionHints);
     }

◆ valid()

ilAssQuestionHintList::valid ( )

Definition at line 53 of file class.ilAssQuestionHintList.php.

References key().

                            : bool
     {
         return key($this->questionHints) !== null;
     }

Here is the call graph for this function:

Field Documentation

◆ $questionHints

array ilAssQuestionHintList::$questionHints = []

private

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

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

Modules/TestQuestionPool/classes/class.ilAssQuestionHintList.php

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addHint()

◆ current()

◆ deleteHintsByQuestionIds()

◆ duplicateListForQuestion()

◆ getHint()

◆ getListByHintIds()

◆ getListByQuestionId()

◆ getNextIndexByQuestionId()

◆ getTableData()

◆ hintExists()

◆ key()

◆ next()

◆ reIndex()

◆ rewind()

◆ valid()

Field Documentation

◆ $questionHints