Inheritance diagram for ilAssQuestionHintList:

Collaboration diagram for ilAssQuestionHintList:

Public Member Functions
	current ()
	iterator interface method More...

	rewind ()
	iterator interface method More...

	next ()
	iterator interface method More...

	key ()
	iterator interface method More...

	valid ()
	iterator interface method More...

	__construct ()
	Constructor. More...

	addHint (ilAssQuestionHint $questionHint)
	adds a question hint object to the current list instance More...

	getHint ($hintId)
	returns the question hint object relating to the passed hint id More...

	hintExists ($hintId)
	checks wether a question hint object relating to the passed id exists or not More...

	reIndex ()
	re-indexes the list's hints sequentially by current order (starting with index "1") 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 ($questionIds)
	Deletes all question hints relating to questions included in given question ids. More...

Private Attributes
	$questionHints = array()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionHintList::__construct ( )

Constructor.

public

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

69 { }

Member Function Documentation

◆ addHint()

ilAssQuestionHintList::addHint ( ilAssQuestionHint $questionHint )

adds a question hint object to the current list instance

public

Parameters

ilAssQuestionHint $questionHint

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

Referenced by ilAssQuestionHintsGUI\pasteFromOrderingClipboardAfterCmd().

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

Here is the caller graph for this function:

◆ current()

ilAssQuestionHintList::current ( )

iterator interface method

public

Returns: mixed

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

References current().

Referenced by current().

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

ilAssQuestionHintList\current

current()

iterator interface method

Definition: class.ilAssQuestionHintList.php:30

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteHintsByQuestionIds()

static ilAssQuestionHintList::deleteHintsByQuestionIds ( $questionIds )

static

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

ilDB $ilDB

Parameters

array[integer] $questionIds

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

References $ilDB, and $query.

Referenced by assQuestion\delete().

         {
                 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);
         }

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

integer	$originalQuestionId
integer	$duplicateQuestionId

Returns: array $hintIds containing the map from original hint ids to duplicate hint ids

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

Referenced by assQuestion\duplicateQuestionHints().

         {
                 $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;
         }

Here is the caller graph for this function:

◆ getHint()

ilAssQuestionHintList::getHint ( $hintId )

returns the question hint object relating to the passed hint id

public

Parameters

integer $hintId

Returns: ilAssQuestionHint $questionHint

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

         {
                 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");
         }

◆ getListByHintIds()

static ilAssQuestionHintList::getListByHintIds ( $hintIds )

static

instantiates a question hint list for the passed hint ids

public ilDB $ilDB

Parameters

array $hintIds

Returns: self $questionHintList

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

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

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

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

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

public ilDB $ilDB

Parameters

integer $questionId

Returns: self $questionHintList

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

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

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

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

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

public ilDB $ilDB

Parameters

integer $questionId

Returns: integer $nextIndex

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

References $ilDB, $query, $res, and $row.

Referenced by ilAssQuestionHintGUI\saveFormCmd().

         {
                 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'];
         }

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

public

Returns: array $tableData

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

Referenced by ilAssQuestionHintsTableGUI\__construct().

         {
                 $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;
         }

Here is the caller graph for this function:

◆ hintExists()

ilAssQuestionHintList::hintExists ( $hintId )

checks wether a question hint object relating to the passed id exists or not

public

Parameters

integer $hintId

Returns: boolean $hintExists

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

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

◆ key()

ilAssQuestionHintList::key ( )

iterator interface method

public

Returns: mixed

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

References key().

Referenced by key(), and valid().

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

ilAssQuestionHintList\key

key()

iterator interface method

Definition: class.ilAssQuestionHintList.php:54

Here is the call graph for this function:

Here is the caller graph for this function:

◆ next()

ilAssQuestionHintList::next ( )

iterator interface method

public

Returns: mixed

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

References next().

Referenced by next().

46 { return next($this->questionHints); }

ilAssQuestionHintList\next

next()

iterator interface method

Definition: class.ilAssQuestionHintList.php:46

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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.

public

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

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

◆ rewind()

ilAssQuestionHintList::rewind ( )

iterator interface method

public

Returns: mixed

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

38 { return reset($this->questionHints); }

◆ valid()

ilAssQuestionHintList::valid ( )

iterator interface method

public

Returns: boolean

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

References key().

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

ilAssQuestionHintList\key

key()

iterator interface method

Definition: class.ilAssQuestionHintList.php:54

Here is the call graph for this function:

Field Documentation

◆ $questionHints

ilAssQuestionHintList::$questionHints = array()

private

Definition at line 22 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