Inheritance diagram for ilAssQuestionHintList:

Collaboration diagram for ilAssQuestionHintList:

Public Member Functions
	current ()
	iterator interface method
	rewind ()
	iterator interface method
	next ()
	iterator interface method
	key ()
	iterator interface method
	valid ()
	iterator interface method
	__construct ()
	Constructor.
	addHint (ilAssQuestionHint $questionHint)
	adds a question hint object to the current list instance
	getHint ($hintId)
	returns the question hint object relating to the passed hint id
	hintExists ($hintId)
	checks wether a question hint object relating to the passed id exists or not
	reIndex ()
	re-indexes the list's hints sequentially by current order (starting with index "1")
	getTableData ()
	returns an array with data of the hints in this list that is adopted to be used as table gui data

Static Public Member Functions
static	duplicateListForQuestion ($originalQuestionId, $duplicateQuestionId)
static	getListByQuestionId ($questionId)
	instantiates a question hint list for the passed question id
static	getListByHintIds ($hintIds)
	instantiates a question hint list for the passed hint ids
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
static	deleteHintsByQuestionIds ($questionIds)
	Deletes all question hints relating to questions included in given question ids.

Private Attributes
	$questionHints = array()

Detailed Description

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

Constructor & Destructor Documentation

ilAssQuestionHintList::__construct ( )

Constructor.

public

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

{ }

Member Function Documentation

ilAssQuestionHintList::addHint ( ilAssQuestionHint $questionHint )

adds a question hint object to the current list instance

public

Parameters

ilAssQuestionHint $questionHint

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

Referenced by ilAssQuestionHintsGUI\pasteFromOrderingClipboardAfterCmd().

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

Here is the caller graph for this function:

ilAssQuestionHintList::current ( )

iterator interface method

public

Returns: mixed

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

References current().

Referenced by current().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 320 of file class.ilAssQuestionHintList.php.

References $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:

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

static

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

References getListByQuestionId().

Referenced by assQuestion\duplicateQuestionHints().

        {
                $questionHintList = self::getListByQuestionId($originalQuestionId);
                foreach($questionHintList as $questionHint)
                {
                        /* @var $questionHint ilAssQuestionHint */
                        
                        $questionHint->setId(null);
                        $questionHint->setQuestionId($duplicateQuestionId);
                        
                        $questionHint->save();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilAssQuestionHintList::getHint ( $hintId )

returns the question hint object relating to the passed hint id

public

Parameters

integer $hintId

Returns: ilAssQuestionHint $questionHint

Definition at line 90 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");
        }

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 246 of file class.ilAssQuestionHintList.php.

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

Referenced by 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:

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 201 of file class.ilAssQuestionHintList.php.

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

Referenced by ilAssQuestionHintsGUI\checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure(), ilAssQuestionHintsGUI\confirmDeleteCmd(), duplicateListForQuestion(), 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:

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 293 of file class.ilAssQuestionHintList.php.

References $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:

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 173 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:

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 114 of file class.ilAssQuestionHintList.php.

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

ilAssQuestionHintList::key ( )

iterator interface method

public

Returns: mixed

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

References key().

Referenced by key(), and valid().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilAssQuestionHintList::next ( )

iterator interface method

public

Returns: mixed

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

References next().

Referenced by next().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 138 of file class.ilAssQuestionHintList.php.

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

ilAssQuestionHintList::rewind ( )

iterator interface method

public

Returns: mixed

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

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

ilAssQuestionHintList::valid ( )

iterator interface method

public

Returns: boolean

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

References key().

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

Here is the call graph for this function:

Field Documentation

ilAssQuestionHintList::$questionHints = array()

private

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

Member Function Documentation

Field Documentation