ILIAS\Survey\Editing\EditSessionRepo Class Reference

Stores access codes of anonymous session. More...

Collaboration diagram for ILIAS\Survey\Editing\EditSessionRepo:

Public Member Functions
	__construct ()
	setConstraintStructure (?array $structure)
	getConstraintStructure ()
	clearConstraintStructure ()
	setConstraintElements (?array $elements)
	getConstraintElements ()
	clearConstraintElements ()
	setMoveSurveyQuestions (int $survey_id, array $question_ids)
	clearMoveSurveyQuestions ()
	getMoveSurveyQuestions ()
	getMoveSurveyId ()
	setQuestionClipboard (int $ref_id, int $page, string $mode, array $question_ids)
	clearQuestionClipboard ($ref_id)
	getQuestionClipboardSourcePage (int $ref_id)
	getQuestionClipboardMode (int $ref_id)
	getQuestionClipboardQuestions (int $ref_id)
	isQuestionClipboardEmpty (int $ref_id)
	setPoolChoice (int $id)
	getPoolChoice ()
	setExternalText (string $text)
	getExternalText ()

Protected Member Functions
	getClipKey (int $ref_id)

Protected Attributes
const	KEY_BASE = "svy_edit_"
const	KEY_CONSTRAINT_STRUCTURE = self::KEY_BASE . "constraints"
const	KEY_CONSTRAINT_ELEMENTS = self::KEY_BASE . "elements"
const	KEY_EXT_TEXT = self::KEY_BASE . "ext_text"

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.EditSessionRepo.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Survey\Editing\EditSessionRepo::__construct

(

)

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

    {
    }

Member Function Documentation

clearConstraintElements()

ILIAS\Survey\Editing\EditSessionRepo::clearConstraintElements

(

)

Definition at line 63 of file class.EditSessionRepo.php.

References ilSession\clear().

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

Here is the call graph for this function:

clearConstraintStructure()

ILIAS\Survey\Editing\EditSessionRepo::clearConstraintStructure

(

)

Definition at line 48 of file class.EditSessionRepo.php.

References ilSession\clear().

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

Here is the call graph for this function:

clearMoveSurveyQuestions()

ILIAS\Survey\Editing\EditSessionRepo::clearMoveSurveyQuestions

(

)

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

References ilSession\clear().

                                              : void
    {
        \ilSession::clear(self::KEY_BASE . "move_svy_id");
        \ilSession::clear(self::KEY_BASE . "move_svy_qids");
    }

Here is the call graph for this function:

clearQuestionClipboard()

ILIAS\Survey\Editing\EditSessionRepo::clearQuestionClipboard

(

$ref_id

)

Definition at line 117 of file class.EditSessionRepo.php.

References $ref_id, ilSession\clear(), and ILIAS\Survey\Editing\EditSessionRepo\getClipKey().

                                                   : void
    {
        \ilSession::clear($this->getClipKey($ref_id));
    }

Here is the call graph for this function:

getClipKey()

ILIAS\Survey\Editing\EditSessionRepo::getClipKey ( int  $ref_id )

protected

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

References $ref_id.

Referenced by ILIAS\Survey\Editing\EditSessionRepo\clearQuestionClipboard(), ILIAS\Survey\Editing\EditSessionRepo\getQuestionClipboardMode(), ILIAS\Survey\Editing\EditSessionRepo\getQuestionClipboardQuestions(), ILIAS\Survey\Editing\EditSessionRepo\getQuestionClipboardSourcePage(), ILIAS\Survey\Editing\EditSessionRepo\isQuestionClipboardEmpty(), and ILIAS\Survey\Editing\EditSessionRepo\setQuestionClipboard().

                                              : string
    {
        return self::KEY_BASE . "q_clip_" . $ref_id;
    }

Here is the caller graph for this function:

getConstraintElements()

ILIAS\Survey\Editing\EditSessionRepo::getConstraintElements

(

)

Definition at line 58 of file class.EditSessionRepo.php.

References ILIAS\GlobalScreen\get().

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

Here is the call graph for this function:

getConstraintStructure()

ILIAS\Survey\Editing\EditSessionRepo::getConstraintStructure

(

)

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

References ILIAS\GlobalScreen\get().

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

Here is the call graph for this function:

getExternalText()

ILIAS\Survey\Editing\EditSessionRepo::getExternalText

(

)

Definition at line 175 of file class.EditSessionRepo.php.

References ilSession\get().

                                     : string
    {
        return (string) \ilSession::get(self::KEY_EXT_TEXT);
    }

Here is the call graph for this function:

getMoveSurveyId()

ILIAS\Survey\Editing\EditSessionRepo::getMoveSurveyId

(

)

Definition at line 88 of file class.EditSessionRepo.php.

References ILIAS\GlobalScreen\get(), and ilSession\has().

                                     : int
    {
        if (\ilSession::has(self::KEY_BASE . "move_svy_id")) {
            return \ilSession::get(self::KEY_BASE . "move_svy_id");
        }
        return 0;
    }

Here is the call graph for this function:

getMoveSurveyQuestions()

ILIAS\Survey\Editing\EditSessionRepo::getMoveSurveyQuestions

(

)

Definition at line 80 of file class.EditSessionRepo.php.

References ILIAS\GlobalScreen\get(), and ilSession\has().

                                            : array
    {
        if (\ilSession::has(self::KEY_BASE . "move_svy_qids")) {
            return \ilSession::get(self::KEY_BASE . "move_svy_qids");
        }
        return [];
    }

Here is the call graph for this function:

getPoolChoice()

ILIAS\Survey\Editing\EditSessionRepo::getPoolChoice

(

)

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

References ILIAS\GlobalScreen\get(), and ilSession\has().

                                   : int
    {
        if (\ilSession::has(self::KEY_BASE . "pool_choice")) {
            return \ilSession::get(self::KEY_BASE . "pool_choice");
        }
        return 0;
    }

Here is the call graph for this function:

getQuestionClipboardMode()

ILIAS\Survey\Editing\EditSessionRepo::getQuestionClipboardMode

(

int

$ref_id

)

Definition at line 131 of file class.EditSessionRepo.php.

References $data, ilSession\get(), ILIAS\Survey\Editing\EditSessionRepo\getClipKey(), and ilSession\has().

                                                         : string
    {
        if (\ilSession::has($this->getClipKey($ref_id))) {
            $data = \ilSession::get($this->getClipKey($ref_id));
            return $data["mode"];
        }
        return "";
    }

Here is the call graph for this function:

getQuestionClipboardQuestions()

ILIAS\Survey\Editing\EditSessionRepo::getQuestionClipboardQuestions

(

int

$ref_id

)

Definition at line 140 of file class.EditSessionRepo.php.

References $data, ilSession\get(), ILIAS\Survey\Editing\EditSessionRepo\getClipKey(), and ilSession\has().

                                                              : array
    {
        if (\ilSession::has($this->getClipKey($ref_id))) {
            $data = \ilSession::get($this->getClipKey($ref_id));
            return $data["question_ids"];
        }
        return [];
    }

Here is the call graph for this function:

getQuestionClipboardSourcePage()

ILIAS\Survey\Editing\EditSessionRepo::getQuestionClipboardSourcePage

(

int

$ref_id

)

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

References $data, ilSession\get(), ILIAS\Survey\Editing\EditSessionRepo\getClipKey(), ilSession\has(), and null.

                                                               : ?int
    {
        if (\ilSession::has($this->getClipKey($ref_id))) {
            $data = \ilSession::get($this->getClipKey($ref_id));
            return $data["source_page"];
        }
        return null;
    }

Here is the call graph for this function:

isQuestionClipboardEmpty()

ILIAS\Survey\Editing\EditSessionRepo::isQuestionClipboardEmpty

(

int

$ref_id

)

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

References ILIAS\Survey\Editing\EditSessionRepo\getClipKey(), and ilSession\has().

                                                         : bool
    {
        if (\ilSession::has($this->getClipKey($ref_id))) {
            return false;
        }
        return true;
    }

Here is the call graph for this function:

setConstraintElements()

ILIAS\Survey\Editing\EditSessionRepo::setConstraintElements

(

?array

$elements

)

Definition at line 53 of file class.EditSessionRepo.php.

References ilSession\set().

                                                           : void
    {
        \ilSession::set(self::KEY_CONSTRAINT_ELEMENTS, $elements);
    }

Here is the call graph for this function:

setConstraintStructure()

ILIAS\Survey\Editing\EditSessionRepo::setConstraintStructure

(

?array

$structure

)

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

References ilSession\set().

                                                             : void
    {
        \ilSession::set(self::KEY_CONSTRAINT_STRUCTURE, $structure);
    }

Here is the call graph for this function:

setExternalText()

ILIAS\Survey\Editing\EditSessionRepo::setExternalText

(

string

$text

)

Definition at line 170 of file class.EditSessionRepo.php.

References ilSession\set().

                                                 : void
    {
        \ilSession::set(self::KEY_EXT_TEXT, $text);
    }

Here is the call graph for this function:

setMoveSurveyQuestions()

ILIAS\Survey\Editing\EditSessionRepo::setMoveSurveyQuestions	(	int	$survey_id,
		array	$question_ids
	)

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

References ilSession\set().

                                                                               : void
    {
        \ilSession::set(self::KEY_BASE . "move_svy_id", $survey_id);
        \ilSession::set(self::KEY_BASE . "move_svy_qids", $question_ids);
    }

Here is the call graph for this function:

setPoolChoice()

ILIAS\Survey\Editing\EditSessionRepo::setPoolChoice

(

int

$id

)

Definition at line 157 of file class.EditSessionRepo.php.

References ilSession\set().

                                          : void
    {
        \ilSession::set(self::KEY_BASE . "pool_choice", $id);
    }

Here is the call graph for this function:

setQuestionClipboard()

ILIAS\Survey\Editing\EditSessionRepo::setQuestionClipboard	(	int	$ref_id,
		int	$page,
		string	$mode,
		array	$question_ids
	)

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

References ILIAS\Survey\Editing\EditSessionRepo\getClipKey(), and ilSession\set().

     : void {
        \ilSession::set(
            $this->getClipKey($ref_id),
            [
                "source_page" => $page,
                "mode" => $mode,
                "question_ids" => $question_ids
            ]
        );
    }

Here is the call graph for this function:

Field Documentation

KEY_BASE

const ILIAS\Survey\Editing\EditSessionRepo::KEY_BASE = "svy_edit_"

protected

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

KEY_CONSTRAINT_ELEMENTS

const ILIAS\Survey\Editing\EditSessionRepo::KEY_CONSTRAINT_ELEMENTS = self::KEY_BASE . "elements"

protected

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

KEY_CONSTRAINT_STRUCTURE

const ILIAS\Survey\Editing\EditSessionRepo::KEY_CONSTRAINT_STRUCTURE = self::KEY_BASE . "constraints"

protected

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

KEY_EXT_TEXT

const ILIAS\Survey\Editing\EditSessionRepo::KEY_EXT_TEXT = self::KEY_BASE . "ext_text"

protected

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

---

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

• components/ILIAS/Survey/Editing/class.EditSessionRepo.php