Stores access codes of anonymous session. More...

Collaboration diagram for ILIAS\Survey\Execution\RunSessionRepo:

Public Member Functions
	__construct ()

	issetCode (int $survey_id)

	setCode (int $survey_id, string $code)

	getCode (int $survey_id)

	clearCode (int $survey_id)

	isExternalRaterValidated (int $ref_id)

	setExternalRaterValidation (int $ref_id, bool $valid)

	setPageEnter (int $time)

	getPageEnter ()

	clearPageEnter ()

	setPreviewData (int $survey_id, int $question_id, array $data)

	getPreviewData (int $survey_id, int $question_id)

	clearPreviewData (int $survey_id, int $question_id)

	clearAllPreviewData (int $survey_id)

	setErrors (array $errors)

	getErrors ()

	clearErrors ()

	setPostData (array $data)

	getPostData ()

	clearPostData ()

Protected Member Functions
	getAnonymKey (int $survey_id)

	getPreviewDataKey (int $survey_id)

	getAllPreviewData (int $survey_id)

Protected Attributes
const	KEY_BASE = "svy_run_"

const	KEY_ANONYM = self::KEY_BASE . "anonymous_id_"

const	KEY_EXTRT = self::KEY_BASE . "extrt_"

const	KEY_PAGE_ENTER = self::KEY_BASE . "enter_page"

const	KEY_PREVIEW_DATA = self::KEY_BASE . "preview_data"

const	KEY_ERRORS = self::KEY_BASE . "errors"

const	KEY_POST_DATA = self::KEY_BASE . "post_data"

Detailed Description

Stores access codes of anonymous session.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 27 of file class.RunSessionRepo.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Survey\Execution\RunSessionRepo::__construct ( )

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

38 {

39 }

Member Function Documentation

◆ clearAllPreviewData()

ILIAS\Survey\Execution\RunSessionRepo::clearAllPreviewData ( int $survey_id )

Definition at line 139 of file class.RunSessionRepo.php.

                                                       : void
    {
        \ilSession::clear($this->getPreviewDataKey($survey_id));
    }

References ilSession\clear(), and ILIAS\Survey\Execution\RunSessionRepo\getPreviewDataKey().

Here is the call graph for this function:

◆ clearCode()

ILIAS\Survey\Execution\RunSessionRepo::clearCode ( int $survey_id )

Definition at line 68 of file class.RunSessionRepo.php.

                                             : void
    {
        \ilSession::clear($this->getAnonymKey($survey_id));
    }

References ilSession\clear(), and ILIAS\Survey\Execution\RunSessionRepo\getAnonymKey().

Here is the call graph for this function:

◆ clearErrors()

ILIAS\Survey\Execution\RunSessionRepo::clearErrors ( )

Definition at line 154 of file class.RunSessionRepo.php.

                                 : void
    {
        \ilSession::clear(self::KEY_ERRORS);
    }

References ilSession\clear().

Here is the call graph for this function:

◆ clearPageEnter()

ILIAS\Survey\Execution\RunSessionRepo::clearPageEnter ( )

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

                                    : void
    {
        \ilSession::clear(self::KEY_PAGE_ENTER);
    }

References ilSession\clear().

Here is the call graph for this function:

◆ clearPostData()

ILIAS\Survey\Execution\RunSessionRepo::clearPostData ( )

Definition at line 169 of file class.RunSessionRepo.php.

                                   : void
    {
        \ilSession::clear(self::KEY_POST_DATA);
    }

References ilSession\clear().

Here is the call graph for this function:

◆ clearPreviewData()

ILIAS\Survey\Execution\RunSessionRepo::clearPreviewData	(	int	$survey_id,
		int	$question_id
	)

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

                                                                      : void
    {
        if (\ilSession::has($this->getPreviewDataKey($survey_id))) {
            $data = \ilSession::get($this->getPreviewDataKey($survey_id));
            unset($data[$question_id]);
            \ilSession::set($this->getPreviewDataKey($survey_id), $data);
        }
    }

References $data, ilSession\get(), ILIAS\Survey\Execution\RunSessionRepo\getPreviewDataKey(), ilSession\has(), and ilSession\set().

Here is the call graph for this function:

◆ getAllPreviewData()

ILIAS\Survey\Execution\RunSessionRepo::getAllPreviewData ( int $survey_id )

protected

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

                                                        : array
    {
        if (\ilSession::has($this->getPreviewDataKey($survey_id))) {
            return \ilSession::get($this->getPreviewDataKey($survey_id));
        }
        return [];
    }

References ILIAS\GlobalScreen\get(), ILIAS\Survey\Execution\RunSessionRepo\getPreviewDataKey(), and ilSession\has().

Referenced by ILIAS\Survey\Execution\RunSessionRepo\setPreviewData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAnonymKey()

ILIAS\Survey\Execution\RunSessionRepo::getAnonymKey ( int $survey_id )

protected

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

                                                   : string
    {
        return self::KEY_ANONYM . $survey_id;
    }

Referenced by ILIAS\Survey\Execution\RunSessionRepo\clearCode(), ILIAS\Survey\Execution\RunSessionRepo\getCode(), ILIAS\Survey\Execution\RunSessionRepo\issetCode(), and ILIAS\Survey\Execution\RunSessionRepo\setCode().

Here is the caller graph for this function:

◆ getCode()

ILIAS\Survey\Execution\RunSessionRepo::getCode ( int $survey_id )

Definition at line 60 of file class.RunSessionRepo.php.

                                           : string
    {
        if (\ilSession::has($this->getAnonymKey($survey_id))) {
            return \ilSession::get($this->getAnonymKey($survey_id));
        }
        return "";
    }

References ILIAS\GlobalScreen\get(), ILIAS\Survey\Execution\RunSessionRepo\getAnonymKey(), and ilSession\has().

Here is the call graph for this function:

◆ getErrors()

ILIAS\Survey\Execution\RunSessionRepo::getErrors ( )

Definition at line 149 of file class.RunSessionRepo.php.

                               : array
    {
        return \ilSession::get(self::KEY_ERRORS) ?? [];
    }

References ILIAS\GlobalScreen\get().

Here is the call graph for this function:

◆ getPageEnter()

ILIAS\Survey\Execution\RunSessionRepo::getPageEnter ( )

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

                                  : int
    {
        return \ilSession::get(self::KEY_PAGE_ENTER) ?? 0;
    }

References ILIAS\GlobalScreen\get().

Here is the call graph for this function:

◆ getPostData()

ILIAS\Survey\Execution\RunSessionRepo::getPostData ( )

Definition at line 164 of file class.RunSessionRepo.php.

                                 : array
    {
        return \ilSession::get(self::KEY_POST_DATA);
    }

References ILIAS\GlobalScreen\get().

Here is the call graph for this function:

◆ getPreviewData()

ILIAS\Survey\Execution\RunSessionRepo::getPreviewData	(	int	$survey_id,
		int	$question_id
	)

Definition at line 121 of file class.RunSessionRepo.php.

                                                                    : array
    {
        if (\ilSession::has($this->getPreviewDataKey($survey_id))) {
            $data = \ilSession::get($this->getPreviewDataKey($survey_id));
            return $data[$question_id] ?? [];
        }
        return [];
    }

References $data, ilSession\get(), ILIAS\Survey\Execution\RunSessionRepo\getPreviewDataKey(), and ilSession\has().

Here is the call graph for this function:

◆ getPreviewDataKey()

ILIAS\Survey\Execution\RunSessionRepo::getPreviewDataKey ( int $survey_id )

protected

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

                                                        : string
    {
        return self::KEY_PREVIEW_DATA . "_" . $survey_id;
    }

Referenced by ILIAS\Survey\Execution\RunSessionRepo\clearAllPreviewData(), ILIAS\Survey\Execution\RunSessionRepo\clearPreviewData(), ILIAS\Survey\Execution\RunSessionRepo\getAllPreviewData(), ILIAS\Survey\Execution\RunSessionRepo\getPreviewData(), and ILIAS\Survey\Execution\RunSessionRepo\setPreviewData().

Here is the caller graph for this function:

◆ isExternalRaterValidated()

ILIAS\Survey\Execution\RunSessionRepo::isExternalRaterValidated ( int $ref_id )

Definition at line 73 of file class.RunSessionRepo.php.

                                                         : bool
    {
        if (\ilSession::has(self::KEY_EXTRT . $ref_id)) {
            return (bool) \ilSession::get(self::KEY_EXTRT . $ref_id);
        }
        return false;
    }

References $ref_id, ilSession\get(), and ilSession\has().

Here is the call graph for this function:

◆ issetCode()

ILIAS\Survey\Execution\RunSessionRepo::issetCode ( int $survey_id )

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

                                             : bool
    {
        return (
            \ilSession::has($this->getAnonymKey($survey_id)) &&
            is_string(\ilSession::get($this->getAnonymKey($survey_id))) &&
            \ilSession::get($this->getAnonymKey($survey_id)) !== ""
        );
    }

References ilSession\get(), ILIAS\Survey\Execution\RunSessionRepo\getAnonymKey(), and ilSession\has().

Here is the call graph for this function:

◆ setCode()

ILIAS\Survey\Execution\RunSessionRepo::setCode	(	int	$survey_id,
		string	$code
	)

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

                                                         : void
    {
        \ilSession::set($this->getAnonymKey($survey_id), $code);
    }

References ILIAS\Survey\Execution\RunSessionRepo\getAnonymKey(), and ilSession\set().

Referenced by ILIAS\Survey\Execution\RunManager\initSession().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setErrors()

ILIAS\Survey\Execution\RunSessionRepo::setErrors ( array $errors )

Definition at line 144 of file class.RunSessionRepo.php.

                                            : void
    {
        \ilSession::set(self::KEY_ERRORS, $errors);
    }

References ilSession\set().

Here is the call graph for this function:

◆ setExternalRaterValidation()

ILIAS\Survey\Execution\RunSessionRepo::setExternalRaterValidation	(	int	$ref_id,
		bool	$valid
	)

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

                                                                        : void
    {
        \ilSession::set(self::KEY_EXTRT . $ref_id, $valid);
    }

References $ref_id, $valid, and ilSession\set().

Here is the call graph for this function:

◆ setPageEnter()

ILIAS\Survey\Execution\RunSessionRepo::setPageEnter ( int $time )

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

                                           : void
    {
        \ilSession::set(self::KEY_PAGE_ENTER, $time);
    }

References ilSession\set().

Here is the call graph for this function:

◆ setPostData()

ILIAS\Survey\Execution\RunSessionRepo::setPostData ( array $data )

Definition at line 159 of file class.RunSessionRepo.php.

                                            : void
    {
        \ilSession::set(self::KEY_POST_DATA, $data);
    }

References $data, and ilSession\set().

Here is the call graph for this function:

◆ setPreviewData()

ILIAS\Survey\Execution\RunSessionRepo::setPreviewData	(	int	$survey_id,
		int	$question_id,
		array	$data
	)

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

                                                                                 : void
    {
        $all_data = $this->getAllPreviewData($survey_id);
        $all_data[$question_id] = $data;
        \ilSession::set($this->getPreviewDataKey($survey_id), $all_data);
    }

References $data, ILIAS\Survey\Execution\RunSessionRepo\getAllPreviewData(), ILIAS\Survey\Execution\RunSessionRepo\getPreviewDataKey(), and ilSession\set().

Here is the call graph for this function:

Field Documentation

◆ KEY_ANONYM

const ILIAS\Survey\Execution\RunSessionRepo::KEY_ANONYM = self::KEY_BASE . "anonymous_id_"

protected

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

◆ KEY_BASE

const ILIAS\Survey\Execution\RunSessionRepo::KEY_BASE = "svy_run_"

protected

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

◆ KEY_ERRORS

const ILIAS\Survey\Execution\RunSessionRepo::KEY_ERRORS = self::KEY_BASE . "errors"

protected

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

◆ KEY_EXTRT

const ILIAS\Survey\Execution\RunSessionRepo::KEY_EXTRT = self::KEY_BASE . "extrt_"

protected

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

◆ KEY_PAGE_ENTER

const ILIAS\Survey\Execution\RunSessionRepo::KEY_PAGE_ENTER = self::KEY_BASE . "enter_page"

protected

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

◆ KEY_POST_DATA

const ILIAS\Survey\Execution\RunSessionRepo::KEY_POST_DATA = self::KEY_BASE . "post_data"

protected

Definition at line 35 of file class.RunSessionRepo.php.

◆ KEY_PREVIEW_DATA

const ILIAS\Survey\Execution\RunSessionRepo::KEY_PREVIEW_DATA = self::KEY_BASE . "preview_data"

protected

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

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

components/ILIAS/Survey/Execution/class.RunSessionRepo.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearAllPreviewData()

◆ clearCode()

◆ clearErrors()

◆ clearPageEnter()

◆ clearPostData()

◆ clearPreviewData()

◆ getAllPreviewData()

◆ getAnonymKey()

◆ getCode()

◆ getErrors()

◆ getPageEnter()

◆ getPostData()

◆ getPreviewData()

◆ getPreviewDataKey()

◆ isExternalRaterValidated()

◆ issetCode()

◆ setCode()

◆ setErrors()

◆ setExternalRaterValidation()

◆ setPageEnter()

◆ setPostData()

◆ setPreviewData()

Field Documentation

◆ KEY_ANONYM

◆ KEY_BASE

◆ KEY_ERRORS

◆ KEY_EXTRT

◆ KEY_PAGE_ENTER

◆ KEY_POST_DATA

◆ KEY_PREVIEW_DATA