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 (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)
	toExport ()
	Transform the object into a simple, associative array. More...
Public Member Functions inherited from ILIAS\Test\Settings\TestSettings
	__construct ()
	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, ?array $environment=null)
	toStorage ()
	toLog (AdditionalInformationGenerator $additional_info)
	toExport ()
	Transform the object into a simple, associative array. More...

Static Public Member Functions
static	fromExport (array $data)
	Creates an instance of the object from an array. More...
static	fromExport (array $data)
	Creates an instance of the object from an array. More...

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

Detailed Description

Definition at line 31 of file SettingsParticipantFunctionality.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::__construct	(	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.

      {
        parent::__construct();
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

fromExport()

static ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::fromExport ( array  $data )

static

Creates an instance of the object from an array.

This static factory method is responsible for constructing a new object instance from the provided array data. It should validate the input and may throw an exception if the data is incomplete or malformed.

Parameters

ExportableArray

$data

The data to restore the object from

Returns

static A new instance of the class

Implements ILIAS\Test\ExportImport\Exportable.

Definition at line 280 of file SettingsParticipantFunctionality.php.

                                                  : static
    {
        return new self(
            (bool) $data['use_previous_answers'],
            (bool) $data['suspend_test_allowed'],
            (bool) $data['postponed_questions_move_to_end'],
            (int) $data['usr_pass_overview_mode'],
            (bool) $data['question_marking_enabled'],
            (bool) $data['show_questionlist']
        );
    }

References $data.

Referenced by ILIAS\Test\Settings\MainSettings\MainSettings\fromExport().

Here is the caller graph for this function:

getInputUsrPassOverview()

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

private

Definition at line 88 of file SettingsParticipantFunctionality.php.

     : 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()
            ]
        );
    }

getPostponedQuestionsMoveToEnd()

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

(

)

Definition at line 204 of file SettingsParticipantFunctionality.php.

                                                    : bool
    {
        return $this->postponed_questions_move_to_end;
    }

getQuestionListEnabled()

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

(

)

Definition at line 215 of file SettingsParticipantFunctionality.php.

                                            : bool
    {
        return $this->question_list_enabled;
    }

getQuestionMarkingEnabled()

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

(

)

Definition at line 256 of file SettingsParticipantFunctionality.php.

                                               : bool
    {
        return $this->question_marking_enabled;
    }

getShowDescriptionInQuestionList()

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

(

)

Definition at line 251 of file SettingsParticipantFunctionality.php.

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

getShownQuestionListAtBeginning()

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

(

)

Definition at line 242 of file SettingsParticipantFunctionality.php.

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

getShownQuestionListAtEnd()

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

(

)

Definition at line 246 of file SettingsParticipantFunctionality.php.

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

getSuspendTestAllowed()

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

(

)

Definition at line 193 of file SettingsParticipantFunctionality.php.

                                           : bool
    {
        return $this->suspend_test_allowed;
    }

getUsePreviousAnswerAllowed()

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

(

)

Definition at line 182 of file SettingsParticipantFunctionality.php.

                                                 : bool
    {
        return $this->use_previous_answers_allowed;
    }

getUsrPassOverviewEnabled()

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

(

)

Definition at line 238 of file SettingsParticipantFunctionality.php.

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

getUsrPassOverviewMode()

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

(

)

Definition at line 226 of file SettingsParticipantFunctionality.php.

                                            : int
    {
        return $this->usrpass_overview_mode;
    }

toExport()

ILIAS\Test\Settings\MainSettings\SettingsParticipantFunctionality::toExport

(

)

Transform the object into a simple, associative array.

The resulting array represents the object's state and should contain only scalar values, arrays, or other Exportable objects.

Returns

ExportableArray The exportable array representation of the object

Implements ILIAS\Test\ExportImport\Exportable.

Definition at line 268 of file SettingsParticipantFunctionality.php.

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

toForm()

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

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 44 of file SettingsParticipantFunctionality.php.

     : 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'));
    }

toLog()

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

(

AdditionalInformationGenerator

$additional_info

)

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 153 of file SettingsParticipantFunctionality.php.

                                                                          : 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;
    }

References ILIAS\Test\Logging\AdditionalInformationGenerator\getEnabledDisabledTagForBool().

Here is the call graph for this function:

toStorage()

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

(

)

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 141 of file SettingsParticipantFunctionality.php.

                               : 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()]
        ];
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

withPostponedQuestionsMoveToEnd()

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

(

bool

$postponed_questions_move_to_end

)

Definition at line 208 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 219 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 261 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 197 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 186 of file SettingsParticipantFunctionality.php.

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

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

Here is the caller graph for this function:

withUsrPassOverviewMode()

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

(

int

$usrpass_overview_mode

)

Definition at line 231 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