ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality Class Reference

Inheritance diagram for ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality:

Collaboration diagram for ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality:

Public Member Functions
	__construct (int $test_id, protected bool $use_previous_answers_allowed=false, protected bool $suspend_test_allowed=false, protected bool $postponed_questions_move_to_end=false, protected int $usrpass_overview_mode=0, protected bool $question_marking_enabled=false, protected bool $question_list_enabled=false)
	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, ?array $environment=null)
	toStorage ()
	toLog (AdditionalInformationGenerator $additional_info)
	getUsePreviousAnswerAllowed ()
	withUsePreviousAnswerAllowed (bool $use_previous_answers_allowed)
	getSuspendTestAllowed ()
	withSuspendTestAllowed (bool $suspend_test_allowed)
	getPostponedQuestionsMoveToEnd ()
	withPostponedQuestionsMoveToEnd (bool $postponed_questions_move_to_end)
	getQuestionListEnabled ()
	withQuestionListEnabled (bool $question_list_enabled)
	getUsrPassOverviewMode ()
	withUsrPassOverviewMode (int $usrpass_overview_mode)
	getUsrPassOverviewEnabled ()
	getShownQuestionListAtBeginning ()
	getShownQuestionListAtEnd ()
	getShowDescriptionInQuestionList ()
	getQuestionMarkingEnabled ()
	withQuestionMarkingEnabled (bool $question_marking_enabled)
Public Member Functions inherited from ILIAS\Test\Settings\TestSettings
	__construct (int $test_id)
	getTestId ()
	withTestId (int $test_id)
	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, ?array $environment=null)
	toStorage ()
	toLog (AdditionalInformationGenerator $additional_info)

Private Member Functions
	getInputUsrPassOverview (\ilLanguage $lng, FieldFactory $f, Refinery $refinery)

Additional Inherited Members
Protected Attributes inherited from ILIAS\Test\Settings\TestSettings
int	$test_id

Detailed Description

Definition at line 31 of file SettingsParticipantFunctionality.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::__construct	(	int	$test_id,
		protected bool	$use_previous_answers_allowed = false,
		protected bool	$suspend_test_allowed = false,
		protected bool	$postponed_questions_move_to_end = false,
		protected int	$usrpass_overview_mode = 0,
		protected bool	$question_marking_enabled = false,
		protected bool	$question_list_enabled = false
	)

Definition at line 33 of file SettingsParticipantFunctionality.php.

References ILIAS\GlobalScreen\Provider\__construct().

      {
        parent::__construct($test_id);
    }

Here is the call graph for this function:

Member Function Documentation

getInputUsrPassOverview()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::getInputUsrPassOverview ( \ilLanguage  $lng, FieldFactory  $f, Refinery  $refinery  )

private

Definition at line 89 of file SettingsParticipantFunctionality.php.

References ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getShowDescriptionInQuestionList(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getShownQuestionListAtBeginning(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getShownQuestionListAtEnd(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getUsrPassOverviewEnabled(), null, ilLanguage\txt(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toForm().

     : OptionalGroup {
        $trafo = $refinery->custom()->transformation(
            static function (?array $vs): int {
                if ($vs === null) {
                    return 0;
                }

                $usrpass_overview_mode = 1;

                if ($vs['show_at_beginning'] === true) {
                    $usrpass_overview_mode += 2;
                }

                if ($vs['show_at_end'] === true) {
                    $usrpass_overview_mode += 4;
                }

                if ($vs['show_description'] === true) {
                    $usrpass_overview_mode += 8;
                }

                return $usrpass_overview_mode;
            }
        );

        $sub_inputs_usrpass_questionlist['show_at_beginning'] = $f->checkbox($lng->txt('tst_list_of_questions_start'));
        $sub_inputs_usrpass_questionlist['show_at_end'] = $f->checkbox($lng->txt('tst_list_of_questions_end'));
        $sub_inputs_usrpass_questionlist['show_description'] = $f->checkbox($lng->txt('tst_list_of_questions_with_description'));

        $enable_usrpass_questionlist = $f->optionalGroup(
            $sub_inputs_usrpass_questionlist,
            $lng->txt('tst_show_summary'),
            $lng->txt('tst_show_summary_description')
        )->withValue(null)
            ->withAdditionalTransformation($trafo);

        if ($this->getUsrPassOverviewEnabled() === false) {
            return $enable_usrpass_questionlist;
        }

        return $enable_usrpass_questionlist->withValue(
            [
                'show_at_beginning' => $this->getShownQuestionListAtBeginning(),
                'show_at_end' => $this->getShownQuestionListAtEnd(),
                'show_description' => $this->getShowDescriptionInQuestionList()
            ]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPostponedQuestionsMoveToEnd()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::getPostponedQuestionsMoveToEnd

(

)

Definition at line 205 of file SettingsParticipantFunctionality.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toForm(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toLog(), and ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toStorage().

                                                    : bool
    {
        return $this->postponed_questions_move_to_end;
    }

Here is the caller graph for this function:

getQuestionListEnabled()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::getQuestionListEnabled

(

)

Definition at line 216 of file SettingsParticipantFunctionality.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toForm(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toLog(), and ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toStorage().

                                            : bool
    {
        return $this->question_list_enabled;
    }

Here is the caller graph for this function:

getQuestionMarkingEnabled()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::getQuestionMarkingEnabled

(

)

Definition at line 257 of file SettingsParticipantFunctionality.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toForm(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toLog(), and ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toStorage().

                                               : bool
    {
        return $this->question_marking_enabled;
    }

Here is the caller graph for this function:

getShowDescriptionInQuestionList()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::getShowDescriptionInQuestionList

(

)

Definition at line 252 of file SettingsParticipantFunctionality.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getInputUsrPassOverview(), and ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toLog().

                                                      : bool
    {
        return ($this->usrpass_overview_mode & 8) > 0;
    }

Here is the caller graph for this function:

getShownQuestionListAtBeginning()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::getShownQuestionListAtBeginning

(

)

Definition at line 243 of file SettingsParticipantFunctionality.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getInputUsrPassOverview(), and ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toLog().

                                                     : bool
    {
        return ($this->usrpass_overview_mode & 2) > 0;
    }

Here is the caller graph for this function:

getShownQuestionListAtEnd()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::getShownQuestionListAtEnd

(

)

Definition at line 247 of file SettingsParticipantFunctionality.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getInputUsrPassOverview(), and ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toLog().

                                               : bool
    {
        return ($this->usrpass_overview_mode & 4) > 0;
    }

Here is the caller graph for this function:

getSuspendTestAllowed()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::getSuspendTestAllowed

(

)

Definition at line 194 of file SettingsParticipantFunctionality.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toForm(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toLog(), and ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toStorage().

                                           : bool
    {
        return $this->suspend_test_allowed;
    }

Here is the caller graph for this function:

getUsePreviousAnswerAllowed()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::getUsePreviousAnswerAllowed

(

)

Definition at line 183 of file SettingsParticipantFunctionality.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toForm(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toLog(), and ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toStorage().

                                                 : bool
    {
        return $this->use_previous_answers_allowed;
    }

Here is the caller graph for this function:

getUsrPassOverviewEnabled()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::getUsrPassOverviewEnabled

(

)

Definition at line 239 of file SettingsParticipantFunctionality.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getInputUsrPassOverview(), and ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toLog().

                                               : bool
    {
        return ($this->usrpass_overview_mode & 1) > 0;
    }

Here is the caller graph for this function:

getUsrPassOverviewMode()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::getUsrPassOverviewMode

(

)

Definition at line 227 of file SettingsParticipantFunctionality.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\toStorage().

                                            : int
    {
        return $this->usrpass_overview_mode;
    }

Here is the caller graph for this function:

toForm()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::toForm	(	\ilLanguage	$lng,
		FieldFactory	$f,
		Refinery	$refinery,
		?array	$environment = null
	)

Definition at line 45 of file SettingsParticipantFunctionality.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getInputUsrPassOverview(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getPostponedQuestionsMoveToEnd(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getQuestionListEnabled(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getQuestionMarkingEnabled(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getSuspendTestAllowed(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getUsePreviousAnswerAllowed(), ilLanguage\txt(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

     : FormInput {
        $inputs['use_previous_answers'] = $f->checkbox(
            $lng->txt('tst_use_previous_answers'),
            $lng->txt('tst_use_previous_answers_description')
        )->withValue($this->getUsePreviousAnswerAllowed());

        $inputs['allow_suspend_test'] = $f->checkbox(
            $lng->txt('tst_show_cancel'),
            $lng->txt('tst_show_cancel_description')
        )->withValue($this->getSuspendTestAllowed());

        $inputs['postponed_questions_behaviour'] = $f->radio(
            $lng->txt('tst_postpone')
        )->withOption(
            '0',
            $lng->txt('tst_postpone_off'),
            $lng->txt('tst_postpone_off_desc')
        )->withOption(
            '1',
            $lng->txt('tst_postpone_on'),
            $lng->txt('tst_postpone_on_desc')
        )->withValue($this->getPostponedQuestionsMoveToEnd() ? '1' : '0')
            ->withAdditionalTransformation($refinery->kindlyTo()->bool());

        $inputs['enable_question_list'] = $f->checkbox(
            $lng->txt('tst_enable_questionlist'),
            $lng->txt('tst_enable_questionlist_description')
        )->withValue($this->getQuestionListEnabled());

        $inputs['usr_pass_overview'] = $this->getInputUsrPassOverview($lng, $f, $refinery);

        $inputs['enable_question_marking'] = $f->checkbox(
            $lng->txt('question_marking'),
            $lng->txt('question_marking_description')
        )->withValue($this->getQuestionMarkingEnabled());

        return $f->section($inputs, $lng->txt('tst_sequence_properties'));
    }

Here is the call graph for this function:

toLog()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::toLog

(

AdditionalInformationGenerator

$additional_info

)

Definition at line 154 of file SettingsParticipantFunctionality.php.

References ILIAS\Test\Logging\AdditionalInformationGenerator\getEnabledDisabledTagForBool(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getPostponedQuestionsMoveToEnd(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getQuestionListEnabled(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getQuestionMarkingEnabled(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getShowDescriptionInQuestionList(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getShownQuestionListAtBeginning(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getShownQuestionListAtEnd(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getSuspendTestAllowed(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getUsePreviousAnswerAllowed(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getUsrPassOverviewEnabled(), ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_TEST_OVERVIEW_ENABLED, ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_TEST_OVERVIEW_SHOW_DESCRIPTION, ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_TEST_OVERVIEW_SHOW_END, ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_TEST_OVERVIEW_SHOW_START, ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_TEST_POSTPONED_MOVE_TO_END, ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_TEST_QUESTION_LIST_ENABLED, ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_TEST_QUESTION_MARKING_ENABLED, ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_TEST_SUSPEND_ALLOWED, and ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_TEST_USE_PREVIOUS_ANSWERS_ENABELD.

                                                                          : array
    {
        $log_array = [
            AdditionalInformationGenerator::KEY_TEST_USE_PREVIOUS_ANSWERS_ENABELD => $additional_info
                ->getEnabledDisabledTagForBool($this->getUsePreviousAnswerAllowed()),
            AdditionalInformationGenerator::KEY_TEST_SUSPEND_ALLOWED => $additional_info
                ->getEnabledDisabledTagForBool($this->getSuspendTestAllowed()),
            AdditionalInformationGenerator::KEY_TEST_POSTPONED_MOVE_TO_END => $additional_info
                ->getEnabledDisabledTagForBool($this->getPostponedQuestionsMoveToEnd())
        ];

        $log_array[AdditionalInformationGenerator::KEY_TEST_OVERVIEW_ENABLED] = $additional_info
                ->getEnabledDisabledTagForBool($this->getUsrPassOverviewEnabled());
        if ($this->getUsrPassOverviewEnabled()) {
            $log_array[AdditionalInformationGenerator::KEY_TEST_OVERVIEW_SHOW_START] = $additional_info
                ->getEnabledDisabledTagForBool($this->getShownQuestionListAtBeginning());
            $log_array[AdditionalInformationGenerator::KEY_TEST_OVERVIEW_SHOW_END] = $additional_info
                ->getEnabledDisabledTagForBool($this->getShownQuestionListAtEnd());
            $log_array[AdditionalInformationGenerator::KEY_TEST_OVERVIEW_SHOW_DESCRIPTION] = $additional_info
                ->getEnabledDisabledTagForBool($this->getShowDescriptionInQuestionList());
        }

        $log_array[AdditionalInformationGenerator::KEY_TEST_QUESTION_MARKING_ENABLED] = $additional_info
                ->getEnabledDisabledTagForBool($this->getQuestionMarkingEnabled());
        $log_array[AdditionalInformationGenerator::KEY_TEST_QUESTION_LIST_ENABLED] = $additional_info
                ->getEnabledDisabledTagForBool($this->getQuestionListEnabled());
        return $log_array;
    }

Here is the call graph for this function:

toStorage()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::toStorage

(

)

Definition at line 142 of file SettingsParticipantFunctionality.php.

References ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getPostponedQuestionsMoveToEnd(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getQuestionListEnabled(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getQuestionMarkingEnabled(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getSuspendTestAllowed(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getUsePreviousAnswerAllowed(), ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality\getUsrPassOverviewMode(), and ILIAS\Repository\int().

                               : array
    {
        return [
            'use_previous_answers' => ['integer', (int) $this->getUsePreviousAnswerAllowed()],
            'suspend_test_allowed' => ['integer', (int) $this->getSuspendTestAllowed()],
            'sequence_settings' => ['integer', (int) $this->getPostponedQuestionsMoveToEnd()],
            'usr_pass_overview_mode' => ['integer', $this->getUsrPassOverviewMode()],
            'show_marker' => ['integer', (int) $this->getQuestionMarkingEnabled()],
            'show_questionlist' => ['integer', $this->getQuestionListEnabled()]
        ];
    }

Here is the call graph for this function:

withPostponedQuestionsMoveToEnd()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::withPostponedQuestionsMoveToEnd

(

bool

$postponed_questions_move_to_end

)

Definition at line 209 of file SettingsParticipantFunctionality.php.

                                                                                          : self
    {
        $clone = clone $this;
        $clone->postponed_questions_move_to_end = $postponed_questions_move_to_end;
        return $clone;
    }

withQuestionListEnabled()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::withQuestionListEnabled

(

bool

$question_list_enabled

)

Definition at line 220 of file SettingsParticipantFunctionality.php.

                                                                        : self
    {
        $clone = clone $this;
        $clone->question_list_enabled = $question_list_enabled;
        return $clone;
    }

withQuestionMarkingEnabled()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::withQuestionMarkingEnabled

(

bool

$question_marking_enabled

)

Definition at line 262 of file SettingsParticipantFunctionality.php.

                                                                              : self
    {
        $clone = clone $this;
        $clone->question_marking_enabled = $question_marking_enabled;
        return $clone;
    }

withSuspendTestAllowed()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::withSuspendTestAllowed

(

bool

$suspend_test_allowed

)

Definition at line 198 of file SettingsParticipantFunctionality.php.

                                                                      : self
    {
        $clone = clone $this;
        $clone->suspend_test_allowed = $suspend_test_allowed;
        return $clone;
    }

withUsePreviousAnswerAllowed()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::withUsePreviousAnswerAllowed

(

bool

$use_previous_answers_allowed

)

Definition at line 187 of file SettingsParticipantFunctionality.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsMainGUI\getParticipantsFunctionalitySettingsForStorage().

                                                                                    : self
    {
        $clone = clone $this;
        $clone->use_previous_answers_allowed = $use_previous_answers_allowed;
        return $clone;
    }

Here is the caller graph for this function:

withUsrPassOverviewMode()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::withUsrPassOverviewMode

(

int

$usrpass_overview_mode

)

Definition at line 232 of file SettingsParticipantFunctionality.php.

                                                                       : self
    {
        $clone = clone $this;
        $clone->usrpass_overview_mode = $usrpass_overview_mode;
        return $clone;
    }

---

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

• components/ILIAS/Test/src/Settings/MainSettings/SettingsParticipantFunctionality.php