ILIAS\Test\Settings\MainSettings\SettingsFinishing Class Reference

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

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

Public Member Functions
	__construct (protected bool $show_answer_overview=false, protected bool $concluding_remarks_enabled=false, protected ?int $concluding_remarks_page_id=null, protected RedirectionModes $redirection_mode=RedirectionModes::NONE, protected ?string $redirection_url=null,)
	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, ?array $environment=null)
	toStorage ()
	toLog (AdditionalInformationGenerator $additional_info)
	getShowAnswerOverview ()
	withShowAnswerOverview (bool $show_answer_overview)
	getConcludingRemarksEnabled ()
	withConcludingRemarksEnabled (bool $concluding_remarks_enabled)
	getConcludingRemarksPageId ()
	withConcludingRemarksPageId (?int $concluding_remarks_page_id)
	getRedirectionMode ()
	withRedirectionMode (RedirectionModes $redirection_mode)
	getRedirectionUrl ()
	withRedirectionUrl (?string $redirection_url)
	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
	getRedirectionInputs (\ilLanguage $lng, FieldFactory $f, Refinery $refinery)

Detailed Description

Definition at line 31 of file SettingsFinishing.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::__construct	(	protected bool	$show_answer_overview = false,
		protected bool	$concluding_remarks_enabled = false,
		protected ?int	$concluding_remarks_page_id = null,
		protected RedirectionModes	$redirection_mode = RedirectionModes::NONE,
		protected ?string	$redirection_url = null
	)

Definition at line 33 of file SettingsFinishing.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\SettingsFinishing::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 268 of file SettingsFinishing.php.

                                                  : static
    {
        return new self(
            (bool) $data['enable_examview'],
            (bool) $data['showfinalstatement'],
            $data['concluding_remarks_page_id'],
            RedirectionModes::from($data['redirection_mode']),
            $data['redirection_url']
        );
    }

References $data, and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getConcludingRemarksEnabled()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getConcludingRemarksEnabled

(

)

Definition at line 209 of file SettingsFinishing.php.

                                                 : bool
    {
        return $this->concluding_remarks_enabled;
    }

getConcludingRemarksPageId()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getConcludingRemarksPageId

(

)

Definition at line 221 of file SettingsFinishing.php.

                                                : ?int
    {
        return $this->concluding_remarks_page_id;
    }

getRedirectionInputs()

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

private

Definition at line 64 of file SettingsFinishing.php.

     : OptionalGroup {
        $redirection_trafo = $refinery->custom()->transformation(
            static function (?array $v): array {
                if ($v === null) {
                    return [
                        'redirect_mode' => RedirectionModes::NONE,
                        'redirect_url' => ''
                    ];
                }
 
                return [
                    'redirect_mode' => RedirectionModes::tryFrom($v['redirect_mode'])
                        ?? RedirectionModes::NONE,
                    'redirect_url' => $v['redirect_url']
                ];
            }
        );
 
        $sub_inputs_redirect = [
            'redirect_mode' => $f
                ->radio($lng->txt('redirect_after_finishing_rule'))
                ->withOption(
                    (string) RedirectionModes::ALWAYS->value,
                    $lng->txt('redirect_always')
                )->withOption(
                    (string) RedirectionModes::ALWAYS_TO_LOGOUT->value,
                    $lng->txt('redirect_always_to_logout')
                )->withOption(
                    (string) RedirectionModes::IF_KIOSK_ACTIVATED->value,
                    $lng->txt('redirect_in_kiosk_mode')
                )->withRequired(true)
                ->withAdditionalTransformation($refinery->kindlyTo()->int()),
            'redirect_url' => $f
                ->text($lng->txt('redirection_url'))
                ->withAdditionalTransformation($refinery->string()->hasMaxLength(4000))
                ->withAdditionalTransformation(
                    $refinery->custom()->constraint(
                        static function ($v) use ($refinery): bool {
                            try {
                                return $v === '' || $refinery->to()->data('uri')->transform($v);
                            } catch (Throwable) {
                                return false;
                            }
                        },
                        $lng->txt('redirect_url_invalid')
                    )
                )
        ];
 
        $redirection_input = $f
            ->optionalGroup(
                $sub_inputs_redirect,
                $lng->txt('redirect_after_finishing_tst'),
                $lng->txt('redirect_after_finishing_tst_desc')
            )
            ->withValue(null)
            ->withAdditionalTransformation($redirection_trafo)
            ->withAdditionalTransformation(
                $refinery->custom()->constraint(
                    static function (array $v): bool {
                        return in_array(
                            $v['redirect_mode'],
                            [RedirectionModes::NONE, RedirectionModes::ALWAYS_TO_LOGOUT],
                            true
                        ) || $v['redirect_url'] !== '';
                    },
                    static function (\Closure $txt, array $value): string {
                        return sprintf(
                            $txt('redirect_url_required_for_rule'),
                            $value['redirect_mode'] === RedirectionModes::ALWAYS
                                ? $txt('redirect_always')
                                : $txt('redirect_in_kiosk_mode')
                        );
                    }
                )
            );
 
        if ($this->getRedirectionMode() === RedirectionModes::NONE) {
            return $redirection_input;
        }
 
        return $redirection_input->withValue(
            [
                'redirect_mode' => $this->getRedirectionMode()->value,
                'redirect_url' => $this->getRedirectionUrl()
            ]
        );
    }

getRedirectionMode()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getRedirectionMode

(

)

Definition at line 233 of file SettingsFinishing.php.

                                        : RedirectionModes
    {
        return $this->redirection_mode;
    }

getRedirectionUrl()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getRedirectionUrl

(

)

Definition at line 245 of file SettingsFinishing.php.

                                       : ?string
    {
        return $this->redirection_url;
    }

getShowAnswerOverview()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getShowAnswerOverview

(

)

Definition at line 197 of file SettingsFinishing.php.

                                           : bool
    {
        return $this->show_answer_overview;
    }

toExport()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::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 257 of file SettingsFinishing.php.

                              : array
    {
        return [
            'enable_examview' => $this->getShowAnswerOverview(),
            'showfinalstatement' => $this->getConcludingRemarksEnabled(),
            'concluding_remarks_page_id' => $this->getConcludingRemarksPageId(),
            'redirection_mode' => $this->getRedirectionMode()->value,
            'redirection_url' => $this->getRedirectionUrl()
        ];
    }

toForm()

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

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 43 of file SettingsFinishing.php.

     : FormInput {
        $inputs['show_answer_overview'] = $f->checkbox(
            $lng->txt('enable_examview'),
            $lng->txt('enable_examview_desc')
        )->withValue($this->getShowAnswerOverview());
 
        $inputs['show_concluding_remarks'] = $f->checkbox(
            $lng->txt('final_statement'),
            $lng->txt('final_statement_show_desc')
        )->withValue((bool) $this->getConcludingRemarksEnabled());
 
        $inputs['redirect_after_finish'] = $this->getRedirectionInputs($lng, $f, $refinery);
 
        return $f->section($inputs, $lng->txt('tst_final_information'));
    }

toLog()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::toLog

(

AdditionalInformationGenerator

$additional_info

)

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 168 of file SettingsFinishing.php.

                                                                          : array
    {
        $log_array = [
            AdditionalInformationGenerator::KEY_TEST_ANSWER_OVERVIEW_ENABLED => $additional_info
                ->getEnabledDisabledTagForBool($this->getShowAnswerOverview()),
            AdditionalInformationGenerator::KEY_TEST_CONCLUDING_REMARKS_ENABLED => $additional_info
                ->getEnabledDisabledTagForBool($this->getConcludingRemarksEnabled()),
            AdditionalInformationGenerator::KEY_TEST_REDIRECT_URL => $this->getRedirectionUrl(),
 
        ];
 
        switch ($this->getRedirectionMode()) {
            case RedirectionModes::NONE:
                $log_array[AdditionalInformationGenerator::KEY_TEST_REDIRECT_MODE] = $additional_info
                    ->getNoneTag();
                break;
            case RedirectionModes::ALWAYS:
                $log_array[AdditionalInformationGenerator::KEY_TEST_REDIRECT_MODE] = $additional_info
                    ->getTagForLangVar('redirect_always');
                break;
            case RedirectionModes::IF_KIOSK_ACTIVATED:
                $log_array[AdditionalInformationGenerator::KEY_TEST_REDIRECT_MODE] = $additional_info
                    ->getTagForLangVar('redirect_in_kiosk_mode');
                break;
        }
 
        return $log_array;
    }

References ALWAYS, ILIAS\Test\Logging\AdditionalInformationGenerator\getEnabledDisabledTagForBool(), ILIAS\Test\Logging\AdditionalInformationGenerator\getNoneTag(), and ILIAS\Test\Logging\AdditionalInformationGenerator\getTagForLangVar().

Here is the call graph for this function:

toStorage()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::toStorage

(

)

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 157 of file SettingsFinishing.php.

                               : array
    {
        return [
            'enable_examview' => ['integer', (int) $this->getShowAnswerOverview()],
            'showfinalstatement' => ['integer', (int) $this->getConcludingRemarksEnabled()],
            'concluding_remarks_page_id' => ['integer', $this->getConcludingRemarksPageId()],
            'redirection_mode' => ['integer', $this->getRedirectionMode()->value],
            'redirection_url' => ['text', $this->getRedirectionUrl()],
        ];
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

withConcludingRemarksEnabled()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withConcludingRemarksEnabled

(

bool

$concluding_remarks_enabled

)

Definition at line 214 of file SettingsFinishing.php.

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

withConcludingRemarksPageId()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withConcludingRemarksPageId

(

?int

$concluding_remarks_page_id

)

Definition at line 226 of file SettingsFinishing.php.

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

withRedirectionMode()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withRedirectionMode

(

RedirectionModes

$redirection_mode

)

Definition at line 238 of file SettingsFinishing.php.

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

withRedirectionUrl()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withRedirectionUrl

(

?string

$redirection_url

)

Definition at line 250 of file SettingsFinishing.php.

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

withShowAnswerOverview()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withShowAnswerOverview

(

bool

$show_answer_overview

)

Definition at line 202 of file SettingsFinishing.php.

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

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

Here is the caller graph for this function:

---

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

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