Collaboration diagram for ilAssQuestionPreviewSession:

Public Member Functions
	__construct ($userId, $questionId)

	init ()

	getUserId ()

	getQuestionId ()

	setInstantResponseActive ($instantResponseActive)

	isInstantResponseActive ()

	setParticipantsSolution ($participantSolution)

	getParticipantsSolution ()

	hasParticipantSolution ()

	getNumRequestedHints ()

	isHintRequested ($hintId)

	addRequestedHint ($hintId)

	getRequestedHints ()

	resetRequestedHints ()

	setRandomizerSeed ($seed)

	getRandomizerSeed ()

	randomizerSeedExists ()

Data Fields
const	SESSION_BASEINDEX = 'ilAssQuestionPreviewSessions'

const	SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE = 'instantResponseActive'

const	SESSION_SUBINDEX_PARTICIPANT_SOLUTION = 'participantSolution'

const	SESSION_SUBINDEX_REQUESTED_HINTS = 'requestedHints'

const	SESSION_SUBINDEX_RANDOMIZER_SEED = 'randomizerSeed'

Private Member Functions
	getSessionContextIndex ()

	saveSessionValue ($subIndex, $value)

	issetSessionValue ($subIndex)

	readSessionValue ($subIndex)

	ensureSessionStructureExists ()

Private Attributes
	$userId

	$questionId

Detailed Description

Definition at line 24 of file class.ilAssQuestionPreviewSession.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionPreviewSession::__construct	(	$userId,
		$questionId
	)

Definition at line 36 of file class.ilAssQuestionPreviewSession.php.

References $questionId, and $userId.

     {
         $this->userId = $userId;
         $this->questionId = $questionId;
     }

Member Function Documentation

◆ addRequestedHint()

ilAssQuestionPreviewSession::addRequestedHint ( $hintId )

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

References getRequestedHints(), and saveSessionValue().

                                              : void
     {
         $requestedHints = $this->getRequestedHints();
         $requestedHints[$hintId] = $hintId;
         $this->saveSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS, $requestedHints);
     }

Here is the call graph for this function:

◆ ensureSessionStructureExists()

ilAssQuestionPreviewSession::ensureSessionStructureExists ( )

private

Definition at line 167 of file class.ilAssQuestionPreviewSession.php.

References ilSession\get(), getSessionContextIndex(), and ilSession\set().

Referenced by init().

                                                    : void
     {
         if (!is_array(ilSession::get(self::SESSION_BASEINDEX))) {
             ilSession::set(self::SESSION_BASEINDEX, array());
         }
 
         $baseSession = ilSession::get(self::SESSION_BASEINDEX);
 
         if (!isset($baseSession[$this->getSessionContextIndex()])) {
             $baseSession[$this->getSessionContextIndex()] = array();
         }
 
         $contextSession = &$baseSession[$this->getSessionContextIndex()];
 
         if (!isset($contextSession[self::SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE])) {
             $contextSession[self::SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE] = 0;
         }
 
         if (!isset($contextSession[self::SESSION_SUBINDEX_PARTICIPANT_SOLUTION])) {
             $contextSession[self::SESSION_SUBINDEX_PARTICIPANT_SOLUTION] = null;
         }
 
         if (!isset($contextSession[self::SESSION_SUBINDEX_RANDOMIZER_SEED])) {
             $contextSession[self::SESSION_SUBINDEX_RANDOMIZER_SEED] = null;
         }
 
         ilSession::set(self::SESSION_BASEINDEX, $baseSession);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNumRequestedHints()

ilAssQuestionPreviewSession::getNumRequestedHints ( )

Definition at line 106 of file class.ilAssQuestionPreviewSession.php.

References issetSessionValue(), and readSessionValue().

                                           : int
     {
         if (!$this->issetSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS)) {
             return 0;
         }
         $hints = $this->readSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS);
 
         if (!is_array($hints)) {
             return 0;
         }
 
         return count($hints);
     }

Here is the call graph for this function:

◆ getParticipantsSolution()

ilAssQuestionPreviewSession::getParticipantsSolution ( )

Definition at line 96 of file class.ilAssQuestionPreviewSession.php.

References readSessionValue().

     {
         return $this->readSessionValue(self::SESSION_SUBINDEX_PARTICIPANT_SOLUTION) == [] ? null : $this->readSessionValue(self::SESSION_SUBINDEX_PARTICIPANT_SOLUTION);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionId()

ilAssQuestionPreviewSession::getQuestionId ( )

Definition at line 52 of file class.ilAssQuestionPreviewSession.php.

References $questionId.

     {
         return $this->questionId;
     }

◆ getRandomizerSeed()

ilAssQuestionPreviewSession::getRandomizerSeed ( )

Definition at line 156 of file class.ilAssQuestionPreviewSession.php.

References readSessionValue().

Referenced by randomizerSeedExists().

                                        : ?int
     {
         $val = $this->readSessionValue(self::SESSION_SUBINDEX_RANDOMIZER_SEED);
         return $val === [] ? null : $val;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRequestedHints()

ilAssQuestionPreviewSession::getRequestedHints ( )

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

References issetSessionValue(), and readSessionValue().

Referenced by addRequestedHint().

     {
         if ($this->issetSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS)) {
             return $this->readSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS);
         }
 
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSessionContextIndex()

ilAssQuestionPreviewSession::getSessionContextIndex ( )

private

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

Referenced by ensureSessionStructureExists(), issetSessionValue(), readSessionValue(), and saveSessionValue().

                                              : string
     {
         return "u{$this->userId}::q{$this->questionId}";
     }

Here is the caller graph for this function:

◆ getUserId()

ilAssQuestionPreviewSession::getUserId ( )

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

References $userId.

Referenced by assFileUpload\savePreviewData().

     {
         return $this->userId;
     }

Here is the caller graph for this function:

◆ hasParticipantSolution()

ilAssQuestionPreviewSession::hasParticipantSolution ( )

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

References issetSessionValue().

Referenced by assOrderingQuestion\calculateReachedPointsFromPreviewSession().

                                             : bool
     {
         return $this->issetSessionValue(self::SESSION_SUBINDEX_PARTICIPANT_SOLUTION);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

ilAssQuestionPreviewSession::init ( )

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

References ensureSessionStructureExists().

                           : void
     {
         $this->ensureSessionStructureExists();
     }

Here is the call graph for this function:

◆ isHintRequested()

ilAssQuestionPreviewSession::isHintRequested ( $hintId )

Definition at line 120 of file class.ilAssQuestionPreviewSession.php.

References issetSessionValue(), and readSessionValue().

                                             : bool
     {
         if ($this->issetSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS)) {
             $requestedHints = $this->readSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS);
             return isset($requestedHints[$hintId]);
         }
 
         return false;
     }

Here is the call graph for this function:

◆ isInstantResponseActive()

ilAssQuestionPreviewSession::isInstantResponseActive ( )

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

References readSessionValue().

     {
         return $this->readSessionValue(self::SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE);
     }

Here is the call graph for this function:

◆ issetSessionValue()

ilAssQuestionPreviewSession::issetSessionValue ( $subIndex )

private

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

References ilSession\get(), and getSessionContextIndex().

Referenced by getNumRequestedHints(), getRequestedHints(), hasParticipantSolution(), and isHintRequested().

                                                  : bool
     {
         $val = ilSession::get(self::SESSION_BASEINDEX);
         return isset($val[$this->getSessionContextIndex()][$subIndex]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ randomizerSeedExists()

ilAssQuestionPreviewSession::randomizerSeedExists ( )

Definition at line 162 of file class.ilAssQuestionPreviewSession.php.

References getRandomizerSeed().

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

Here is the call graph for this function:

◆ readSessionValue()

ilAssQuestionPreviewSession::readSessionValue ( $subIndex )

private

Definition at line 75 of file class.ilAssQuestionPreviewSession.php.

References ilSession\get(), and getSessionContextIndex().

Referenced by getNumRequestedHints(), getParticipantsSolution(), getRandomizerSeed(), getRequestedHints(), isHintRequested(), and isInstantResponseActive().

     {
         $val = ilSession::get(self::SESSION_BASEINDEX);
         return $val[$this->getSessionContextIndex()][$subIndex] ?? [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetRequestedHints()

ilAssQuestionPreviewSession::resetRequestedHints ( )

Definition at line 146 of file class.ilAssQuestionPreviewSession.php.

References saveSessionValue().

                                          : void
     {
         $this->saveSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS, array());
     }

Here is the call graph for this function:

◆ saveSessionValue()

ilAssQuestionPreviewSession::saveSessionValue	(	$subIndex,
		$value
	)

private

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

References ilSession\get(), getSessionContextIndex(), and ilSession\set().

Referenced by addRequestedHint(), resetRequestedHints(), setInstantResponseActive(), setParticipantsSolution(), and setRandomizerSeed().

                                                         : void
     {
         $val = ilSession::get(self::SESSION_BASEINDEX);
         $val[$this->getSessionContextIndex()][$subIndex] = $value;
         ilSession::set(self::SESSION_BASEINDEX, $val);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setInstantResponseActive()

ilAssQuestionPreviewSession::setInstantResponseActive ( $instantResponseActive )

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

References saveSessionValue().

                                                                     : void
     {
         $this->saveSessionValue(self::SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE, $instantResponseActive);
     }

Here is the call graph for this function:

◆ setParticipantsSolution()

ilAssQuestionPreviewSession::setParticipantsSolution ( $participantSolution )

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

References saveSessionValue().

Referenced by assErrorText\savePreviewData(), assNumeric\savePreviewData(), assSingleChoice\savePreviewData(), assLongMenu\savePreviewData(), assImagemapQuestion\savePreviewData(), assFileUpload\savePreviewData(), assOrderingQuestion\savePreviewData(), assQuestion\savePreviewData(), assFormulaQuestion\savePreviewData(), and assMatchingQuestion\savePreviewData().

                                                                  : void
     {
         $this->saveSessionValue(self::SESSION_SUBINDEX_PARTICIPANT_SOLUTION, $participantSolution);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRandomizerSeed()

ilAssQuestionPreviewSession::setRandomizerSeed ( $seed )

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

References saveSessionValue().

                                             : void
     {
         $this->saveSessionValue(self::SESSION_SUBINDEX_RANDOMIZER_SEED, $seed);
     }

Here is the call graph for this function:

Field Documentation

◆ $questionId

ilAssQuestionPreviewSession::$questionId

private

Definition at line 34 of file class.ilAssQuestionPreviewSession.php.

Referenced by __construct(), and getQuestionId().

◆ $userId

ilAssQuestionPreviewSession::$userId

private

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

Referenced by __construct(), and getUserId().

◆ SESSION_BASEINDEX

const ilAssQuestionPreviewSession::SESSION_BASEINDEX = 'ilAssQuestionPreviewSessions'

Definition at line 26 of file class.ilAssQuestionPreviewSession.php.

◆ SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE

const ilAssQuestionPreviewSession::SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE = 'instantResponseActive'

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

◆ SESSION_SUBINDEX_PARTICIPANT_SOLUTION

const ilAssQuestionPreviewSession::SESSION_SUBINDEX_PARTICIPANT_SOLUTION = 'participantSolution'

Definition at line 29 of file class.ilAssQuestionPreviewSession.php.

◆ SESSION_SUBINDEX_RANDOMIZER_SEED

const ilAssQuestionPreviewSession::SESSION_SUBINDEX_RANDOMIZER_SEED = 'randomizerSeed'

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

◆ SESSION_SUBINDEX_REQUESTED_HINTS

const ilAssQuestionPreviewSession::SESSION_SUBINDEX_REQUESTED_HINTS = 'requestedHints'

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

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

Modules/TestQuestionPool/classes/class.ilAssQuestionPreviewSession.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addRequestedHint()

◆ ensureSessionStructureExists()

◆ getNumRequestedHints()

◆ getParticipantsSolution()

◆ getQuestionId()

◆ getRandomizerSeed()

◆ getRequestedHints()

◆ getSessionContextIndex()

◆ getUserId()

◆ hasParticipantSolution()

◆ init()

◆ isHintRequested()

◆ isInstantResponseActive()

◆ issetSessionValue()

◆ randomizerSeedExists()

◆ readSessionValue()

◆ resetRequestedHints()

◆ saveSessionValue()

◆ setInstantResponseActive()

◆ setParticipantsSolution()

◆ setRandomizerSeed()

Field Documentation

◆ $questionId

◆ $userId

◆ SESSION_BASEINDEX

◆ SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE

◆ SESSION_SUBINDEX_PARTICIPANT_SOLUTION

◆ SESSION_SUBINDEX_RANDOMIZER_SEED

◆ SESSION_SUBINDEX_REQUESTED_HINTS