Test sequence handler. More...

Inheritance diagram for ilTestSequence:

Collaboration diagram for ilTestSequence:

Public Member Functions
	__construct (protected ilDBInterface $db, protected int $active_id, protected int $pass, protected GeneralQuestionPropertiesRepository $questionrepository)
	ilTestSequence constructor More...

	getActiveId ()

	createNewSequence (int $max, bool $shuffle)

	loadQuestions ()
	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 (int $question_id)

	hideQuestion (int $question_id)

	isPostponedQuestion (int $question_id)

	isHiddenQuestion (int $question_id)

	isPostponedSequence (int $sequence)

	isHiddenSequence (int $sequence)

	postponeSequence (int $sequence)

	hideSequence (int $sequence)

	setQuestionPresented (int $question_id)

	isQuestionPresented (int $question_id)

	isNextQuestionPresented (int $question_id)

	setQuestionChecked (int $question_id)

	isQuestionChecked (int $question_id)

	getPositionOfSequence (int $sequence)

	getUserQuestionCount ()

	getOrderedSequence ()

	getOrderedSequenceQuestions ()

	getUserSequence ()

	getUserSequenceQuestions ()

	getSequenceForQuestion (int $question_id)

	getFirstSequence ()

	getLastSequence ()

	getNextSequence (int $sequence)

	getPreviousSequence (int $sequence)

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

	getQuestionForSequence (int $sequence)

	getSequenceSummary ()

	getPass ()

	setPass (int $pass)

	hasSequence ()

	hasHiddenQuestions ()

	clearHiddenQuestions ()

	hasStarted (ilTestSession $testSession)

	openQuestionExists ()

	getQuestionIds ()

	questionExists (int $question_id)

	setQuestionOptional (int $question_id)

	isQuestionOptional (int $question_id)

	hasOptionalQuestions ()

	getOptionalQuestions ()

	clearOptionalQuestions ()

	reorderOptionalQuestionsToSequenceEnd ()

	isAnsweringOptionalQuestionsConfirmed ()

	setAnsweringOptionalQuestionsConfirmed (bool $answeringOptionalQuestionsConfirmed)

	isConsiderHiddenQuestionsEnabled ()

	setConsiderHiddenQuestionsEnabled (bool $considerHiddenQuestionsEnabled)

	isConsiderOptionalQuestionsEnabled ()

	setConsiderOptionalQuestionsEnabled (bool $considerOptionalQuestionsEnabled)

Data Fields
array	$sequencedata
	An array containing the sequence data. More...

array	$questions
	The mapping of the sequence numbers to the questions. More...

Protected Member Functions
	loadPresentedQuestions ()

	saveNewlyPresentedQuestion ()

	getCorrectedSequence ()

Protected Attributes
array	$alreadyPresentedQuestions = []

int	$newlyPresentedQuestion = 0

array	$alreadyCheckedQuestions = []

int	$newlyCheckedQuestion = null

array	$optionalQuestions = []

Private Member Functions
	loadQuestionSequence ()

	loadCheckedQuestions ()

	loadOptionalQuestions ()

	saveQuestionSequence ()

	saveNewlyCheckedQuestion ()

	saveOptionalQuestions ()

	ensureQuestionNotInSequence (array $sequence, int $question_id)

Private Attributes
bool	$answeringOptionalQuestionsConfirmed = false

bool	$considerHiddenQuestionsEnabled = false

bool	$considerOptionalQuestionsEnabled = true

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 32 of file class.ilTestSequence.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestSequence::__construct	(	protected ilDBInterface	$db,
		protected int	$active_id,
		protected int	$pass,
		protected GeneralQuestionPropertiesRepository	$questionrepository
	)

ilTestSequence constructor

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

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

       {
         $this->sequencedata = [
             "sequence" => [],
             "postponed" => [],
             "hidden" => []
         ];
     }

Member Function Documentation

◆ clearHiddenQuestions()

ilTestSequence::clearHiddenQuestions ( )

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

Referenced by ilLOTestQuestionAdapter\hideQuestions().

                                           : void
     {
         $this->sequencedata["hidden"] = [];
     }

Here is the caller graph for this function:

◆ clearOptionalQuestions()

ilTestSequence::clearOptionalQuestions ( )

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

Referenced by ilLOTestQuestionAdapter\setQuestionsOptional().

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

Here is the caller graph for this function:

◆ createNewSequence()

ilTestSequence::createNewSequence	(	int	$max,
		bool	$shuffle
	)

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

References pcArrayShuffle().

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

Here is the call graph for this function:

◆ ensureQuestionNotInSequence()

ilTestSequence::ensureQuestionNotInSequence	(	array	$sequence,
		int	$question_id
	)

private

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

Referenced by getCorrectedSequence().

                                                                                    : array
     {
         $question_key = array_search($question_id, $this->questions);
 
         if ($question_key === false) {
             return $sequence;
         }
 
         $sequence_key = array_search($question_key, $sequence);
 
         if ($sequence_key === false) {
             return $sequence;
         }
 
         unset($sequence[$sequence_key]);
 
         return $sequence;
     }

Here is the caller graph for this function:

◆ getActiveId()

ilTestSequence::getActiveId ( )

Implements ilTestSequenceSummaryProvider.

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

                                  : int
     {
         return $this->active_id;
     }

◆ getCorrectedSequence()

ilTestSequence::getCorrectedSequence ( )

protected

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

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

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

                                              : array
     {
         $corrected_sequence = $this->sequencedata["sequence"];
         if (!$this->isConsiderHiddenQuestionsEnabled()
             && is_array($this->sequencedata["hidden"])) {
             foreach ($this->sequencedata["hidden"] as $question_id) {
                 $corrected_sequence = $this->ensureQuestionNotInSequence($corrected_sequence, $question_id);
             }
         }
         if (!$this->isConsiderOptionalQuestionsEnabled()) {
             foreach ($this->optionalQuestions as $question_id) {
                 $corrected_sequence = $this->ensureQuestionNotInSequence($corrected_sequence, $question_id);
             }
         }
         if (is_array($this->sequencedata["postponed"])) {
             foreach ($this->sequencedata["postponed"] as $question_id) {
                 $found_sequence = array_search($question_id, $this->questions);
                 if ($found_sequence === false) {
                     continue;
                 }
                 $sequence_key = array_search($found_sequence, $corrected_sequence);
                 if ($sequence_key !== false) {
                     unset($corrected_sequence[$sequence_key]);
                     $corrected_sequence[] = $found_sequence;
                 }
             }
         }
         return array_values($corrected_sequence);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFirstSequence()

ilTestSequence::getFirstSequence ( )

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

References getCorrectedSequence().

Referenced by hasStarted(), and openQuestionExists().

                                       : int
     {
         $correctedsequence = $this->getCorrectedSequence();
         if (count($correctedsequence)) {
             return reset($correctedsequence);
         }
 
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastSequence()

ilTestSequence::getLastSequence ( )

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

References getCorrectedSequence().

                                      : int
     {
         $correctedsequence = $this->getCorrectedSequence();
         if (count($correctedsequence)) {
             return end($correctedsequence);
         }
 
         return 0;
     }

Here is the call graph for this function:

◆ getNextSequence()

ilTestSequence::getNextSequence ( int $sequence )

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

References getCorrectedSequence().

Referenced by isNextQuestionPresented().

                                                   : int
     {
         $corrected_sequence = $this->getCorrectedSequence();
         $sequence_key = array_search($sequence, $corrected_sequence);
         if ($sequence_key !== false) {
             $next_sequence_key = $sequence_key + 1;
             if (array_key_exists($next_sequence_key, $corrected_sequence)) {
                 return $corrected_sequence[$next_sequence_key];
             }
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOptionalQuestions()

ilTestSequence::getOptionalQuestions ( )

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

References $optionalQuestions.

                                           : array
     {
         return $this->optionalQuestions;
     }

◆ getOrderedSequence()

ilTestSequence::getOrderedSequence ( )

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

References isConsiderHiddenQuestionsEnabled(), and isHiddenSequence().

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

Here is the call graph for this function:

◆ getOrderedSequenceQuestions()

ilTestSequence::getOrderedSequenceQuestions ( )

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

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

                                                  : array
     {
         $questions = [];
 
         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 643 of file class.ilTestSequence.php.

                              : int
     {
         return $this->pass;
     }

◆ getPositionOfSequence()

ilTestSequence::getPositionOfSequence ( int $sequence )

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

References getCorrectedSequence().

                                                         : int
     {
         $corrected_sequence = $this->getCorrectedSequence();
         $sequence_key = array_search($sequence, $corrected_sequence);
         if ($sequence_key !== false) {
             return $sequence_key + 1;
         }
         return 0;
     }

Here is the call graph for this function:

◆ getPreviousSequence()

ilTestSequence::getPreviousSequence ( int $sequence )

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

References getCorrectedSequence().

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

Here is the call graph for this function:

◆ getQuestionForSequence()

ilTestSequence::getQuestionForSequence ( int $sequence )

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

References null.

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

                                                          : ?int
     {
         if ($sequence < 1) {
             return null;
         }
         if (array_key_exists($sequence, $this->questions)) {
             return $this->questions[$sequence];
         }
 
         return null;
     }

Here is the caller graph for this function:

◆ getQuestionIds()

ilTestSequence::getQuestionIds ( )

Implements ilTestQuestionSequence.

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

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

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

Here is the caller graph for this function:

◆ getSequenceForQuestion()

ilTestSequence::getSequenceForQuestion ( int $question_id )

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

References null.

Referenced by isNextQuestionPresented().

                                                             : ?int
     {
         return array_search($question_id, $this->questions) ?: null;
     }

Here is the caller graph for this function:

◆ getSequenceSummary()

ilTestSequence::getSequenceSummary ( )

Implements ilTestSequenceSummaryProvider.

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

References ilObjTest\_getSolvedQuestions(), getCorrectedSequence(), getQuestionForSequence(), assQuestion\instantiateQuestion(), isPostponedQuestion(), and isQuestionPresented().

                                         : array
     {
         $correctedsequence = $this->getCorrectedSequence();
         $result_array = [];
         $solved_questions = ilObjTest::_getSolvedQuestions($this->active_id);
         $key = 1;
         foreach ($correctedsequence as $sequence) {
             $question = assQuestion::instantiateQuestion($this->getQuestionForSequence($sequence));
             if (is_object($question)) {
                 $worked_through = $this->questionrepository->lookupResultRecordExist($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());
 
                 $result_array[] = [
                     'nr' => $key,
                     'title' => $question->getTitleForHTMLOutput(),
                     '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,
                     'isAnswered' => $question->isAnswered($this->active_id, $this->pass),
                     'has_authorized_answer' => $question->authorizedSolutionExists($this->active_id, $this->pass)
                 ];
 
                 $key++;
             }
         }
         return $result_array;
     }

Here is the call graph for this function:

◆ getUserQuestionCount()

ilTestSequence::getUserQuestionCount ( )

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

References getCorrectedSequence().

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

Here is the call graph for this function:

◆ getUserSequence()

ilTestSequence::getUserSequence ( )

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

References getCorrectedSequence().

                                      : array
     {
         return $this->getCorrectedSequence();
     }

Here is the call graph for this function:

◆ getUserSequenceQuestions()

ilTestSequence::getUserSequenceQuestions ( )

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

References getCorrectedSequence(), and getQuestionForSequence().

                                               : array
     {
         $seq = $this->getCorrectedSequence();
         $found = [];
         foreach ($seq as $sequence) {
             $found[] = $this->getQuestionForSequence($sequence);
         }
         return $found;
     }

Here is the call graph for this function:

◆ hasHiddenQuestions()

ilTestSequence::hasHiddenQuestions ( )

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

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

◆ hasOptionalQuestions()

ilTestSequence::hasOptionalQuestions ( )

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

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

◆ hasSequence()

ilTestSequence::hasSequence ( )

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

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

◆ hasStarted()

ilTestSequence::hasStarted ( ilTestSession $testSession )

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

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

                                                           : bool
     {
         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:

◆ hideQuestion()

ilTestSequence::hideQuestion ( int $question_id )

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

References isHiddenQuestion().

Referenced by ilLOTestQuestionAdapter\hideQuestions().

                                                   : void
     {
         if (!$this->isHiddenQuestion($question_id)) {
             $this->sequencedata["hidden"][] = $question_id;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hideSequence()

ilTestSequence::hideSequence ( int $sequence )

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

References ILIAS\Repository\int(), and isHiddenSequence().

                                                : void
     {
         if (!$this->isHiddenSequence($sequence)) {
             if (array_key_exists($sequence, $this->questions)) {
                 if (!is_array($this->sequencedata["hidden"])) {
                     $this->sequencedata["hidden"] = [];
                 }
                 $this->sequencedata["hidden"][] = (int) $this->questions[$sequence];
             }
         }
     }

Here is the call graph for this function:

◆ isAnsweringOptionalQuestionsConfirmed()

ilTestSequence::isAnsweringOptionalQuestionsConfirmed ( )

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

References $answeringOptionalQuestionsConfirmed.

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

                                                            : bool
     {
         return $this->answeringOptionalQuestionsConfirmed;
     }

Here is the caller graph for this function:

◆ isConsiderHiddenQuestionsEnabled()

ilTestSequence::isConsiderHiddenQuestionsEnabled ( )

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

References $considerHiddenQuestionsEnabled.

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

                                                       : bool
     {
         return $this->considerHiddenQuestionsEnabled;
     }

Here is the caller graph for this function:

◆ isConsiderOptionalQuestionsEnabled()

ilTestSequence::isConsiderOptionalQuestionsEnabled ( )

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

References $considerOptionalQuestionsEnabled.

Referenced by getCorrectedSequence(), and getOrderedSequenceQuestions().

                                                         : bool
     {
         return $this->considerOptionalQuestionsEnabled;
     }

Here is the caller graph for this function:

◆ isHiddenQuestion()

ilTestSequence::isHiddenQuestion ( int $question_id )

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

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

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

Here is the caller graph for this function:

◆ isHiddenSequence()

ilTestSequence::isHiddenSequence ( int $sequence )

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

Referenced by getOrderedSequence(), and hideSequence().

                                                    : bool
     {
         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;
         }
         return true;
     }

Here is the caller graph for this function:

◆ isNextQuestionPresented()

ilTestSequence::isNextQuestionPresented ( int $question_id )

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

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

                                                              : bool
     {
         $next_question_id = $this->getQuestionForSequence(
             $this->getNextSequence($this->getSequenceForQuestion($question_id)) ?? 0
         );
 
         if ($next_question_id === null) {
             return false;
         }
 
         if ($this->newlyPresentedQuestion === $next_question_id) {
             return true;
         }
 
         if (in_array($next_question_id, $this->alreadyPresentedQuestions)) {
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

◆ isPostponedQuestion()

ilTestSequence::isPostponedQuestion ( int $question_id )

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

Referenced by getSequenceSummary(), and postponeQuestion().

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

Here is the caller graph for this function:

◆ isPostponedSequence()

ilTestSequence::isPostponedSequence ( int $sequence )

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

Referenced by postponeSequence().

                                                       : bool
     {
         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;
         }
 
         return true;
     }

Here is the caller graph for this function:

◆ isQuestionChecked()

ilTestSequence::isQuestionChecked ( int $question_id )

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

                                                        : bool
     {
         return isset($this->alreadyCheckedQuestions[$question_id]);
     }

◆ isQuestionOptional()

ilTestSequence::isQuestionOptional ( int $question_id )

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

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

                                                         : bool
     {
         return isset($this->optionalQuestions[$question_id]);
     }

Here is the caller graph for this function:

◆ isQuestionPresented()

ilTestSequence::isQuestionPresented ( int $question_id )

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

Referenced by getSequenceSummary().

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

Here is the caller graph for this function:

◆ loadCheckedQuestions()

ilTestSequence::loadCheckedQuestions ( )

private

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

References $res.

Referenced by loadFromDb().

                                            : void
     {
         $res = $this->db->queryF(
             "SELECT question_fi FROM tst_seq_qst_checked WHERE active_fi = %s AND pass = %s",
             ['integer','integer'],
             [$this->active_id, $this->pass]
         );
 
         while ($row = $this->db->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.

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

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

Referenced by ilTestVirtualSequence\getTestSequence().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadOptionalQuestions()

ilTestSequence::loadOptionalQuestions ( )

private

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

References $res.

Referenced by loadFromDb().

                                             : void
     {
         $res = $this->db->queryF(
             "SELECT question_fi FROM tst_seq_qst_optional WHERE active_fi = %s AND pass = %s",
             ['integer','integer'],
             [$this->active_id, $this->pass]
         );
 
         while ($row = $this->db->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 159 of file class.ilTestSequence.php.

References $res.

Referenced by loadFromDb().

                                                : void
     {
         $res = $this->db->queryF(
             "SELECT question_fi FROM tst_seq_qst_presented WHERE active_fi = %s AND pass = %s",
             ['integer','integer'],
             [$this->active_id, $this->pass]
         );
 
         while ($row = $this->db->fetchAssoc($res)) {
             $this->alreadyPresentedQuestions[ $row['question_fi'] ] = $row['question_fi'];
         }
     }

Here is the caller graph for this function:

◆ loadQuestions()

ilTestSequence::loadQuestions ( )

Loads the question mapping.

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

References $data.

                                    : void
     {
         $this->questions = [];
 
         $result = $this->db->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",
             ['integer'],
             [$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 = $this->db->fetchAssoc($result)) {
             $this->questions[$index++] = $data["question_fi"];
         }
     }

◆ loadQuestionSequence()

ilTestSequence::loadQuestionSequence ( )

private

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

References setAnsweringOptionalQuestionsConfirmed().

Referenced by loadFromDb().

                                            : void
     {
         $result = $this->db->queryF(
             "SELECT * FROM tst_sequence WHERE active_fi = %s AND pass = %s",
             ['integer','integer'],
             [$this->active_id, $this->pass]
         );
         if ($result->numRows()) {
             $row = $this->db->fetchAssoc($result);
             $this->sequencedata = [
                 "sequence" => unserialize($row["sequence"] ?? '', ['allowed_classes' => false]),
                 "postponed" => unserialize($row["postponed"] ?? '', ['allowed_classes' => false]),
                 "hidden" => unserialize($row["hidden"] ?? '', ['allowed_classes' => false])
             ];
 
             if (!is_array($this->sequencedata["sequence"])) {
                 $this->sequencedata["sequence"] = [];
             }
             if (!is_array($this->sequencedata["postponed"])) {
                 $this->sequencedata["postponed"] = [];
             }
             if (!is_array($this->sequencedata["hidden"])) {
                 $this->sequencedata["hidden"] = [];
             }
 
             $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 690 of file class.ilTestSequence.php.

References getFirstSequence().

                                         : bool
     {
         return $this->getFirstSequence() !== 0;
     }

Here is the call graph for this function:

◆ pcArrayShuffle()

ilTestSequence::pcArrayShuffle ( array $array )

Shuffles the values of a given array.

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

Referenced by createNewSequence().

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

Here is the caller graph for this function:

◆ postponeQuestion()

ilTestSequence::postponeQuestion ( int $question_id )

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

References isPostponedQuestion().

                                                       : void
     {
         if (!$this->isPostponedQuestion($question_id)) {
             $this->sequencedata["postponed"][] = $question_id;
         }
     }

Here is the call graph for this function:

◆ postponeSequence()

ilTestSequence::postponeSequence ( int $sequence )

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

References ILIAS\Repository\int(), and isPostponedSequence().

                                                    : void
     {
         if (!$this->isPostponedSequence($sequence)) {
             if (array_key_exists($sequence, $this->questions)) {
                 if (!is_array($this->sequencedata["postponed"])) {
                     $this->sequencedata["postponed"] = [];
                 }
                 $this->sequencedata["postponed"][] = (int) $this->questions[$sequence];
             }
         }
     }

Here is the call graph for this function:

◆ questionExists()

ilTestSequence::questionExists ( int $question_id )

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

                                                     : bool
     {
         return in_array($question_id, $this->questions);
     }

◆ reorderOptionalQuestionsToSequenceEnd()

ilTestSequence::reorderOptionalQuestionsToSequenceEnd ( )

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

References getQuestionForSequence(), and isQuestionOptional().

                                                            : void
     {
         $optionalSequenceKeys = [];
 
         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

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

Referenced by saveToDb().

                                                : void
     {
         if ((int) $this->newlyCheckedQuestion) {
             $this->db->replace('tst_seq_qst_checked', [
                 'active_fi' => ['integer', $this->active_id],
                 'pass' => ['integer', $this->pass],
                 'question_fi' => ['integer', (int) $this->newlyCheckedQuestion]
             ], []);
         }
     }

Here is the caller graph for this function:

◆ saveNewlyPresentedQuestion()

ilTestSequence::saveNewlyPresentedQuestion ( )

protected

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

Referenced by saveToDb().

                                                    : void
     {
         if ($this->newlyPresentedQuestion) {
             $this->db->replace('tst_seq_qst_presented', [
                 'active_fi' => ['integer', $this->active_id],
                 'pass' => ['integer', $this->pass],
                 'question_fi' => ['integer', $this->newlyPresentedQuestion]
             ], []);
         }
     }

Here is the caller graph for this function:

◆ saveOptionalQuestions()

ilTestSequence::saveOptionalQuestions ( )

private

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

Referenced by saveToDb().

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

Here is the caller graph for this function:

◆ saveQuestionSequence()

ilTestSequence::saveQuestionSequence ( )

private

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

References isAnsweringOptionalQuestionsConfirmed(), and null.

Referenced by saveToDb().

                                            : void
     {
         $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"]);
         }
 
         $this->db->manipulateF(
             "DELETE FROM tst_sequence WHERE active_fi = %s AND pass = %s",
             ['integer','integer'],
             [$this->active_id, $this->pass]
         );
 
         $this->db->insert("tst_sequence", [
             "active_fi" => ["integer", $this->active_id],
             "pass" => ["integer", $this->pass],
             "sequence" => ["clob", serialize($this->sequencedata["sequence"])],
             "postponed" => ["text", $postponed],
             "hidden" => ["text", $hidden],
             "tstamp" => ["integer", time()],
             'ans_opt_confirmed' => ['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 203 of file class.ilTestSequence.php.

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

Referenced by ilLOTestQuestionAdapter\prepareTestPass().

                               : void
     {
         $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 ( bool $answeringOptionalQuestionsConfirmed )

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

References $answeringOptionalQuestionsConfirmed.

Referenced by loadQuestionSequence().

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

Here is the caller graph for this function:

◆ setConsiderHiddenQuestionsEnabled()

ilTestSequence::setConsiderHiddenQuestionsEnabled ( bool $considerHiddenQuestionsEnabled )

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

References $considerHiddenQuestionsEnabled.

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

◆ setConsiderOptionalQuestionsEnabled()

ilTestSequence::setConsiderOptionalQuestionsEnabled ( bool $considerOptionalQuestionsEnabled )

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

References $considerOptionalQuestionsEnabled.

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

◆ setPass()

ilTestSequence::setPass ( int $pass )

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

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

◆ setQuestionChecked()

ilTestSequence::setQuestionChecked ( int $question_id )

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

                                                         : void
     {
         $this->newlyCheckedQuestion = $question_id;
     }

◆ setQuestionOptional()

ilTestSequence::setQuestionOptional ( int $question_id )

Todo:: sk - 2023-05-22: These Optional Questions seem to be something related to the Object Oriented Course, but even asking around, we are actually unsure: Thus marked as to be checked.

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

Referenced by ilLOTestQuestionAdapter\setQuestionsOptional().

                                                          : void
     {
         $this->optionalQuestions[$question_id] = $question_id;
     }

Here is the caller graph for this function:

◆ setQuestionPresented()

ilTestSequence::setQuestionPresented ( int $question_id )

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

                                                           : void
     {
         $this->newlyPresentedQuestion = $question_id;
     }

Field Documentation

◆ $alreadyCheckedQuestions

array ilTestSequence::$alreadyCheckedQuestions = []

protected

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

◆ $alreadyPresentedQuestions

array ilTestSequence::$alreadyPresentedQuestions = []

protected

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

◆ $answeringOptionalQuestionsConfirmed

bool ilTestSequence::$answeringOptionalQuestionsConfirmed = false

private

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

Referenced by isAnsweringOptionalQuestionsConfirmed(), and setAnsweringOptionalQuestionsConfirmed().

◆ $considerHiddenQuestionsEnabled

bool ilTestSequence::$considerHiddenQuestionsEnabled = false

private

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

Referenced by isConsiderHiddenQuestionsEnabled(), and setConsiderHiddenQuestionsEnabled().

◆ $considerOptionalQuestionsEnabled

bool ilTestSequence::$considerOptionalQuestionsEnabled = true

private

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

Referenced by isConsiderOptionalQuestionsEnabled(), and setConsiderOptionalQuestionsEnabled().

◆ $newlyCheckedQuestion

int ilTestSequence::$newlyCheckedQuestion = null

protected

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

◆ $newlyPresentedQuestion

int ilTestSequence::$newlyPresentedQuestion = 0

protected

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

◆ $optionalQuestions

array ilTestSequence::$optionalQuestions = []

protected

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

Referenced by getOptionalQuestions().

◆ $questions

array ilTestSequence::$questions

The mapping of the sequence numbers to the questions.

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

Referenced by getOrderedSequenceQuestions().

◆ $sequencedata

array ilTestSequence::$sequencedata

An array containing the sequence data.

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

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

components/ILIAS/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()

◆ 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

◆ $alreadyCheckedQuestions

◆ $alreadyPresentedQuestions

◆ $answeringOptionalQuestionsConfirmed

◆ $considerHiddenQuestionsEnabled

◆ $considerOptionalQuestionsEnabled

◆ $newlyCheckedQuestion