Test sequence handler. More...

Inheritance diagram for ilTestSequence:

Collaboration diagram for ilTestSequence:

Public Member Functions
	__construct ($active_id, $pass, $randomtest)
	ilTestSequence constructor More...

	getActiveId ()

	createNewSequence ($max, $shuffle)

	loadQuestions (ilTestQuestionSetConfig $testQuestionSetConfig=null, $taxonomyFilterSelection=array())
	Loads the question mapping. More...

	loadFromDb ()
	Loads the sequence data for a given active id. More...

	saveToDb ()
	Saves the sequence data for a given pass to the database. More...

	postponeQuestion ($question_id)

	hideQuestion ($question_id)

	isPostponedQuestion ($question_id)

	isHiddenQuestion ($question_id)

	isPostponedSequence ($sequence)

	isHiddenSequence ($sequence)

	postponeSequence ($sequence)

	hideSequence ($sequence)

	setQuestionPresented ($questionId)

	isQuestionPresented ($questionId)

	isNextQuestionPresented ($questionId)

	setQuestionChecked ($questionId)

	isQuestionChecked ($questionId)

	getPositionOfSequence ($sequence)

	getUserQuestionCount ()

	getOrderedSequence ()

	getOrderedSequenceQuestions ()

	getUserSequence ()

	getUserSequenceQuestions ()

	getSequenceForQuestion ($question_id)

	getFirstSequence ()

	getLastSequence ()

	getNextSequence ($sequence)

	getPreviousSequence ($sequence)

	pcArrayShuffle ($array)
	Shuffles the values of a given array. More...

	getQuestionForSequence ($sequence)

	getSequenceSummary ($obligationsFilterEnabled=false)

	getPass ()

	setPass ($pass)

	hasSequence ()

	hasHiddenQuestions ()

	clearHiddenQuestions ()

	hasStarted (ilTestSession $testSession)

	openQuestionExists ()

	getQuestionIds ()

	questionExists ($questionId)

	setQuestionOptional ($questionId)

	isQuestionOptional ($questionId)

	hasOptionalQuestions ()

	getOptionalQuestions ()

	clearOptionalQuestions ()

	reorderOptionalQuestionsToSequenceEnd ()

	isAnsweringOptionalQuestionsConfirmed ()

	setAnsweringOptionalQuestionsConfirmed ($answeringOptionalQuestionsConfirmed)

	isConsiderHiddenQuestionsEnabled ()

	setConsiderHiddenQuestionsEnabled ($considerHiddenQuestionsEnabled)

	isConsiderOptionalQuestionsEnabled ()

	setConsiderOptionalQuestionsEnabled ($considerOptionalQuestionsEnabled)

Data Fields
	$sequencedata

	$questions

	$active_id

	$pass

	$isRandomTest

Protected Member Functions
	loadPresentedQuestions ()

	saveNewlyPresentedQuestion ()

	getCorrectedSequence ()

Protected Attributes
	$alreadyPresentedQuestions = array()

	$newlyPresentedQuestion = 0

	$alreadyCheckedQuestions

	$newlyCheckedQuestion

	$optionalQuestions

Private Member Functions
	loadQuestionSequence ()

	loadCheckedQuestions ()

	loadOptionalQuestions ()

	saveQuestionSequence ()

	saveNewlyCheckedQuestion ()
	ilDBInterface $ilDB More...

	saveOptionalQuestions ()
	ilDBInterface $ilDB More...

	ensureQuestionNotInSequence ($sequence, $questionId)

	hideCorrectAnsweredQuestions (ilObjTest $testOBJ, $activeId, $pass)

Private Attributes
	$answeringOptionalQuestionsConfirmed

	$considerHiddenQuestionsEnabled

	$considerOptionalQuestionsEnabled

Detailed Description

Test sequence handler.

This class manages the sequence settings for a given user

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version: $Id$

Definition at line 16 of file class.ilTestSequence.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestSequence::__construct	(	$active_id,
		$pass,
		$randomtest
	)

ilTestSequence constructor

The constructor takes possible arguments an creates an instance of the ilTestSequence object.

Parameters

object $a_object A reference to the test container object public

Definition at line 102 of file class.ilTestSequence.php.

References $active_id, and $pass.

     {
         $this->active_id = $active_id;
         $this->pass = $pass;
         $this->isRandomTest = $randomtest;
         $this->sequencedata = array(
             "sequence" => array(),
             "postponed" => array(),
             "hidden" => array()
         );
         
         $this->alreadyCheckedQuestions = array();
         $this->newlyCheckedQuestion = null;
         
         $this->optionalQuestions = array();
         $this->answeringOptionalQuestionsConfirmed = false;
         
         $this->considerHiddenQuestionsEnabled = false;
         $this->considerOptionalQuestionsEnabled = true;
     }

Member Function Documentation

◆ clearHiddenQuestions()

ilTestSequence::clearHiddenQuestions ( )

Definition at line 761 of file class.ilTestSequence.php.

Referenced by ilLOTestQuestionAdapter\hideQuestions().

     {
         $this->sequencedata["hidden"] = array();
     }

Here is the caller graph for this function:

◆ clearOptionalQuestions()

ilTestSequence::clearOptionalQuestions ( )

Definition at line 832 of file class.ilTestSequence.php.

Referenced by ilLOTestQuestionAdapter\setQuestionsOptional().

     {
         $this->optionalQuestions = array();
     }

Here is the caller graph for this function:

◆ createNewSequence()

ilTestSequence::createNewSequence	(	$max,
		$shuffle
	)

Definition at line 128 of file class.ilTestSequence.php.

References $i, and pcArrayShuffle().

     {
         $newsequence = array();
         if ($max > 0) {
             for ($i = 1; $i <= $max; $i++) {
                 array_push($newsequence, $i);
             }
             if ($shuffle) {
                 $newsequence = $this->pcArrayShuffle($newsequence);
             }
         }
         $this->sequencedata["sequence"] = $newsequence;
     }

Here is the call graph for this function:

◆ ensureQuestionNotInSequence()

ilTestSequence::ensureQuestionNotInSequence	(	$sequence,
		$questionId
	)

private

Definition at line 559 of file class.ilTestSequence.php.

Referenced by getCorrectedSequence().

     {
         $questionKey = array_search($questionId, $this->questions);
         
         if ($questionKey === false) {
             return $sequence;
         }
         
         $sequenceKey = array_search($questionKey, $sequence);
         
         if ($sequenceKey === false) {
             return $sequence;
         }
 
         unset($sequence[$sequenceKey]);
         
         return $sequence;
     }

Here is the caller graph for this function:

◆ getActiveId()

ilTestSequence::getActiveId ( )

Implements ilTestSequenceSummaryProvider.

Definition at line 123 of file class.ilTestSequence.php.

References $active_id.

     {
         return $this->active_id;
     }

◆ getCorrectedSequence()

ilTestSequence::getCorrectedSequence ( )

protected

Definition at line 578 of file class.ilTestSequence.php.

References ensureQuestionNotInSequence(), isConsiderHiddenQuestionsEnabled(), and isConsiderOptionalQuestionsEnabled().

Referenced by getFirstSequence(), getLastSequence(), getNextSequence(), getPositionOfSequence(), getPreviousSequence(), getSequenceSummary(), getUserQuestionCount(), getUserSequence(), and getUserSequenceQuestions().

     {
         $correctedsequence = $this->sequencedata["sequence"];
         if (!$this->isConsiderHiddenQuestionsEnabled()) {
             if (is_array($this->sequencedata["hidden"])) {
                 foreach ($this->sequencedata["hidden"] as $question_id) {
                     $correctedsequence = $this->ensureQuestionNotInSequence($correctedsequence, $question_id);
                 }
             }
         }
         if (!$this->isConsiderOptionalQuestionsEnabled()) {
             foreach ($this->optionalQuestions as $questionId) {
                 $correctedsequence = $this->ensureQuestionNotInSequence($correctedsequence, $questionId);
             }
         }
         if (is_array($this->sequencedata["postponed"])) {
             foreach ($this->sequencedata["postponed"] as $question_id) {
                 $foundsequence = array_search($question_id, $this->questions);
                 if ($foundsequence !== false) {
                     $sequencekey = array_search($foundsequence, $correctedsequence);
                     if ($sequencekey !== false) {
                         unset($correctedsequence[$sequencekey]);
                         array_push($correctedsequence, $foundsequence);
                     }
                 }
             }
         }
         return array_values($correctedsequence);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFirstSequence()

ilTestSequence::getFirstSequence ( )

Definition at line 613 of file class.ilTestSequence.php.

References getCorrectedSequence().

Referenced by hasStarted(), and openQuestionExists().

     {
         $correctedsequence = $this->getCorrectedSequence();
         if (count($correctedsequence)) {
             return reset($correctedsequence);
         } else {
             return false;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastSequence()

ilTestSequence::getLastSequence ( )

Definition at line 623 of file class.ilTestSequence.php.

References getCorrectedSequence().

     {
         $correctedsequence = $this->getCorrectedSequence();
         if (count($correctedsequence)) {
             return end($correctedsequence);
         } else {
             return false;
         }
     }

Here is the call graph for this function:

◆ getNextSequence()

ilTestSequence::getNextSequence ( $sequence )

Definition at line 633 of file class.ilTestSequence.php.

References getCorrectedSequence().

Referenced by isNextQuestionPresented().

     {
         $correctedsequence = $this->getCorrectedSequence();
         $sequencekey = array_search($sequence, $correctedsequence);
         if ($sequencekey !== false) {
             $nextsequencekey = $sequencekey + 1;
             if (array_key_exists($nextsequencekey, $correctedsequence)) {
                 return $correctedsequence[$nextsequencekey];
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOptionalQuestions()

ilTestSequence::getOptionalQuestions ( )

Definition at line 827 of file class.ilTestSequence.php.

References $optionalQuestions.

     {
         return $this->optionalQuestions;
     }

◆ getOrderedSequence()

ilTestSequence::getOrderedSequence ( )

Definition at line 506 of file class.ilTestSequence.php.

References isConsiderHiddenQuestionsEnabled(), isConsiderOptionalQuestionsEnabled(), and isHiddenSequence().

     {
         $sequenceKeys = array();
         
         foreach (array_keys($this->questions) as $sequenceKey) {
             if ($this->isHiddenSequence($sequenceKey) && !$this->isConsiderHiddenQuestionsEnabled()) {
                 continue;
             }
             
             if ($this->isSequenceOptional($sequenceKey) && !$this->isConsiderOptionalQuestionsEnabled()) {
                 continue;
             }
             
             $sequenceKeys[] = $sequenceKey;
         }
         
         return $sequenceKeys;
     }

Here is the call graph for this function:

◆ getOrderedSequenceQuestions()

ilTestSequence::getOrderedSequenceQuestions ( )

Definition at line 525 of file class.ilTestSequence.php.

References $questions, isConsiderHiddenQuestionsEnabled(), isConsiderOptionalQuestionsEnabled(), isHiddenQuestion(), and isQuestionOptional().

     {
         $questions = array();
         
         foreach ($this->questions as $questionId) {
             if ($this->isHiddenQuestion($questionId) && !$this->isConsiderHiddenQuestionsEnabled()) {
                 continue;
             }
             
             if ($this->isQuestionOptional($questionId) && !$this->isConsiderOptionalQuestionsEnabled()) {
                 continue;
             }
             
             $questions[] = $questionId;
         }
         
         return $questions;
     }

Here is the call graph for this function:

◆ getPass()

ilTestSequence::getPass ( )

Definition at line 733 of file class.ilTestSequence.php.

References $pass.

     {
         return $this->pass;
     }

◆ getPositionOfSequence()

ilTestSequence::getPositionOfSequence ( $sequence )

Definition at line 490 of file class.ilTestSequence.php.

References getCorrectedSequence().

     {
         $correctedsequence = $this->getCorrectedSequence();
         $sequencekey = array_search($sequence, $correctedsequence);
         if ($sequencekey !== false) {
             return $sequencekey + 1;
         } else {
             return "";
         }
     }

Here is the call graph for this function:

◆ getPreviousSequence()

ilTestSequence::getPreviousSequence ( $sequence )

Definition at line 646 of file class.ilTestSequence.php.

References getCorrectedSequence().

     {
         $correctedsequence = $this->getCorrectedSequence();
         $sequencekey = array_search($sequence, $correctedsequence);
         if ($sequencekey !== false) {
             $prevsequencekey = $sequencekey - 1;
             if (($prevsequencekey >= 0) && (array_key_exists($prevsequencekey, $correctedsequence))) {
                 return $correctedsequence[$prevsequencekey];
             }
         }
         return false;
     }

Here is the call graph for this function:

◆ getQuestionForSequence()

ilTestSequence::getQuestionForSequence ( $sequence )

Definition at line 678 of file class.ilTestSequence.php.

Referenced by getSequenceSummary(), getUserSequenceQuestions(), isNextQuestionPresented(), and reorderOptionalQuestionsToSequenceEnd().

     {
         if ($sequence < 1) {
             return false;
         }
         if (array_key_exists($sequence, $this->questions)) {
             return $this->questions[$sequence];
         } else {
             return false;
         }
     }

Here is the caller graph for this function:

◆ getQuestionIds()

ilTestSequence::getQuestionIds ( )

Implements ilTestQuestionSequence.

Definition at line 802 of file class.ilTestSequence.php.

Referenced by ilLOTestQuestionAdapter\hideQuestions(), ilLOTestQuestionAdapter\setQuestionsOptional(), ilLOTestQuestionAdapter\updateRandomQuestions(), and ilLOTestQuestionAdapter\updateSeparateTestQuestions().

     {
         return array_values($this->questions);
     }

Here is the caller graph for this function:

◆ getSequenceForQuestion()

ilTestSequence::getSequenceForQuestion ( $question_id )

Definition at line 608 of file class.ilTestSequence.php.

Referenced by isNextQuestionPresented().

     {
         return array_search($question_id, $this->questions);
     }

Here is the caller graph for this function:

◆ getSequenceSummary()

ilTestSequence::getSequenceSummary ( $obligationsFilterEnabled = false )

Implements ilTestSequenceSummaryProvider.

Definition at line 690 of file class.ilTestSequence.php.

References $key, $pass, $row, ilObjTest\_getSolvedQuestions(), ilObjTest\_instanciateQuestion(), getCorrectedSequence(), getQuestionForSequence(), isPostponedQuestion(), ilObjTest\isQuestionObligatory(), and isQuestionPresented().

     {
         $correctedsequence = $this->getCorrectedSequence();
         $result_array = array();
         include_once "./Modules/Test/classes/class.ilObjTest.php";
         $solved_questions = ilObjTest::_getSolvedQuestions($this->active_id);
         $key = 1;
         foreach ($correctedsequence as $sequence) {
             $question = &ilObjTest::_instanciateQuestion($this->getQuestionForSequence($sequence));
             if (is_object($question)) {
                 $worked_through = $question->_isWorkedThrough($this->active_id, $question->getId(), $this->pass);
                 $solved = 0;
                 if (array_key_exists($question->getId(), $solved_questions)) {
                     $solved = $solved_questions[$question->getId()]["solved"];
                 }
                 $is_postponed = $this->isPostponedQuestion($question->getId());
 
                 $row = array(
                     "nr" => "$key",
                     "title" => $question->getTitle(),
                     "qid" => $question->getId(),
                     "presented" => $this->isQuestionPresented($question->getId()),
                     "visited" => $worked_through,
                     "solved" => (($solved)?"1":"0"),
                     "description" => $question->getComment(),
                     "points" => $question->getMaximumPoints(),
                     "worked_through" => $worked_through,
                     "postponed" => $is_postponed,
                     "sequence" => $sequence,
                     "obligatory" => ilObjTest::isQuestionObligatory($question->getId()),
                     'isAnswered' => $question->isAnswered($this->active_id, $this->pass)
                 );
                 
                 if (!$obligationsFilterEnabled || $row['obligatory']) {
                     array_push($result_array, $row);
                 }
                 
                 $key++;
             }
         }
         return $result_array;
     }

Here is the call graph for this function:

◆ getUserQuestionCount()

ilTestSequence::getUserQuestionCount ( )

Definition at line 501 of file class.ilTestSequence.php.

References getCorrectedSequence().

     {
         return count($this->getCorrectedSequence());
     }

Here is the call graph for this function:

◆ getUserSequence()

ilTestSequence::getUserSequence ( )

Definition at line 544 of file class.ilTestSequence.php.

References getCorrectedSequence().

     {
         return $this->getCorrectedSequence();
     }

Here is the call graph for this function:

◆ getUserSequenceQuestions()

ilTestSequence::getUserSequenceQuestions ( )

Definition at line 549 of file class.ilTestSequence.php.

References getCorrectedSequence(), and getQuestionForSequence().

     {
         $seq = $this->getCorrectedSequence();
         $found = array();
         foreach ($seq as $sequence) {
             array_push($found, $this->getQuestionForSequence($sequence));
         }
         return $found;
     }

Here is the call graph for this function:

◆ hasHiddenQuestions()

ilTestSequence::hasHiddenQuestions ( )

Definition at line 752 of file class.ilTestSequence.php.

     {
         if ((is_array($this->sequencedata["hidden"])) && (count($this->sequencedata["hidden"]) > 0)) {
             return true;
         } else {
             return false;
         }
     }

◆ hasOptionalQuestions()

ilTestSequence::hasOptionalQuestions ( )

Definition at line 822 of file class.ilTestSequence.php.

     {
         return (bool) count($this->optionalQuestions);
     }

◆ hasSequence()

ilTestSequence::hasSequence ( )

Definition at line 743 of file class.ilTestSequence.php.

     {
         if ((is_array($this->sequencedata["sequence"])) && (count($this->sequencedata["sequence"]) > 0)) {
             return true;
         } else {
             return false;
         }
     }

◆ hasStarted()

ilTestSequence::hasStarted ( ilTestSession $testSession )

Definition at line 783 of file class.ilTestSequence.php.

References getFirstSequence(), and ilTestSession\getLastSequence().

     {
         if ($testSession->getLastSequence() < 1) {
             return false;
         }
         
         // WTF ?? heard about tests with only one question !?
         if ($testSession->getLastSequence() == $this->getFirstSequence()) {
             return false;
         }
                 
         return true;
     }

Here is the call graph for this function:

◆ hideCorrectAnsweredQuestions()

ilTestSequence::hideCorrectAnsweredQuestions	(	ilObjTest	$testOBJ,
			$activeId,
			$pass
	)

private

Definition at line 766 of file class.ilTestSequence.php.

References $pass, $result, ilObjTest\getTestResult(), hideQuestion(), and saveToDb().

     {
         if ($activeId > 0) {
             $result = $testOBJ->getTestResult($activeId, $pass, true);
             
             foreach ($result as $sequence => $question) {
                 if (is_numeric($sequence)) {
                     if ($question['reached'] == $question['max']) {
                         $this->hideQuestion($question['qid']);
                     }
                 }
             }
             
             $this->saveToDb();
         }
     }

Here is the call graph for this function:

◆ hideQuestion()

ilTestSequence::hideQuestion ( $question_id )

Definition at line 362 of file class.ilTestSequence.php.

References isHiddenQuestion().

Referenced by hideCorrectAnsweredQuestions(), and ilLOTestQuestionAdapter\hideQuestions().

     {
         if (!$this->isHiddenQuestion($question_id)) {
             array_push($this->sequencedata["hidden"], intval($question_id));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hideSequence()

ilTestSequence::hideSequence ( $sequence )

Definition at line 435 of file class.ilTestSequence.php.

References isHiddenSequence().

     {
         if (!$this->isHiddenSequence($sequence)) {
             if (array_key_exists($sequence, $this->questions)) {
                 if (!is_array($this->sequencedata["hidden"])) {
                     $this->sequencedata["hidden"] = array();
                 }
                 array_push($this->sequencedata["hidden"], intval($this->questions[$sequence]));
             }
         }
     }

Here is the call graph for this function:

◆ isAnsweringOptionalQuestionsConfirmed()

ilTestSequence::isAnsweringOptionalQuestionsConfirmed ( )

Returns: boolean

Definition at line 856 of file class.ilTestSequence.php.

References $answeringOptionalQuestionsConfirmed.

Referenced by saveQuestionSequence(), and ilTestVirtualSequence\wasAnsweredInThisPass().

     {
         return $this->answeringOptionalQuestionsConfirmed;
     }

Here is the caller graph for this function:

◆ isConsiderHiddenQuestionsEnabled()

ilTestSequence::isConsiderHiddenQuestionsEnabled ( )

Returns: boolean

Definition at line 872 of file class.ilTestSequence.php.

References $considerHiddenQuestionsEnabled.

Referenced by getCorrectedSequence(), getOrderedSequence(), and getOrderedSequenceQuestions().

     {
         return $this->considerHiddenQuestionsEnabled;
     }

Here is the caller graph for this function:

◆ isConsiderOptionalQuestionsEnabled()

ilTestSequence::isConsiderOptionalQuestionsEnabled ( )

Returns: boolean

Definition at line 888 of file class.ilTestSequence.php.

References $considerOptionalQuestionsEnabled.

Referenced by getCorrectedSequence(), getOrderedSequence(), and getOrderedSequenceQuestions().

     {
         return $this->considerOptionalQuestionsEnabled;
     }

Here is the caller graph for this function:

◆ isHiddenQuestion()

ilTestSequence::isHiddenQuestion ( $question_id )

Definition at line 381 of file class.ilTestSequence.php.

Referenced by getOrderedSequenceQuestions(), hideQuestion(), and ilTestVirtualSequence\wasAnsweredInThisPass().

     {
         if (!is_array($this->sequencedata["hidden"])) {
             return false;
         }
         if (!in_array($question_id, $this->sequencedata["hidden"])) {
             return false;
         } else {
             return true;
         }
     }

Here is the caller graph for this function:

◆ isHiddenSequence()

ilTestSequence::isHiddenSequence ( $sequence )

Definition at line 408 of file class.ilTestSequence.php.

Referenced by getOrderedSequence(), and hideSequence().

     {
         if (!array_key_exists($sequence, $this->questions)) {
             return false;
         }
         if (!is_array($this->sequencedata["hidden"])) {
             return false;
         }
         if (!in_array($this->questions[$sequence], $this->sequencedata["hidden"])) {
             return false;
         } else {
             return true;
         }
     }

Here is the caller graph for this function:

◆ isNextQuestionPresented()

ilTestSequence::isNextQuestionPresented ( $questionId )

Definition at line 459 of file class.ilTestSequence.php.

References getNextSequence(), getQuestionForSequence(), and getSequenceForQuestion().

     {
         $nextQstId = $this->getQuestionForSequence(
             $this->getNextSequence($this->getSequenceForQuestion($questionId))
         );
         
         if (!$nextQstId) {
             return false;
         }
         
         if ($this->newlyPresentedQuestion == $nextQstId) {
             return true;
         }
         
         if (in_array($nextQstId, $this->alreadyPresentedQuestions)) {
             return true;
         }
         
         return false;
     }

Here is the call graph for this function:

◆ isPostponedQuestion()

ilTestSequence::isPostponedQuestion ( $question_id )

Definition at line 369 of file class.ilTestSequence.php.

Referenced by getSequenceSummary(), and postponeQuestion().

     {
         if (!is_array($this->sequencedata["postponed"])) {
             return false;
         }
         if (!in_array($question_id, $this->sequencedata["postponed"])) {
             return false;
         } else {
             return true;
         }
     }

Here is the caller graph for this function:

◆ isPostponedSequence()

ilTestSequence::isPostponedSequence ( $sequence )

Definition at line 393 of file class.ilTestSequence.php.

Referenced by postponeSequence().

     {
         if (!array_key_exists($sequence, $this->questions)) {
             return false;
         }
         if (!is_array($this->sequencedata["postponed"])) {
             return false;
         }
         if (!in_array($this->questions[$sequence], $this->sequencedata["postponed"])) {
             return false;
         } else {
             return true;
         }
     }

Here is the caller graph for this function:

◆ isQuestionChecked()

ilTestSequence::isQuestionChecked ( $questionId )

Definition at line 485 of file class.ilTestSequence.php.

     {
         return isset($this->alreadyCheckedQuestions[$questionId]);
     }

◆ isQuestionOptional()

ilTestSequence::isQuestionOptional ( $questionId )

Definition at line 817 of file class.ilTestSequence.php.

Referenced by getOrderedSequenceQuestions(), reorderOptionalQuestionsToSequenceEnd(), and ilTestVirtualSequence\wasAnsweredInThisPass().

     {
         return isset($this->optionalQuestions[$questionId]);
     }

Here is the caller graph for this function:

◆ isQuestionPresented()

ilTestSequence::isQuestionPresented ( $questionId )

Definition at line 452 of file class.ilTestSequence.php.

Referenced by getSequenceSummary().

     {
         return (
             $this->newlyPresentedQuestion == $questionId || in_array($questionId, $this->alreadyPresentedQuestions)
         );
     }

Here is the caller graph for this function:

◆ loadCheckedQuestions()

ilTestSequence::loadCheckedQuestions ( )

private

Definition at line 224 of file class.ilTestSequence.php.

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

Referenced by loadFromDb().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $res = $ilDB->queryF(
             "SELECT question_fi FROM tst_seq_qst_checked WHERE active_fi = %s AND pass = %s",
             array('integer','integer'),
             array($this->active_id, $this->pass)
         );
         
         while ($row = $ilDB->fetchAssoc($res)) {
             $this->alreadyCheckedQuestions[ $row['question_fi'] ] = $row['question_fi'];
         }
     }

Here is the caller graph for this function:

◆ loadFromDb()

ilTestSequence::loadFromDb ( )

Loads the sequence data for a given active id.

Returns: string The filesystem path of the certificate

Definition at line 171 of file class.ilTestSequence.php.

References loadCheckedQuestions(), loadOptionalQuestions(), loadPresentedQuestions(), and loadQuestionSequence().

     {
         $this->loadQuestionSequence();
         $this->loadPresentedQuestions();
         $this->loadCheckedQuestions();
         $this->loadOptionalQuestions();
     }

Here is the call graph for this function:

◆ loadOptionalQuestions()

ilTestSequence::loadOptionalQuestions ( )

private

Definition at line 240 of file class.ilTestSequence.php.

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

Referenced by loadFromDb().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $res = $ilDB->queryF(
             "SELECT question_fi FROM tst_seq_qst_optional WHERE active_fi = %s AND pass = %s",
             array('integer','integer'),
             array($this->active_id, $this->pass)
         );
 
         while ($row = $ilDB->fetchAssoc($res)) {
             $this->optionalQuestions[ $row['question_fi'] ] = $row['question_fi'];
         }
     }

Here is the caller graph for this function:

◆ loadPresentedQuestions()

ilTestSequence::loadPresentedQuestions ( )

protected

Definition at line 209 of file class.ilTestSequence.php.

References $DIC, $res, and $row.

Referenced by loadFromDb().

     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
         
         $res = $DIC->database()->queryF(
             "SELECT question_fi FROM tst_seq_qst_presented WHERE active_fi = %s AND pass = %s",
             array('integer','integer'),
             array($this->active_id, $this->pass)
         );
         
         while ($row = $DIC->database()->fetchAssoc($res)) {
             $this->alreadyPresentedQuestions[ $row['question_fi'] ] = $row['question_fi'];
         }
     }

Here is the caller graph for this function:

◆ loadQuestions()

ilTestSequence::loadQuestions	(	ilTestQuestionSetConfig	$testQuestionSetConfig = `null`,
			$taxonomyFilterSelection = `array()`
	)

Loads the question mapping.

Definition at line 145 of file class.ilTestSequence.php.

References $data, $DIC, $ilDB, $index, and $result.

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $this->questions = array();
 
         $result = $ilDB->queryF(
             "SELECT tst_test_question.* FROM tst_test_question, qpl_questions, tst_active WHERE tst_active.active_id = %s AND tst_test_question.test_fi = tst_active.test_fi AND qpl_questions.question_id = tst_test_question.question_fi ORDER BY tst_test_question.sequence",
             array('integer'),
             array($this->active_id)
         );
 
         $index = 1;
 
         // TODO bheyser: There might be "sequence" gaps which lead to issues with tst_sequence when deleting/adding questions before any participant starts the test
         while ($data = $ilDB->fetchAssoc($result)) {
             $this->questions[$index++] = $data["question_fi"];
         }
     }

◆ loadQuestionSequence()

ilTestSequence::loadQuestionSequence ( )

private

Definition at line 179 of file class.ilTestSequence.php.

References $DIC, $ilDB, $result, $row, and setAnsweringOptionalQuestionsConfirmed().

Referenced by loadFromDb().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $result = $ilDB->queryF(
             "SELECT * FROM tst_sequence WHERE active_fi = %s AND pass = %s",
             array('integer','integer'),
             array($this->active_id, $this->pass)
         );
         if ($result->numRows()) {
             $row = $ilDB->fetchAssoc($result);
             $this->sequencedata = array(
                 "sequence" => unserialize($row["sequence"]),
                 "postponed" => unserialize($row["postponed"]),
                 "hidden" => unserialize($row["hidden"])
             );
             if (!is_array($this->sequencedata["sequence"])) {
                 $this->sequencedata["sequence"] = array();
             }
             if (!is_array($this->sequencedata["postponed"])) {
                 $this->sequencedata["postponed"] = array();
             }
             if (!is_array($this->sequencedata["hidden"])) {
                 $this->sequencedata["hidden"] = array();
             }
             
             $this->setAnsweringOptionalQuestionsConfirmed((bool) $row['ans_opt_confirmed']);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ openQuestionExists()

ilTestSequence::openQuestionExists ( )

Definition at line 797 of file class.ilTestSequence.php.

References getFirstSequence().

     {
         return $this->getFirstSequence() !== false;
     }

Here is the call graph for this function:

◆ pcArrayShuffle()

ilTestSequence::pcArrayShuffle ( $array )

Shuffles the values of a given array.

Shuffles the values of a given array

Parameters

array $array An array which should be shuffled public

Definition at line 667 of file class.ilTestSequence.php.

References $key, $keys, and $result.

Referenced by createNewSequence().

     {
         $keys = array_keys($array);
         shuffle($keys);
         $result = array();
         foreach ($keys as $key) {
             $result[$key] = $array[$key];
         }
         return $result;
     }

Here is the caller graph for this function:

◆ postponeQuestion()

ilTestSequence::postponeQuestion ( $question_id )

Definition at line 355 of file class.ilTestSequence.php.

References isPostponedQuestion().

     {
         if (!$this->isPostponedQuestion($question_id)) {
             array_push($this->sequencedata["postponed"], intval($question_id));
         }
     }

Here is the call graph for this function:

◆ postponeSequence()

ilTestSequence::postponeSequence ( $sequence )

Definition at line 423 of file class.ilTestSequence.php.

References isPostponedSequence().

     {
         if (!$this->isPostponedSequence($sequence)) {
             if (array_key_exists($sequence, $this->questions)) {
                 if (!is_array($this->sequencedata["postponed"])) {
                     $this->sequencedata["postponed"] = array();
                 }
                 array_push($this->sequencedata["postponed"], intval($this->questions[$sequence]));
             }
         }
     }

Here is the call graph for this function:

◆ questionExists()

ilTestSequence::questionExists ( $questionId )

Definition at line 807 of file class.ilTestSequence.php.

     {
         return in_array($questionId, $this->questions);
     }

◆ reorderOptionalQuestionsToSequenceEnd()

ilTestSequence::reorderOptionalQuestionsToSequenceEnd ( )

Definition at line 837 of file class.ilTestSequence.php.

References $index, getQuestionForSequence(), and isQuestionOptional().

     {
         $optionalSequenceKeys = array();
         
         foreach ($this->sequencedata['sequence'] as $index => $sequenceKey) {
             if ($this->isQuestionOptional($this->getQuestionForSequence($sequenceKey))) {
                 $optionalSequenceKeys[$index] = $sequenceKey;
                 unset($this->sequencedata['sequence'][$index]);
             }
         }
         
         foreach ($optionalSequenceKeys as $index => $sequenceKey) {
             $this->sequencedata['sequence'][$index] = $sequenceKey;
         }
     }

Here is the call graph for this function:

◆ saveNewlyCheckedQuestion()

ilTestSequence::saveNewlyCheckedQuestion ( )

private

ilDBInterface $ilDB

Definition at line 316 of file class.ilTestSequence.php.

References $DIC, and $ilDB.

Referenced by saveToDb().

     {
         if ((int) $this->newlyCheckedQuestion) {
             global $DIC;
             $ilDB = $DIC['ilDB'];
             
             $ilDB->replace('tst_seq_qst_checked', array(
                 'active_fi' => array('integer', (int) $this->active_id),
                 'pass' => array('integer', (int) $this->pass),
                 'question_fi' => array('integer', (int) $this->newlyCheckedQuestion)
             ), array());
         }
     }

Here is the caller graph for this function:

◆ saveNewlyPresentedQuestion()

ilTestSequence::saveNewlyPresentedQuestion ( )

protected

Definition at line 300 of file class.ilTestSequence.php.

References $DIC.

Referenced by saveToDb().

     {
         if ((int) $this->newlyPresentedQuestion) {
             global $DIC; /* @var ILIAS\DI\Container $DIC */
             
             $DIC->database()->replace('tst_seq_qst_presented', array(
                 'active_fi' => array('integer', (int) $this->active_id),
                 'pass' => array('integer', (int) $this->pass),
                 'question_fi' => array('integer', (int) $this->newlyPresentedQuestion)
             ), array());
         }
     }

Here is the caller graph for this function:

◆ saveOptionalQuestions()

ilTestSequence::saveOptionalQuestions ( )

private

ilDBInterface $ilDB

Definition at line 333 of file class.ilTestSequence.php.

References $DIC, and $ilDB.

Referenced by saveToDb().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         
         $NOT_IN_questions = $ilDB->in('question_fi', $this->optionalQuestions, true, 'integer');
         
         $ilDB->queryF(
             "DELETE FROM tst_seq_qst_optional WHERE active_fi = %s AND pass = %s AND $NOT_IN_questions",
             array('integer', 'integer'),
             array($this->active_id, $this->pass)
         );
 
         foreach ($this->optionalQuestions as $questionId) {
             $ilDB->replace('tst_seq_qst_optional', array(
                 'active_fi' => array('integer', (int) $this->active_id),
                 'pass' => array('integer', (int) $this->pass),
                 'question_fi' => array('integer', (int) $questionId)
             ), array());
         }
     }

Here is the caller graph for this function:

◆ saveQuestionSequence()

ilTestSequence::saveQuestionSequence ( )

private

Definition at line 269 of file class.ilTestSequence.php.

References $DIC, $ilDB, and isAnsweringOptionalQuestionsConfirmed().

Referenced by saveToDb().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $postponed = null;
         if ((is_array($this->sequencedata["postponed"])) && (count($this->sequencedata["postponed"]))) {
             $postponed = serialize($this->sequencedata["postponed"]);
         }
         $hidden = null;
         if ((is_array($this->sequencedata["hidden"])) && (count($this->sequencedata["hidden"]))) {
             $hidden = serialize($this->sequencedata["hidden"]);
         }
 
         $affectedRows = $ilDB->manipulateF(
             "DELETE FROM tst_sequence WHERE active_fi = %s AND pass = %s",
             array('integer','integer'),
             array($this->active_id, $this->pass)
         );
 
         $affectedRows = $ilDB->insert("tst_sequence", array(
             "active_fi" => array("integer", $this->active_id),
             "pass" => array("integer", $this->pass),
             "sequence" => array("clob", serialize($this->sequencedata["sequence"])),
             "postponed" => array("text", $postponed),
             "hidden" => array("text", $hidden),
             "tstamp" => array("integer", time()),
             'ans_opt_confirmed' => array('integer', (int) $this->isAnsweringOptionalQuestionsConfirmed())
         ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveToDb()

ilTestSequence::saveToDb ( )

Saves the sequence data for a given pass to the database.

public

Definition at line 261 of file class.ilTestSequence.php.

References saveNewlyCheckedQuestion(), saveNewlyPresentedQuestion(), saveOptionalQuestions(), and saveQuestionSequence().

Referenced by hideCorrectAnsweredQuestions(), and ilLOTestQuestionAdapter\prepareTestPass().

     {
         $this->saveQuestionSequence();
         $this->saveNewlyPresentedQuestion();
         $this->saveNewlyCheckedQuestion();
         $this->saveOptionalQuestions();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAnsweringOptionalQuestionsConfirmed()

ilTestSequence::setAnsweringOptionalQuestionsConfirmed ( $answeringOptionalQuestionsConfirmed )

Parameters

boolean $answeringOptionalQuestionsConfirmed

Definition at line 864 of file class.ilTestSequence.php.

References $answeringOptionalQuestionsConfirmed.

Referenced by loadQuestionSequence().

     {
         $this->answeringOptionalQuestionsConfirmed = $answeringOptionalQuestionsConfirmed;
     }

Here is the caller graph for this function:

◆ setConsiderHiddenQuestionsEnabled()

ilTestSequence::setConsiderHiddenQuestionsEnabled ( $considerHiddenQuestionsEnabled )

Parameters

boolean $considerHiddenQuestionsEnabled

Definition at line 880 of file class.ilTestSequence.php.

References $considerHiddenQuestionsEnabled.

     {
         $this->considerHiddenQuestionsEnabled = $considerHiddenQuestionsEnabled;
     }

◆ setConsiderOptionalQuestionsEnabled()

ilTestSequence::setConsiderOptionalQuestionsEnabled ( $considerOptionalQuestionsEnabled )

Parameters

boolean $considerOptionalQuestionsEnabled

Definition at line 896 of file class.ilTestSequence.php.

References $considerOptionalQuestionsEnabled.

     {
         $this->considerOptionalQuestionsEnabled = $considerOptionalQuestionsEnabled;
     }

◆ setPass()

ilTestSequence::setPass ( $pass )

Definition at line 738 of file class.ilTestSequence.php.

References $pass.

     {
         $this->pass = $pass;
     }

◆ setQuestionChecked()

ilTestSequence::setQuestionChecked ( $questionId )

Definition at line 480 of file class.ilTestSequence.php.

     {
         $this->newlyCheckedQuestion = $questionId;
     }

◆ setQuestionOptional()

ilTestSequence::setQuestionOptional ( $questionId )

Definition at line 812 of file class.ilTestSequence.php.

Referenced by ilLOTestQuestionAdapter\setQuestionsOptional().

     {
         $this->optionalQuestions[$questionId] = $questionId;
     }

Here is the caller graph for this function:

◆ setQuestionPresented()

ilTestSequence::setQuestionPresented ( $questionId )

Definition at line 447 of file class.ilTestSequence.php.

     {
         $this->newlyPresentedQuestion = $questionId;
     }

Field Documentation

◆ $active_id

ilTestSequence::$active_id

Definition at line 37 of file class.ilTestSequence.php.

Referenced by __construct(), getActiveId(), and ilTestSequenceRandomQuestionSet\hasRandomQuestionsForPass().

◆ $alreadyCheckedQuestions

ilTestSequence::$alreadyCheckedQuestions

protected

Definition at line 66 of file class.ilTestSequence.php.

◆ $alreadyPresentedQuestions

ilTestSequence::$alreadyPresentedQuestions = array()

protected

Definition at line 56 of file class.ilTestSequence.php.

◆ $answeringOptionalQuestionsConfirmed

ilTestSequence::$answeringOptionalQuestionsConfirmed

private

Definition at line 81 of file class.ilTestSequence.php.

Referenced by isAnsweringOptionalQuestionsConfirmed(), and setAnsweringOptionalQuestionsConfirmed().

◆ $considerHiddenQuestionsEnabled

ilTestSequence::$considerHiddenQuestionsEnabled

private

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

Referenced by isConsiderHiddenQuestionsEnabled(), and setConsiderHiddenQuestionsEnabled().

◆ $considerOptionalQuestionsEnabled

ilTestSequence::$considerOptionalQuestionsEnabled

private

Definition at line 91 of file class.ilTestSequence.php.

Referenced by isConsiderOptionalQuestionsEnabled(), and setConsiderOptionalQuestionsEnabled().

◆ $isRandomTest

ilTestSequence::$isRandomTest

Definition at line 51 of file class.ilTestSequence.php.

◆ $newlyCheckedQuestion

ilTestSequence::$newlyCheckedQuestion

protected

Definition at line 71 of file class.ilTestSequence.php.

◆ $newlyPresentedQuestion

ilTestSequence::$newlyPresentedQuestion = 0

protected

Definition at line 61 of file class.ilTestSequence.php.

◆ $optionalQuestions

ilTestSequence::$optionalQuestions

protected

Definition at line 76 of file class.ilTestSequence.php.

Referenced by getOptionalQuestions().

◆ $pass

ilTestSequence::$pass

Definition at line 44 of file class.ilTestSequence.php.

Referenced by __construct(), getPass(), getSequenceSummary(), ilTestSequenceRandomQuestionSet\hasRandomQuestionsForPass(), hideCorrectAnsweredQuestions(), and setPass().

◆ $questions

ilTestSequence::$questions

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

Referenced by getOrderedSequenceQuestions().

◆ $sequencedata

ilTestSequence::$sequencedata

Definition at line 23 of file class.ilTestSequence.php.

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

Modules/Test/classes/class.ilTestSequence.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearHiddenQuestions()

◆ clearOptionalQuestions()

◆ createNewSequence()

◆ ensureQuestionNotInSequence()

◆ getActiveId()

◆ getCorrectedSequence()

◆ getFirstSequence()

◆ getLastSequence()

◆ getNextSequence()

◆ getOptionalQuestions()

◆ getOrderedSequence()

◆ getOrderedSequenceQuestions()

◆ getPass()

◆ getPositionOfSequence()

◆ getPreviousSequence()

◆ getQuestionForSequence()

◆ getQuestionIds()

◆ getSequenceForQuestion()

◆ getSequenceSummary()

◆ getUserQuestionCount()

◆ getUserSequence()

◆ getUserSequenceQuestions()

◆ hasHiddenQuestions()

◆ hasOptionalQuestions()

◆ hasSequence()

◆ hasStarted()

◆ hideCorrectAnsweredQuestions()

◆ hideQuestion()

◆ hideSequence()

◆ isAnsweringOptionalQuestionsConfirmed()

◆ isConsiderHiddenQuestionsEnabled()

◆ isConsiderOptionalQuestionsEnabled()

◆ isHiddenQuestion()

◆ isHiddenSequence()

◆ isNextQuestionPresented()

◆ isPostponedQuestion()

◆ isPostponedSequence()

◆ isQuestionChecked()

◆ isQuestionOptional()

◆ isQuestionPresented()

◆ loadCheckedQuestions()

◆ loadFromDb()

◆ loadOptionalQuestions()

◆ loadPresentedQuestions()

◆ loadQuestions()

◆ loadQuestionSequence()

◆ openQuestionExists()

◆ pcArrayShuffle()

◆ postponeQuestion()

◆ postponeSequence()

◆ questionExists()

◆ reorderOptionalQuestionsToSequenceEnd()

◆ saveNewlyCheckedQuestion()

◆ saveNewlyPresentedQuestion()

◆ saveOptionalQuestions()

◆ saveQuestionSequence()

◆ saveToDb()

◆ setAnsweringOptionalQuestionsConfirmed()

◆ setConsiderHiddenQuestionsEnabled()

◆ setConsiderOptionalQuestionsEnabled()

◆ setPass()

◆ setQuestionChecked()

◆ setQuestionOptional()

◆ setQuestionPresented()

Field Documentation

◆ $active_id

◆ $alreadyCheckedQuestions

◆ $alreadyPresentedQuestions

◆ $answeringOptionalQuestionsConfirmed

◆ $considerHiddenQuestionsEnabled