ilAssQuestionPreviewSession Class Reference

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 11 of file class.ilAssQuestionPreviewSession.php.

Constructor & Destructor Documentation

__construct()

ilAssQuestionPreviewSession::__construct	(		$userId,
			$questionId
	)

Definition at line 23 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 106 of file class.ilAssQuestionPreviewSession.php.

References readSessionValue(), and saveSessionValue().

    {
        $requestedHints = $this->readSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS);
        $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 138 of file class.ilAssQuestionPreviewSession.php.

References $_SESSION, array, and getSessionContextIndex().

Referenced by init().

    {
        if (!isset($_SESSION[self::SESSION_BASEINDEX]) || !is_array($_SESSION[self::SESSION_BASEINDEX])) {
            $_SESSION[self::SESSION_BASEINDEX] = array();
        }

        $baseSession = &$_SESSION[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;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNumRequestedHints()

ilAssQuestionPreviewSession::getNumRequestedHints

(

)

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

References readSessionValue().

    {
        $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 79 of file class.ilAssQuestionPreviewSession.php.

References readSessionValue().

Referenced by assNumeric\calculateReachedPointsFromPreviewSession(), assErrorText\calculateReachedPointsFromPreviewSession(), assFlashQuestion\calculateReachedPointsFromPreviewSession(), assSingleChoice\calculateReachedPointsFromPreviewSession(), assJavaApplet\calculateReachedPointsFromPreviewSession(), assImagemapQuestion\calculateReachedPointsFromPreviewSession(), assOrderingQuestion\calculateReachedPointsFromPreviewSession(), assFormulaQuestion\calculateReachedPointsFromPreviewSession(), assClozeTest\calculateReachedPointsFromPreviewSession(), assQuestion\calculateReachedPointsFromPreviewSession(), assFileUpload\getPreviewFileUploads(), assImagemapQuestion\savePreviewData(), assFileUpload\savePreviewData(), and assFormulaQuestion\savePreviewData().

    {
        return $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 39 of file class.ilAssQuestionPreviewSession.php.

References $questionId.

    {
        return $this->questionId;
    }

getRandomizerSeed()

ilAssQuestionPreviewSession::getRandomizerSeed

(

)

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

References readSessionValue().

Referenced by randomizerSeedExists().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getRequestedHints()

ilAssQuestionPreviewSession::getRequestedHints

(

)

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

References readSessionValue().

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

Here is the call graph for this function:

getSessionContextIndex()

ilAssQuestionPreviewSession::getSessionContextIndex ( )

private

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

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

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

Here is the caller graph for this function:

getUserId()

ilAssQuestionPreviewSession::getUserId

(

)

Definition at line 34 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 84 of file class.ilAssQuestionPreviewSession.php.

References issetSessionValue().

Referenced by assOrderingQuestion\calculateReachedPointsFromPreviewSession().

    {
        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 29 of file class.ilAssQuestionPreviewSession.php.

References ensureSessionStructureExists().

    {
        $this->ensureSessionStructureExists();
    }

Here is the call graph for this function:

isHintRequested()

ilAssQuestionPreviewSession::isHintRequested

(

$hintId

)

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

References readSessionValue().

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

Here is the call graph for this function:

isInstantResponseActive()

ilAssQuestionPreviewSession::isInstantResponseActive

(

)

Definition at line 69 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 54 of file class.ilAssQuestionPreviewSession.php.

References $_SESSION, and getSessionContextIndex().

Referenced by hasParticipantSolution().

    {
        return isset($_SESSION[self::SESSION_BASEINDEX][$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 133 of file class.ilAssQuestionPreviewSession.php.

References getRandomizerSeed().

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

Here is the call graph for this function:

readSessionValue()

ilAssQuestionPreviewSession::readSessionValue (   $subIndex )

private

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

References $_SESSION, and getSessionContextIndex().

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

    {
        return $_SESSION[self::SESSION_BASEINDEX][$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 118 of file class.ilAssQuestionPreviewSession.php.

References array, and saveSessionValue().

    {
        $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 49 of file class.ilAssQuestionPreviewSession.php.

References $_SESSION, and getSessionContextIndex().

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

    {
        $_SESSION[self::SESSION_BASEINDEX][$this->getSessionContextIndex()][$subIndex] = $value;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setInstantResponseActive()

ilAssQuestionPreviewSession::setInstantResponseActive

(

$instantResponseActive

)

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

References saveSessionValue().

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

Here is the call graph for this function:

setParticipantsSolution()

ilAssQuestionPreviewSession::setParticipantsSolution

(

$participantSolution

)

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

References saveSessionValue().

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

    {
        $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 123 of file class.ilAssQuestionPreviewSession.php.

References saveSessionValue().

    {
        $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 21 of file class.ilAssQuestionPreviewSession.php.

Referenced by __construct(), and getQuestionId().

$userId

ilAssQuestionPreviewSession::$userId

private

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

Referenced by __construct(), and getUserId().

SESSION_BASEINDEX

const ilAssQuestionPreviewSession::SESSION_BASEINDEX = 'ilAssQuestionPreviewSessions'

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

SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE

const ilAssQuestionPreviewSession::SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE = 'instantResponseActive'

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

SESSION_SUBINDEX_PARTICIPANT_SOLUTION

const ilAssQuestionPreviewSession::SESSION_SUBINDEX_PARTICIPANT_SOLUTION = 'participantSolution'

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

SESSION_SUBINDEX_RANDOMIZER_SEED

const ilAssQuestionPreviewSession::SESSION_SUBINDEX_RANDOMIZER_SEED = 'randomizerSeed'

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

SESSION_SUBINDEX_REQUESTED_HINTS

const ilAssQuestionPreviewSession::SESSION_SUBINDEX_REQUESTED_HINTS = 'requestedHints'

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

---

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

• Modules/TestQuestionPool/classes/class.ilAssQuestionPreviewSession.php