Inheritance diagram for ilObjTestSettingsParticipantFunctionality:

Collaboration diagram for ilObjTestSettingsParticipantFunctionality:

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 ()

	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 ()

	getUsrPassOverviewEnabled ()

	getShownQuestionListAtBeginning ()

	getShownQuestionListAtEnd ()

	getShowDescriptionInQuestionList ()

	withUsrPassOverviewMode (int $usrpass_overview_mode)

	getQuestionMarkingEnabled ()

	withQuestionMarkingEnabled (bool $question_marking_enabled)

Public Member Functions inherited from TestSettings
	__construct (int $test_id)

	getTestId ()

	withTestId (int $test_id)

	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, array $environment=null)

	toStorage ()

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

Additional Inherited Members
Protected Attributes inherited from TestSettings
int	$test_id

Detailed Description

Definition at line 26 of file ilObjTestSettingsParticipantFunctionality.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjTestSettingsParticipantFunctionality::__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 28 of file ilObjTestSettingsParticipantFunctionality.php.

References ILIAS\MetaData\Repository\Validation\Data\__construct().

       {
         parent::__construct($test_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getInputUsrPassOverview()

ilObjTestSettingsParticipantFunctionality::getInputUsrPassOverview	(	\ilLanguage	$lng,
		FieldFactory	$f,
		Refinery	$refinery
	)

private

Definition at line 92 of file ilObjTestSettingsParticipantFunctionality.php.

References getShowDescriptionInQuestionList(), getShownQuestionListAtBeginning(), getShownQuestionListAtEnd(), getUsrPassOverviewEnabled(), ilLanguage\txt(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by 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()

ilObjTestSettingsParticipantFunctionality::getPostponedQuestionsMoveToEnd ( )

Definition at line 185 of file ilObjTestSettingsParticipantFunctionality.php.

Referenced by toForm(), and toStorage().

                                                     : bool
     {
         return $this->postponed_questions_move_to_end;
     }

Here is the caller graph for this function:

◆ getQuestionListEnabled()

ilObjTestSettingsParticipantFunctionality::getQuestionListEnabled ( )

Definition at line 196 of file ilObjTestSettingsParticipantFunctionality.php.

Referenced by toForm(), and toStorage().

                                             : bool
     {
         return $this->question_list_enabled;
     }

Here is the caller graph for this function:

◆ getQuestionMarkingEnabled()

ilObjTestSettingsParticipantFunctionality::getQuestionMarkingEnabled ( )

Definition at line 250 of file ilObjTestSettingsParticipantFunctionality.php.

Referenced by toForm(), and toStorage().

                                                : bool
     {
         return $this->question_marking_enabled;
     }

Here is the caller graph for this function:

◆ getShowDescriptionInQuestionList()

ilObjTestSettingsParticipantFunctionality::getShowDescriptionInQuestionList ( )

Definition at line 235 of file ilObjTestSettingsParticipantFunctionality.php.

Referenced by getInputUsrPassOverview().

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

Here is the caller graph for this function:

◆ getShownQuestionListAtBeginning()

ilObjTestSettingsParticipantFunctionality::getShownQuestionListAtBeginning ( )

Definition at line 219 of file ilObjTestSettingsParticipantFunctionality.php.

Referenced by getInputUsrPassOverview().

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

Here is the caller graph for this function:

◆ getShownQuestionListAtEnd()

ilObjTestSettingsParticipantFunctionality::getShownQuestionListAtEnd ( )

Definition at line 227 of file ilObjTestSettingsParticipantFunctionality.php.

Referenced by getInputUsrPassOverview().

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

Here is the caller graph for this function:

◆ getSuspendTestAllowed()

ilObjTestSettingsParticipantFunctionality::getSuspendTestAllowed ( )

Definition at line 174 of file ilObjTestSettingsParticipantFunctionality.php.

Referenced by toForm(), and toStorage().

                                            : bool
     {
         return $this->suspend_test_allowed;
     }

Here is the caller graph for this function:

◆ getUsePreviousAnswerAllowed()

ilObjTestSettingsParticipantFunctionality::getUsePreviousAnswerAllowed ( )

Definition at line 163 of file ilObjTestSettingsParticipantFunctionality.php.

Referenced by toForm(), and toStorage().

                                                  : bool
     {
         return $this->use_previous_answers_allowed;
     }

Here is the caller graph for this function:

◆ getUsrPassOverviewEnabled()

ilObjTestSettingsParticipantFunctionality::getUsrPassOverviewEnabled ( )

Definition at line 211 of file ilObjTestSettingsParticipantFunctionality.php.

Referenced by getInputUsrPassOverview().

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

Here is the caller graph for this function:

◆ getUsrPassOverviewMode()

ilObjTestSettingsParticipantFunctionality::getUsrPassOverviewMode ( )

Definition at line 207 of file ilObjTestSettingsParticipantFunctionality.php.

Referenced by toStorage().

                                             : int
     {
         return $this->usrpass_overview_mode;
     }

Here is the caller graph for this function:

◆ toForm()

ilObjTestSettingsParticipantFunctionality::toForm	(	\ilLanguage	$lng,
		FieldFactory	$f,
		Refinery	$refinery,
		array	$environment = `null`
	)

Returns: array<ILIAS>

Definition at line 44 of file ilObjTestSettingsParticipantFunctionality.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, getInputUsrPassOverview(), getPostponedQuestionsMoveToEnd(), getQuestionListEnabled(), getQuestionMarkingEnabled(), getSuspendTestAllowed(), 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:

◆ toStorage()

ilObjTestSettingsParticipantFunctionality::toStorage ( )

Definition at line 151 of file ilObjTestSettingsParticipantFunctionality.php.

References getPostponedQuestionsMoveToEnd(), getQuestionListEnabled(), getQuestionMarkingEnabled(), getSuspendTestAllowed(), getUsePreviousAnswerAllowed(), 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()

ilObjTestSettingsParticipantFunctionality::withPostponedQuestionsMoveToEnd ( bool $postponed_questions_move_to_end )

Definition at line 189 of file ilObjTestSettingsParticipantFunctionality.php.

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

◆ withQuestionListEnabled()

ilObjTestSettingsParticipantFunctionality::withQuestionListEnabled ( bool $question_list_enabled )

Definition at line 200 of file ilObjTestSettingsParticipantFunctionality.php.

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

◆ withQuestionMarkingEnabled()

ilObjTestSettingsParticipantFunctionality::withQuestionMarkingEnabled ( bool $question_marking_enabled )

Definition at line 254 of file ilObjTestSettingsParticipantFunctionality.php.

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

◆ withSuspendTestAllowed()

ilObjTestSettingsParticipantFunctionality::withSuspendTestAllowed ( bool $suspend_test_allowed )

Definition at line 178 of file ilObjTestSettingsParticipantFunctionality.php.

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

◆ withUsePreviousAnswerAllowed()

ilObjTestSettingsParticipantFunctionality::withUsePreviousAnswerAllowed ( bool $use_previous_answers_allowed )

Definition at line 167 of file ilObjTestSettingsParticipantFunctionality.php.

Referenced by ilObjTestSettingsMainGUI\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()

ilObjTestSettingsParticipantFunctionality::withUsrPassOverviewMode ( int $usrpass_overview_mode )

Definition at line 243 of file ilObjTestSettingsParticipantFunctionality.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:

Modules/Test/classes/MainSettings/ilObjTestSettingsParticipantFunctionality.php

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getInputUsrPassOverview()

◆ getPostponedQuestionsMoveToEnd()

◆ getQuestionListEnabled()

◆ getQuestionMarkingEnabled()

◆ getShowDescriptionInQuestionList()

◆ getShownQuestionListAtBeginning()

◆ getShownQuestionListAtEnd()

◆ getSuspendTestAllowed()

◆ getUsePreviousAnswerAllowed()

◆ getUsrPassOverviewEnabled()

◆ getUsrPassOverviewMode()

◆ toForm()

◆ toStorage()

◆ withPostponedQuestionsMoveToEnd()

◆ withQuestionListEnabled()

◆ withQuestionMarkingEnabled()

◆ withSuspendTestAllowed()

◆ withUsePreviousAnswerAllowed()

◆ withUsrPassOverviewMode()