Test session handler. More...

Collaboration diagram for ilTestSession:

Public Member Functions
	__construct (protected ilDBInterface $db, protected ilObjUser $user)
	ilTestSession constructor More...

	setRefId (int $ref_id)

	getRefId ()

	increaseTestPass ()

	saveToDb ()

	loadTestSession (int $test_id, int $user_id=0, ?string $anonymous_id=null)

	loadFromDb (int $active_id)

	getActiveId ()

	setUserId (int $user_id)

	getUserId ()

	setTestId (int $test_id)

	getTestId ()

	setAnonymousId (string $anonymous_id)

	getAnonymousId ()

	setLastSequence (int $lastsequence)

	getLastSequence ()

	setPass (int $pass)

	getPass ()

	increasePass ()

	isSubmitted ()

	setSubmitted ()

	getSubmittedTimestamp ()

	setSubmittedTimestamp ()

	setLastFinishedPass (int $lastFinishedPass)

	getLastFinishedPass ()

	setObjectiveOrientedContainerId (int $objectiveOriented)

	getObjectiveOrientedContainerId ()

	getLastStartedPass ()

	setLastStartedPass (int $lastStartedPass)

	isObjectiveOriented ()

	persistTestStartLock (string $testStartLock)

	lookupTestStartLock ()

	setAccessCodeToSession (string $access_code)

	unsetAccessCodeInSession ()

	getAccessCodeFromSession ()

	doesAccessCodeInSessionExists ()

	createNewAccessCode ()

	isAccessCodeUsed (string $code)

	isAnonymousUser ()

	isPasswordChecked ()

	setPasswordChecked (bool $value)

	reportableResultsAvailable (ilObjTest $test_obj)

	hasSinglePassReportable (ilObjTest $testObj)

Data Fields
const	ACCESS_CODE_SESSION_INDEX = "tst_access_code"

const	ACCESS_CODE_CHAR_DOMAIN = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"

const	ACCESS_CODE_LENGTH = 5

int	$active_id = 0

int	$user_id = 0

string	$anonymous_id = ''

int	$test_id = 0

int	$lastsequence = 0

bool	$submitted = false

int	$tstamp = 0

string	$submittedTimestamp = ''

Protected Member Functions
	activeIDExists (int $user_id, int $test_id)

Protected Attributes
string	$lastPresentationMode = null

Private Member Functions
	buildAccessCode ()

Private Attributes
int	$ref_id = 0

int	$pass = 0

int	$objectiveOrientedContainerId = null

int	$lastFinishedPass = null

int	$lastStartedPass = null

bool	$reportable_results_available = null

Detailed Description

Test session handler.

This class manages the test session for a participant

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 30 of file class.ilTestSession.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestSession::__construct	(	protected ilDBInterface	$db,
		protected ilObjUser	$user
	)

ilTestSession constructor

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

@access public

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

64 {

65 }

Member Function Documentation

◆ activeIDExists()

ilTestSession::activeIDExists	(	int	$user_id,
		int	$test_id
	)

protected

Definition at line 77 of file class.ilTestSession.php.

                                                                 : bool
    {
        if ($this->user->getId() === ANONYMOUS_USER_ID) {
            return false;
        }
 
        $result = $this->db->queryF(
            "SELECT * FROM tst_active WHERE user_fi = %s AND test_fi = %s",
            ['integer','integer'],
            [$user_id, $test_id]
        );
        if ($result->numRows()) {
            $row = $this->db->fetchAssoc($result);
            $this->active_id = (int) $row["active_id"];
            $this->user_id = (int) $row["user_fi"];
            $this->anonymous_id = $row["anonymous_id"] ?? '';
            $this->test_id = (int) $row["test_fi"];
            $this->lastsequence = (int) $row["lastindex"];
            $this->pass = (int) $row["tries"];
            $this->submitted = ($row["submitted"]) ? true : false;
            $this->submittedTimestamp = (string) $row["submittimestamp"];
            $this->tstamp = (int) $row["tstamp"];
 
            $this->lastStartedPass = $row['last_started_pass'];
            $this->lastFinishedPass = $row['last_finished_pass'];
            $this->objectiveOrientedContainerId = $row['objective_container'];
 
            return true;
        }
        return false;
    }

References $test_id, $user_id, ANONYMOUS_USER_ID, ILIAS\Repository\int(), and ILIAS\Repository\user().

Referenced by saveToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildAccessCode()

ilTestSession::buildAccessCode ( )

private

Definition at line 470 of file class.ilTestSession.php.

                                      : string
    {
        // create a 5 character code
        $codestring = self::ACCESS_CODE_CHAR_DOMAIN;
 
        mt_srand();
 
        $code = "";
 
        for ($i = 1; $i <= self::ACCESS_CODE_LENGTH; $i++) {
            $index = mt_rand(0, strlen($codestring) - 1);
            $code .= substr($codestring, $index, 1);
        }
 
        return $code;
    }

References ACCESS_CODE_CHAR_DOMAIN, and ACCESS_CODE_LENGTH.

Referenced by createNewAccessCode().

Here is the caller graph for this function:

◆ createNewAccessCode()

ilTestSession::createNewAccessCode ( )

Definition at line 448 of file class.ilTestSession.php.

                                         : string
    {
        do {
            $code = $this->buildAccessCode();
        } while ($this->isAccessCodeUsed($code));
 
        return $code;
    }

References buildAccessCode(), and isAccessCodeUsed().

Here is the call graph for this function:

◆ doesAccessCodeInSessionExists()

ilTestSession::doesAccessCodeInSessionExists ( )

Definition at line 443 of file class.ilTestSession.php.

                                                   : bool
    {
        return is_array(ilSession::get(self::ACCESS_CODE_SESSION_INDEX)) && isset(ilSession::get(self::ACCESS_CODE_SESSION_INDEX)[$this->getTestId()]);
    }

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

Referenced by ilTestPlayerAbstractGUI\ensureExistingTestSession(), and loadTestSession().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAccessCodeFromSession()

ilTestSession::getAccessCodeFromSession ( )

Definition at line 430 of file class.ilTestSession.php.

                                              : ?string
    {
        if (!is_array(ilSession::get(self::ACCESS_CODE_SESSION_INDEX))) {
            return null;
        }
        $session_code = ilSession::get(self::ACCESS_CODE_SESSION_INDEX);
        if (!isset($session_code[$this->getTestId()])) {
            return null;
        }
 
        return $session_code[$this->getTestId()];
    }

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

Referenced by ilTestPlayerAbstractGUI\ensureExistingTestSession(), and loadTestSession().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveId()

ilTestSession::getActiveId ( )

Definition at line 271 of file class.ilTestSession.php.

                                 : int
    {
        return $this->active_id;
    }

References $active_id.

Referenced by ilTestService\buildVirtualSequence(), ilObjTest\canShowTestResults(), ilTestPlayerAbstractGUI\ensureExistingTestSession(), ilTestPlayerAbstractGUI\handleSkillTriggering(), ilObjTest\hasAnyTestResult(), hasSinglePassReportable(), increaseTestPass(), lookupTestStartLock(), persistTestStartLock(), reportableResultsAvailable(), saveToDb(), ilTestRandomQuestionSetBuilder\storeQuestion(), and ilLOTestQuestionAdapter\updateQuestionResult().

Here is the caller graph for this function:

◆ getAnonymousId()

ilTestSession::getAnonymousId ( )

Definition at line 301 of file class.ilTestSession.php.

                                    : string
    {
        return $this->anonymous_id;
    }

References $anonymous_id.

Referenced by saveToDb().

Here is the caller graph for this function:

◆ getLastFinishedPass()

ilTestSession::getLastFinishedPass ( )

Definition at line 356 of file class.ilTestSession.php.

                                         : ?int
    {
        return $this->lastFinishedPass;
    }

References $lastFinishedPass.

Referenced by ilObjTest\canShowTestResults(), ilObjTest\hasAnyTestResult(), hasSinglePassReportable(), increaseTestPass(), and saveToDb().

Here is the caller graph for this function:

◆ getLastSequence()

ilTestSession::getLastSequence ( )

Definition at line 311 of file class.ilTestSession.php.

                                     : int
    {
        return $this->lastsequence;
    }

References $lastsequence.

Referenced by ilTestSequence\hasStarted(), increaseTestPass(), and saveToDb().

Here is the caller graph for this function:

◆ getLastStartedPass()

ilTestSession::getLastStartedPass ( )

Returns: int

Definition at line 374 of file class.ilTestSession.php.

                                        : ?int
    {
        return $this->lastStartedPass;
    }

References $lastStartedPass.

Referenced by increaseTestPass().

Here is the caller graph for this function:

◆ getObjectiveOrientedContainerId()

ilTestSession::getObjectiveOrientedContainerId ( )

Definition at line 366 of file class.ilTestSession.php.

                                                     : int
    {
        return $this->objectiveOrientedContainerId ?? 0;
    }

Referenced by ilLOTestQuestionAdapter\getInstance(), increaseTestPass(), isObjectiveOriented(), ilLOTestQuestionAdapter\notifyTestStart(), and saveToDb().

Here is the caller graph for this function:

◆ getPass()

ilTestSession::getPass ( )

Definition at line 321 of file class.ilTestSession.php.

                             : int
    {
        return $this->pass;
    }

References $pass.

Referenced by ilTestPlayerAbstractGUI\handleSkillTriggering(), increaseTestPass(), saveToDb(), ilTestRandomQuestionSetBuilder\storeQuestion(), and ilLOTestQuestionAdapter\updateQuestionResult().

Here is the caller graph for this function:

◆ getRefId()

ilTestSession::getRefId ( )

Definition at line 72 of file class.ilTestSession.php.

                              : int
    {
        return $this->ref_id;
    }

References $ref_id.

Referenced by ilLOTestQuestionAdapter\getInstance(), ilLOTestQuestionAdapter\initTestRun(), ilLOTestQuestionAdapter\initUserResult(), ilLOTestQuestionAdapter\isQualifiedStartRun(), ilLOTestQuestionAdapter\notifyTestStart(), ilLOTestQuestionAdapter\updateFixedQuestions(), ilLOTestQuestionAdapter\updateQuestionResult(), ilLOTestQuestionAdapter\updateQuestions(), and ilLOTestQuestionAdapter\updateRandomQuestions().

Here is the caller graph for this function:

◆ getSubmittedTimestamp()

ilTestSession::getSubmittedTimestamp ( )

Definition at line 341 of file class.ilTestSession.php.

                                           : ?string
    {
        return $this->submittedTimestamp;
    }

References $submittedTimestamp.

Referenced by increaseTestPass(), and saveToDb().

Here is the caller graph for this function:

◆ getTestId()

ilTestSession::getTestId ( )

Definition at line 291 of file class.ilTestSession.php.

                               : int
    {
        return $this->test_id;
    }

References $test_id.

Referenced by doesAccessCodeInSessionExists(), getAccessCodeFromSession(), isAccessCodeUsed(), saveToDb(), setAccessCodeToSession(), and unsetAccessCodeInSession().

Here is the caller graph for this function:

◆ getUserId()

ilTestSession::getUserId ( )

Definition at line 281 of file class.ilTestSession.php.

                               : int
    {
        return $this->user_id;
    }

References $user_id.

Referenced by ilTestPlayerAbstractGUI\checkTestSessionUser(), ilLOTestQuestionAdapter\getInstance(), ilTestPlayerAbstractGUI\handleSkillTriggering(), isAnonymousUser(), ilLOTestQuestionAdapter\notifyTestStart(), and saveToDb().

Here is the caller graph for this function:

◆ hasSinglePassReportable()

ilTestSession::hasSinglePassReportable ( ilObjTest $testObj )

Definition at line 524 of file class.ilTestSession.php.

                                                               : bool
    {
        $test_passes_selector = new ilTestPassesSelector($this->db, $testObj);
        $test_passes_selector->setActiveId($this->getActiveId());
        $test_passes_selector->setLastFinishedPass($this->getLastFinishedPass());
 
        if (count($test_passes_selector->getReportablePasses()) == 1) {
            return true;
        }
 
        return false;
    }

References getActiveId(), and getLastFinishedPass().

Here is the call graph for this function:

◆ increasePass()

ilTestSession::increasePass ( )

Definition at line 326 of file class.ilTestSession.php.

    {
        $this->pass += 1;
    }

Referenced by increaseTestPass().

Here is the caller graph for this function:

◆ increaseTestPass()

ilTestSession::increaseTestPass ( )

Definition at line 109 of file class.ilTestSession.php.

                                      : void
    {
        if (!$this->active_id) {
            throw new ilTestException('missing active id on test pass increase!');
        }
 
        $this->increasePass();
        $this->setLastSequence(0);
        $submitted = ($this->isSubmitted()) ? 1 : 0;
        $active = ilSession::get((string) $this->active_id);
        if (!isset($active['tst_last_increase_pass']) || $active['tst_last_increase_pass'] !== null) {
            $active['tst_last_increase_pass'] = 0;
        }
 
        // there has to be at least 10 seconds between new test passes (to ensure that noone double clicks the finish button and increases the test pass by more than 1)
        if (time() - $active['tst_last_increase_pass'] > 10) {
            $active['tst_last_increase_pass'] = time();
            $this->tstamp = time();
            $submittedtimestamp = $this->getSubmittedTimestamp() !== null && $this->getSubmittedTimestamp() !== '' ? $this->getSubmittedTimestamp() : null;
            $this->db->update(
                'tst_active',
                [
                    'lastindex' => ['integer', $this->getLastSequence()],
                    'tries' => ['integer', $this->getPass()],
                    'submitted' => ['integer', $submitted],
                    'submittimestamp' => ['timestamp', $submittedtimestamp],
                    'tstamp' => ['integer', time()],
                    'last_finished_pass' => ['integer', $this->getLastFinishedPass()],
                    'last_started_pass' => ['integer', $this->getLastStartedPass()],
                    'objective_container' => ['integer', $this->getObjectiveOrientedContainerId()]
                ],
                [
                    'active_id' => ['integer', $this->getActiveId()]
                ]
            );
        }
    }

References ilSession\get(), getActiveId(), getLastFinishedPass(), getLastSequence(), getLastStartedPass(), getObjectiveOrientedContainerId(), getPass(), getSubmittedTimestamp(), increasePass(), isSubmitted(), and setLastSequence().

Here is the call graph for this function:

◆ isAccessCodeUsed()

ilTestSession::isAccessCodeUsed ( string $code )

Definition at line 457 of file class.ilTestSession.php.

                                                  : bool
    {
        $query = "SELECT anonymous_id FROM tst_active WHERE test_fi = %s AND anonymous_id = %s";
 
        $result = $this->db->queryF(
            $query,
            ['integer', 'text'],
            [$this->getTestId(), $code]
        );
 
        return ($result->numRows() > 0);
    }

References getTestId().

Referenced by createNewAccessCode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAnonymousUser()

ilTestSession::isAnonymousUser ( )

Definition at line 487 of file class.ilTestSession.php.

                                     : bool
    {
        return $this->getUserId() == ANONYMOUS_USER_ID;
    }

References ANONYMOUS_USER_ID, and getUserId().

Referenced by ilTestPlayerAbstractGUI\ensureExistingTestSession().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isObjectiveOriented()

ilTestSession::isObjectiveOriented ( )

Definition at line 384 of file class.ilTestSession.php.

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

References getObjectiveOrientedContainerId().

Here is the call graph for this function:

◆ isPasswordChecked()

ilTestSession::isPasswordChecked ( )

Definition at line 492 of file class.ilTestSession.php.

                                       : bool
    {
        if (ilSession::get('pw_checked_' . $this->active_id) === null) {
            return false;
        }
        return ilSession::get('pw_checked_' . $this->active_id);
    }

References ilSession\get().

Here is the call graph for this function:

◆ isSubmitted()

ilTestSession::isSubmitted ( )

Definition at line 331 of file class.ilTestSession.php.

                                 : bool
    {
        return $this->submitted;
    }

References $submitted.

Referenced by increaseTestPass(), and saveToDb().

Here is the caller graph for this function:

◆ loadFromDb()

ilTestSession::loadFromDb ( int $active_id )

Definition at line 246 of file class.ilTestSession.php.

                                              : void
    {
        $result = $this->db->queryF(
            "SELECT * FROM tst_active WHERE active_id = %s",
            ['integer'],
            [$active_id]
        );
        if ($result->numRows()) {
            $row = $this->db->fetchAssoc($result);
            $this->active_id = $row["active_id"];
            $this->user_id = $row["user_fi"];
            $this->anonymous_id = $row["anonymous_id"] ?? '';
            $this->test_id = $row["test_fi"];
            $this->lastsequence = $row["lastindex"];
            $this->pass = $row["tries"];
            $this->submitted = ($row["submitted"]) ? true : false;
            $this->submittedTimestamp = $row["submittimestamp"] ?? '';
            $this->tstamp = $row["tstamp"];
 
            $this->lastStartedPass = $row['last_started_pass'];
            $this->lastFinishedPass = $row['last_finished_pass'];
            $this->setObjectiveOrientedContainerId((int) $row['objective_container']);
        }
    }

References $active_id, and setObjectiveOrientedContainerId().

Here is the call graph for this function:

◆ loadTestSession()

ilTestSession::loadTestSession	(	int	$test_id,
		int	$user_id = `0`,
		?string	$anonymous_id = `null`
	)

Definition at line 196 of file class.ilTestSession.php.

                                                                                                 : void
    {
        if ($user_id === 0) {
            $user_id = $this->user->getId();
        }
        if (($this->user->getId() == ANONYMOUS_USER_ID) && $this->doesAccessCodeInSessionExists()) {
            $result = $this->db->queryF(
                "SELECT * FROM tst_active WHERE user_fi = %s AND test_fi = %s AND anonymous_id = %s",
                ['integer','integer','text'],
                [$user_id, $test_id, $this->getAccessCodeFromSession()]
            );
        } elseif ($anonymous_id !== null) {
            $result = $this->db->queryF(
                "SELECT * FROM tst_active WHERE user_fi = %s AND test_fi = %s AND anonymous_id = %s",
                ['integer','integer','text'],
                [$user_id, $test_id, $anonymous_id]
            );
        } else {
            if ($this->user->getId() == ANONYMOUS_USER_ID) {
                return;
            }
            $result = $this->db->queryF(
                "SELECT * FROM tst_active WHERE user_fi = %s AND test_fi = %s",
                ['integer','integer'],
                [$user_id, $test_id]
            );
        }
 
        // TODO bheyser: Refactor
        $this->user_id = $user_id;
 
        if ($result->numRows()) {
            $row = $this->db->fetchAssoc($result);
            $this->active_id = $row["active_id"];
            $this->user_id = $row["user_fi"];
            $this->anonymous_id = $row["anonymous_id"] ?? '';
            $this->test_id = $row["test_fi"];
            $this->lastsequence = $row["lastindex"];
            $this->pass = $row["tries"];
            $this->submitted = ($row["submitted"]) ? true : false;
            $this->submittedTimestamp = $row["submittimestamp"] ?? '';
            $this->tstamp = $row["tstamp"];
            $this->lastStartedPass = $row['last_started_pass'];
            $this->lastFinishedPass = $row['last_finished_pass'];
            $this->setObjectiveOrientedContainerId((int) $row['objective_container']);
        } elseif ($this->doesAccessCodeInSessionExists()) {
            $this->unsetAccessCodeInSession();
        }
    }

References $anonymous_id, $test_id, $user_id, ANONYMOUS_USER_ID, doesAccessCodeInSessionExists(), getAccessCodeFromSession(), setObjectiveOrientedContainerId(), unsetAccessCodeInSession(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ lookupTestStartLock()

ilTestSession::lookupTestStartLock ( )

Definition at line 398 of file class.ilTestSession.php.

                                         : ?string
    {
        $res = $this->db->queryF(
            "SELECT start_lock FROM tst_active WHERE active_id = %s",
            ['integer'],
            [$this->getActiveId()]
        );
 
        while ($row = $this->db->fetchAssoc($res)) {
            return $row['start_lock'];
        }
 
        return null;
    }

References $res, and getActiveId().

Here is the call graph for this function:

◆ persistTestStartLock()

ilTestSession::persistTestStartLock ( string $testStartLock )

Definition at line 389 of file class.ilTestSession.php.

                                                               : void
    {
        $this->db->update(
            'tst_active',
            ['start_lock' => ['text', $testStartLock]],
            ['active_id' => ['integer', $this->getActiveId()]]
        );
    }

References getActiveId().

Here is the call graph for this function:

◆ reportableResultsAvailable()

ilTestSession::reportableResultsAvailable ( ilObjTest $test_obj )

Definition at line 507 of file class.ilTestSession.php.

                                                                   : ?bool
    {
        if ($this->reportable_results_available === null) {
            $this->reportable_results_available = true;
 
            if (!$this->getActiveId()) {
                $this->reportable_results_available = false;
            }
 
            if (!$test_obj->canShowTestResults($this)) {
                $this->reportable_results_available = false;
            }
        }
 
        return $this->reportable_results_available;
    }

References $reportable_results_available, ilObjTest\canShowTestResults(), and getActiveId().

Here is the call graph for this function:

◆ saveToDb()

ilTestSession::saveToDb ( )

Definition at line 147 of file class.ilTestSession.php.

                              : void
    {
        $submitted = ($this->isSubmitted()) ? 1 : 0;
        $submittedtimestamp = $this->getSubmittedTimestamp() !== null && $this->getSubmittedTimestamp() !== '' ? $this->getSubmittedTimestamp() : null;
        if ($this->active_id > 0) {
            $this->db->update(
                'tst_active',
                [
                    'lastindex' => ['integer', $this->getLastSequence()],
                    'tries' => ['integer', $this->getPass()],
                    'submitted' => ['integer', $submitted],
                    'submittimestamp' => ['timestamp', $submittedtimestamp],
                    'tstamp' => ['integer', time() - 10],
                    'last_finished_pass' => ['integer', $this->getLastFinishedPass()],
                    'last_started_pass' => ['integer', $this->getPass()],
                    'objective_container' => ['integer', $this->getObjectiveOrientedContainerId()]
                ],
                [
                    'active_id' => ['integer', $this->getActiveId()]
                ]
            );
            return;
        }
 
        if (!$this->activeIDExists($this->getUserId(), $this->getTestId())) {
            $anonymous_id = $this->getAnonymousId() ?: null;
 
            $next_id = $this->db->nextId('tst_active');
            $this->db->insert(
                'tst_active',
                [
                    'active_id' => ['integer', $next_id],
                    'user_fi' => ['integer', $this->getUserId()],
                    'anonymous_id' => ['text', $anonymous_id],
                    'test_fi' => ['integer', $this->getTestId()],
                    'lastindex' => ['integer', $this->getLastSequence()],
                    'tries' => ['integer', $this->getPass()],
                    'submitted' => ['integer', $submitted],
                    'submittimestamp' => ['timestamp', (strlen($this->getSubmittedTimestamp())) ? $this->getSubmittedTimestamp() : null],
                    'tstamp' => ['integer', time() - 10],
                    'last_finished_pass' => ['integer', $this->getLastFinishedPass()],
                    'last_started_pass' => ['integer', $this->getPass()],
                    'objective_container' => ['integer', $this->getObjectiveOrientedContainerId()]
                ]
            );
            $this->active_id = $next_id;
        }
    }

References $submitted, activeIDExists(), getActiveId(), getAnonymousId(), getLastFinishedPass(), getLastSequence(), getObjectiveOrientedContainerId(), getPass(), getSubmittedTimestamp(), getTestId(), getUserId(), and isSubmitted().

Referenced by ilTestPlayerAbstractGUI\ensureExistingTestSession().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAccessCodeToSession()

ilTestSession::setAccessCodeToSession ( string $access_code )

Definition at line 413 of file class.ilTestSession.php.

                                                               : void
    {
        if (!is_array(ilSession::get(self::ACCESS_CODE_SESSION_INDEX))) {
            ilSession::set(self::ACCESS_CODE_SESSION_INDEX, []);
        }
        $session_code = ilSession::get(self::ACCESS_CODE_SESSION_INDEX);
        $session_code[$this->getTestId()] = $access_code;
        ilSession::set(self::ACCESS_CODE_SESSION_INDEX, $session_code);
    }

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

Here is the call graph for this function:

◆ setAnonymousId()

ilTestSession::setAnonymousId ( string $anonymous_id )

Definition at line 296 of file class.ilTestSession.php.

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

References $anonymous_id.

Referenced by ilTestPlayerAbstractGUI\ensureExistingTestSession().

Here is the caller graph for this function:

◆ setLastFinishedPass()

ilTestSession::setLastFinishedPass ( int $lastFinishedPass )

Definition at line 351 of file class.ilTestSession.php.

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

References $lastFinishedPass.

◆ setLastSequence()

ilTestSession::setLastSequence ( int $lastsequence )

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

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

References $lastsequence.

Referenced by increaseTestPass().

Here is the caller graph for this function:

◆ setLastStartedPass()

ilTestSession::setLastStartedPass ( int $lastStartedPass )

Definition at line 379 of file class.ilTestSession.php.

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

References $lastStartedPass.

◆ setObjectiveOrientedContainerId()

ilTestSession::setObjectiveOrientedContainerId ( int $objectiveOriented )

Definition at line 361 of file class.ilTestSession.php.

                                                                           : void
    {
        $this->objectiveOrientedContainerId = $objectiveOriented;
    }

Referenced by loadFromDb(), and loadTestSession().

Here is the caller graph for this function:

◆ setPass()

ilTestSession::setPass ( int $pass )

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

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

References $pass.

◆ setPasswordChecked()

ilTestSession::setPasswordChecked ( bool $value )

Definition at line 500 of file class.ilTestSession.php.

                                                   : void
    {
        ilSession::set('pw_checked_' . $this->active_id, $value);
    }

References ilSession\set().

Here is the call graph for this function:

◆ setRefId()

ilTestSession::setRefId ( int $ref_id )

Definition at line 67 of file class.ilTestSession.php.

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

References $ref_id.

◆ setSubmitted()

ilTestSession::setSubmitted ( )

Definition at line 336 of file class.ilTestSession.php.

                                  : void
    {
        $this->submitted = true;
    }

◆ setSubmittedTimestamp()

ilTestSession::setSubmittedTimestamp ( )

Definition at line 346 of file class.ilTestSession.php.

                                           : void
    {
        $this->submittedTimestamp = date('Y-m-d H:i:s');
    }

◆ setTestId()

ilTestSession::setTestId ( int $test_id )

Definition at line 286 of file class.ilTestSession.php.

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

References $test_id.

◆ setUserId()

ilTestSession::setUserId ( int $user_id )

Definition at line 276 of file class.ilTestSession.php.

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

References $user_id.

Referenced by ilTestPlayerAbstractGUI\ensureExistingTestSession().

Here is the caller graph for this function:

◆ unsetAccessCodeInSession()

ilTestSession::unsetAccessCodeInSession ( )

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

                                              : void
    {
        $session_code = ilSession::get(self::ACCESS_CODE_SESSION_INDEX);
        unset($session_code[$this->getTestId()]);
        ilSession::set(self::ACCESS_CODE_SESSION_INDEX, $session_code);
    }

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

Referenced by loadTestSession().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $active_id

int ilTestSession::$active_id = 0

Definition at line 38 of file class.ilTestSession.php.

Referenced by getActiveId(), and loadFromDb().

◆ $anonymous_id

string ilTestSession::$anonymous_id = ''

Definition at line 40 of file class.ilTestSession.php.

Referenced by getAnonymousId(), loadTestSession(), and setAnonymousId().

◆ $lastFinishedPass

int ilTestSession::$lastFinishedPass = null

private

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

Referenced by getLastFinishedPass(), and setLastFinishedPass().

◆ $lastPresentationMode

string ilTestSession::$lastPresentationMode = null

protected

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

◆ $lastsequence

int ilTestSession::$lastsequence = 0

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

Referenced by getLastSequence(), and setLastSequence().

◆ $lastStartedPass

int ilTestSession::$lastStartedPass = null

private

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

Referenced by getLastStartedPass(), and setLastStartedPass().

◆ $objectiveOrientedContainerId

int ilTestSession::$objectiveOrientedContainerId = null

private

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

◆ $pass

int ilTestSession::$pass = 0

private

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

Referenced by getPass(), and setPass().

◆ $ref_id

int ilTestSession::$ref_id = 0

private

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

Referenced by getRefId(), and setRefId().

◆ $reportable_results_available

bool ilTestSession::$reportable_results_available = null

private

Definition at line 505 of file class.ilTestSession.php.

Referenced by reportableResultsAvailable().

◆ $submitted

bool ilTestSession::$submitted = false

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

Referenced by isSubmitted(), and saveToDb().

◆ $submittedTimestamp

string ilTestSession::$submittedTimestamp = ''

Definition at line 46 of file class.ilTestSession.php.

Referenced by getSubmittedTimestamp().

◆ $test_id

int ilTestSession::$test_id = 0

Definition at line 41 of file class.ilTestSession.php.

Referenced by activeIDExists(), getTestId(), loadTestSession(), and setTestId().

◆ $tstamp

int ilTestSession::$tstamp = 0

Definition at line 45 of file class.ilTestSession.php.

◆ $user_id

int ilTestSession::$user_id = 0

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

Referenced by activeIDExists(), getUserId(), loadTestSession(), and setUserId().

◆ ACCESS_CODE_CHAR_DOMAIN

const ilTestSession::ACCESS_CODE_CHAR_DOMAIN = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"

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

Referenced by buildAccessCode().

◆ ACCESS_CODE_LENGTH

const ilTestSession::ACCESS_CODE_LENGTH = 5

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

Referenced by buildAccessCode().

◆ ACCESS_CODE_SESSION_INDEX

const ilTestSession::ACCESS_CODE_SESSION_INDEX = "tst_access_code"

Definition at line 32 of file class.ilTestSession.php.

Referenced by ILIAS\Test\Access\AccessFileUploadAnswer\accessCodeOk(), ILIAS\Test\Access\test\AccessFileUploadAnswerTest\testAnonymousWithInvalidAccessCode(), ILIAS\Test\Access\test\AccessFileUploadAnswerTest\testAnonymousWithoutAccessCode(), ILIAS\Test\Access\test\AccessFileUploadAnswerTest\testAnonymousWithValidAccessCode(), ilTestSessionTest\testSetAccessCodeToSession(), ilTestSessionTest\testUnsetAccessCodeInSession(), and ILIAS\Test\Access\test\AccessFileUploadAnswerTest\testUserWhichCanAccessTheTestResults().

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

components/ILIAS/Test/classes/class.ilTestSession.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

◆ activeIDExists()

◆ buildAccessCode()

◆ createNewAccessCode()

◆ doesAccessCodeInSessionExists()

◆ getAccessCodeFromSession()

◆ getActiveId()

◆ getAnonymousId()

◆ getLastFinishedPass()

◆ getLastSequence()

◆ getLastStartedPass()

◆ getObjectiveOrientedContainerId()

◆ getPass()

◆ getRefId()

◆ getSubmittedTimestamp()

◆ getTestId()

◆ getUserId()

◆ hasSinglePassReportable()

◆ increasePass()

◆ increaseTestPass()

◆ isAccessCodeUsed()

◆ isAnonymousUser()

◆ isObjectiveOriented()

◆ isPasswordChecked()

◆ isSubmitted()

◆ loadFromDb()

◆ loadTestSession()

◆ lookupTestStartLock()

◆ persistTestStartLock()

◆ reportableResultsAvailable()

◆ saveToDb()

◆ setAccessCodeToSession()

◆ setAnonymousId()

◆ setLastFinishedPass()

◆ setLastSequence()

◆ setLastStartedPass()

◆ setObjectiveOrientedContainerId()

◆ setPass()

◆ setPasswordChecked()

◆ setRefId()

◆ setSubmitted()

◆ setSubmittedTimestamp()

◆ setTestId()

◆ setUserId()

◆ unsetAccessCodeInSession()

Field Documentation

◆ $active_id

◆ $anonymous_id

◆ $lastFinishedPass

◆ $lastPresentationMode

◆ $lastsequence

◆ $lastStartedPass

◆ $objectiveOrientedContainerId

◆ $pass

◆ $ref_id

◆ $reportable_results_available

◆ $submitted

◆ $submittedTimestamp

◆ $test_id

◆ $tstamp

◆ $user_id

◆ ACCESS_CODE_CHAR_DOMAIN

◆ ACCESS_CODE_LENGTH

◆ ACCESS_CODE_SESSION_INDEX