ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings Class Reference

Collaboration diagram for ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings:

Public Member Functions
	__construct (private ProcessLockModes $process_lock_mode=ProcessLockModes::ASS_PROC_LOCK_MODE_NONE, private string $image_map_line_color='FF0000', private UserIdentifiers $user_identifier=UserIdentifiers::USER_ID, private int $skill_triggering_number_of_answers=1, private bool $export_essay_questions_as_html=false, private array $disabled_question_types=[], private bool $manual_scoring_enabled=false, private bool $adjusting_questions_with_results_allowed=false, private bool $page_editor_enabled=false)
	toForm (UIFactory $ui_factory, Refinery $refinery, \ilLanguage $lng)
	getProcessLockMode ()
	withProcessLockMode (ProcessLockModes $process_lock_mode)
	getImageMapLineColor ()
	withImageMapLineColor (string $image_map_line_color)
	getUserIdentifier ()
	withUserIdentifier (UserIdentifiers $user_identifier)
	getSkillTriggeringNumberOfAnswers ()
	withSkillTriggeringNumberOfAnswers (int $skill_triggering_number_of_answers)
	getExportEssayQuestionsAsHtml ()
	withExportEssayQuestionsAsHtml (bool $export_essay_questions_as_html)
	getDisabledQuestionTypes ()
	withDisabledQuestionTypes (array $disabled_question_types)
	isManualScoringEnabled ()
	withManualScoringEnabled (bool $manual_scoring_enabled)
	isAdjustingQuestionsWithResultsAllowed ()
	withAdjustingQuestionsWithResultsAllowed (bool $adjusting_questions_with_results_allowed)
	isPageEditorEnabled ()
	withPageEditorEnabled (bool $page_editor_enabled)

Private Member Functions
	buildGlobalSettingsBuilderTrafo (Refinery $refinery, array $all_question_types)
	buildGeneralSettingsInputs (FieldFactory $ff, Refinery $refinery, \ilLanguage $lng)
	buildQuestionSettingsInputs (FieldFactory $ff, \ilLanguage $lng, array $all_question_types, array $enabled_question_types)

Detailed Description

Definition at line 29 of file GlobalTestSettings.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::__construct	(	private ProcessLockModes	$process_lock_mode = ProcessLockModes::ASS_PROC_LOCK_MODE_NONE,
		private string	$image_map_line_color = 'FF0000',
		private UserIdentifiers	$user_identifier = UserIdentifiers::USER_ID,
		private int	$skill_triggering_number_of_answers = 1,
		private bool	$export_essay_questions_as_html = false,
		private array	$disabled_question_types = [],
		private bool	$manual_scoring_enabled = false,
		private bool	$adjusting_questions_with_results_allowed = false,
		private bool	$page_editor_enabled = false
	)

Definition at line 31 of file GlobalTestSettings.php.

      {
    }

Member Function Documentation

buildGeneralSettingsInputs()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::buildGeneralSettingsInputs ( FieldFactory  $ff, Refinery  $refinery, \ilLanguage  $lng  )

private

Definition at line 224 of file GlobalTestSettings.php.

     : Section {
        return $ff->section(
            [
                'process_lock_mode' => $ff->optionalGroup(
                    [
                        $ff->radio($lng->txt('ass_process_lock_mode'))
                        ->withOption(
                            ProcessLockModes::ASS_PROC_LOCK_MODE_FILE->value,
                            $lng->txt('ass_process_lock_mode_file'),
                            $lng->txt('ass_process_lock_mode_file_desc')
                        )->withOption(
                            ProcessLockModes::ASS_PROC_LOCK_MODE_DB->value,
                            $lng->txt('ass_process_lock_mode_db'),
                            $lng->txt('ass_process_lock_mode_db_desc')
                        )
                    ],
                    $lng->txt('ass_process_lock')
                )->withByline($lng->txt('ass_process_lock_desc'))
                ->withValue($this->process_lock_mode === ProcessLockModes::ASS_PROC_LOCK_MODE_NONE ? null : [$this->process_lock_mode->value]),
                'image_map_line_color' => $ff->colorSelect($lng->txt('imap_line_color'))
                    ->withValue('#' . $this->image_map_line_color),
                'user_identifier' => $ff->select(
                    $lng->txt('user_criteria'),
                    array_reduce(
                        UserIdentifiers::cases(),
                        function (array $c, UserIdentifiers $v): array {
                            $c[$v->value] = $v->value;
                            return $c;
                        },
                        []
                    )
                )->withRequired(true)
                ->withByline($lng->txt('user_criteria_desc'))
                ->withValue($this->user_identifier->value),
                'skill_triggering_number_of_answers' => $ff->numeric($lng->txt('tst_skill_triggerings_num_req_answers'))
                    ->withAdditionalTransformation($refinery->int()->isGreaterThan(0))
                    ->withByline($lng->txt('tst_skill_triggerings_num_req_answers_desc'))
                    ->withValue($this->skill_triggering_number_of_answers),
                'export_essay_questions_as_html' => $ff->checkbox($lng->txt('export_essay_qst_with_html'))
                    ->withByline($lng->txt('export_essay_qst_with_html_desc'))
                    ->withValue($this->export_essay_questions_as_html)
            ],
            $lng->txt('settings')
        );
    }

buildGlobalSettingsBuilderTrafo()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::buildGlobalSettingsBuilderTrafo ( Refinery  $refinery, array  $all_question_types  )

private

Definition at line 191 of file GlobalTestSettings.php.

     : Transformation {
        return $refinery->custom()->transformation(
            static function ($vs) use ($all_question_types): self {
                $process_lock_mode = ProcessLockModes::ASS_PROC_LOCK_MODE_NONE;
                if ($vs['general_settings']['process_lock_mode'] !== null) {
                    $process_lock_mode = ProcessLockModes::from($vs['general_settings']['process_lock_mode'][0]);
                }
                return new self(
                    $process_lock_mode,
                    substr($vs['general_settings']['image_map_line_color']->asHex(), 1),
                    UserIdentifiers::from($vs['general_settings']['user_identifier']),
                    $vs['general_settings']['skill_triggering_number_of_answers'],
                    $vs['general_settings']['export_essay_questions_as_html'],
                    array_reduce(
                        $all_question_types,
                        static function (array $c, array $v) use ($vs): array {
                            if (!in_array($v['question_type_id'], $vs['question_settings']['enabled_question_types'])) {
                                $c[] = $v['question_type_id'];
                            }
                            return $c;
                        },
                        []
                    ),
                    $vs['question_settings']['manual_scoring_enabled'],
                    $vs['question_settings']['adjusting_questions_with_results_allowed']
                );
            }
        );
    }

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Here is the call graph for this function:

buildQuestionSettingsInputs()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::buildQuestionSettingsInputs ( FieldFactory  $ff, \ilLanguage  $lng, array  $all_question_types, array  $enabled_question_types  )

private

Definition at line 274 of file GlobalTestSettings.php.

     : Section {
        return $ff->section(
            [
                'enabled_question_types' => $ff->multiSelect(
                    $lng->txt('assf_allowed_questiontypes'),
                    array_reduce(
                        array_keys($all_question_types),
                        function (array $c, string $v) use ($all_question_types): array {
                            $c[$all_question_types[$v]['question_type_id']] = $v;
                            return $c;
                        },
                        []
                    )
                )->withByline($lng->txt('assf_allowed_questiontypes_desc'))
                ->withValue($enabled_question_types),
                'manual_scoring_enabled' => $ff->checkbox($lng->txt('activate_manual_scoring'))
                    ->withByline($lng->txt('activate_manual_scoring_desc'))
                    ->withValue($this->isManualScoringEnabled()),
                'adjusting_questions_with_results_allowed' => $ff->checkbox($lng->txt('assessment_scoring_adjust'))
                    ->withByline($lng->txt('assessment_scoring_adjust_desc'))
                    ->withValue($this->isAdjustingQuestionsWithResultsAllowed())
            ],
            $lng->txt('assf_questiontypes')
        );
    }

getDisabledQuestionTypes()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::getDisabledQuestionTypes

(

)

Returns

array<int>

Definition at line 140 of file GlobalTestSettings.php.

                                              : array
    {
        return $this->disabled_question_types;
    }

Referenced by ILIAS\Test\Settings\GlobalSettings\Repository\storeGlobalSettings().

Here is the caller graph for this function:

getExportEssayQuestionsAsHtml()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::getExportEssayQuestionsAsHtml

(

)

Definition at line 125 of file GlobalTestSettings.php.

                                                   : bool
    {
        return $this->export_essay_questions_as_html;
    }

Referenced by ILIAS\Test\Settings\GlobalSettings\Repository\storeGlobalSettings().

Here is the caller graph for this function:

getImageMapLineColor()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::getImageMapLineColor

(

)

Definition at line 89 of file GlobalTestSettings.php.

                                          : string
    {
        return $this->image_map_line_color;
    }

Referenced by ILIAS\Test\Settings\GlobalSettings\Repository\storeGlobalSettings().

Here is the caller graph for this function:

getProcessLockMode()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::getProcessLockMode

(

)

Definition at line 77 of file GlobalTestSettings.php.

                                        : ProcessLockModes
    {
        return $this->process_lock_mode;
    }

Referenced by ILIAS\Test\Settings\GlobalSettings\Repository\storeGlobalSettings().

Here is the caller graph for this function:

getSkillTriggeringNumberOfAnswers()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::getSkillTriggeringNumberOfAnswers

(

)

Definition at line 113 of file GlobalTestSettings.php.

                                                       : int
    {
        return $this->skill_triggering_number_of_answers;
    }

Referenced by ILIAS\Test\Settings\GlobalSettings\Repository\storeGlobalSettings().

Here is the caller graph for this function:

getUserIdentifier()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::getUserIdentifier

(

)

Definition at line 101 of file GlobalTestSettings.php.

                                       : UserIdentifiers
    {
        return $this->user_identifier;
    }

Referenced by ILIAS\Test\Settings\GlobalSettings\Repository\storeGlobalSettings().

Here is the caller graph for this function:

isAdjustingQuestionsWithResultsAllowed()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::isAdjustingQuestionsWithResultsAllowed

(

)

Definition at line 167 of file GlobalTestSettings.php.

                                                            : bool
    {
        return $this->adjusting_questions_with_results_allowed;
    }

Referenced by ILIAS\Test\Settings\GlobalSettings\Repository\storeGlobalSettings().

Here is the caller graph for this function:

isManualScoringEnabled()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::isManualScoringEnabled

(

)

Definition at line 155 of file GlobalTestSettings.php.

                                            : bool
    {
        return $this->manual_scoring_enabled;
    }

Referenced by ILIAS\Test\Settings\GlobalSettings\Repository\storeGlobalSettings().

Here is the caller graph for this function:

isPageEditorEnabled()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::isPageEditorEnabled

(

)

Definition at line 179 of file GlobalTestSettings.php.

                                         : bool
    {
        return $this->page_editor_enabled;
    }

toForm()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::toForm	(	UIFactory	$ui_factory,
		Refinery	$refinery,
		\ilLanguage	$lng
	)

Returns

array<ILIAS\UI\Component\Input\Input>

Definition at line 48 of file GlobalTestSettings.php.

     : array {
        $ff = $ui_factory->input()->field();
        $all_question_types = \ilObjQuestionPool::_getQuestionTypes(true);
        $enabled_question_types = array_map(
            static fn(array $v): int => $v['question_type_id'],
            array_filter(
                $all_question_types,
                fn(array $v): bool => !in_array($v['question_type_id'], $this->disabled_question_types)
            )
        );
        $trafo = $this->buildGlobalSettingsBuilderTrafo($refinery, $all_question_types);
 
        return [
            'global_settings' => $ff->group([
                'general_settings' => $this->buildGeneralSettingsInputs($ff, $refinery, $lng),
                'question_settings' => $this->buildQuestionSettingsInputs(
                    $ff,
                    $lng,
                    $all_question_types,
                    $enabled_question_types
                )
            ])->withAdditionalTransformation($trafo)
        ];
    }

withAdjustingQuestionsWithResultsAllowed()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::withAdjustingQuestionsWithResultsAllowed

(

bool

$adjusting_questions_with_results_allowed

)

Definition at line 172 of file GlobalTestSettings.php.

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

withDisabledQuestionTypes()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::withDisabledQuestionTypes

(

array

$disabled_question_types

)

Parameters

array<int>

$disabled_question_types

Definition at line 148 of file GlobalTestSettings.php.

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

withExportEssayQuestionsAsHtml()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::withExportEssayQuestionsAsHtml

(

bool

$export_essay_questions_as_html

)

Definition at line 130 of file GlobalTestSettings.php.

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

withImageMapLineColor()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::withImageMapLineColor

(

string

$image_map_line_color

)

Definition at line 94 of file GlobalTestSettings.php.

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

withManualScoringEnabled()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::withManualScoringEnabled

(

bool

$manual_scoring_enabled

)

Definition at line 160 of file GlobalTestSettings.php.

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

withPageEditorEnabled()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::withPageEditorEnabled

(

bool

$page_editor_enabled

)

Definition at line 184 of file GlobalTestSettings.php.

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

withProcessLockMode()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::withProcessLockMode

(

ProcessLockModes

$process_lock_mode

)

Definition at line 82 of file GlobalTestSettings.php.

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

withSkillTriggeringNumberOfAnswers()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::withSkillTriggeringNumberOfAnswers

(

int

$skill_triggering_number_of_answers

)

Definition at line 118 of file GlobalTestSettings.php.

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

withUserIdentifier()

ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings::withUserIdentifier

(

UserIdentifiers

$user_identifier

)

Definition at line 106 of file GlobalTestSettings.php.

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

---

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

• components/ILIAS/Test/src/Settings/GlobalSettings/GlobalTestSettings.php