ILIAS\Test\Settings\MainSettings\SettingsIntroduction Class Reference

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

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

Public Member Functions
	__construct (protected bool $introduction_enabled=false, protected ?int $introduction_page_id=null, protected bool $conditions_checkbox_enabled=false,)
	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, ?array $environment=null)
	toStorage ()
	toLog (AdditionalInformationGenerator $additional_info)
	getIntroductionEnabled ()
	withIntroductionEnabled (bool $introduction_enabled)
	getIntroductionPageId ()
	withIntroductionPageId (?int $introduction_page_id)
	getExamConditionsCheckboxEnabled ()
	withExamConditionsCheckboxEnabled (bool $conditions_checkbox_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...

Detailed Description

Definition at line 30 of file SettingsIntroduction.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Settings\MainSettings\SettingsIntroduction::__construct	(	protected bool	$introduction_enabled = false,
		protected ?int	$introduction_page_id = null,
		protected bool	$conditions_checkbox_enabled = false
	)

Definition at line 32 of file SettingsIntroduction.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\SettingsIntroduction::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 121 of file SettingsIntroduction.php.

                                                  : static
    {
        return new self(
            (bool) $data['intro_enabled'],
            $data['introduction_page_id'],
            (bool) $data['conditions_checkbox_enabled'],
        );
    }

References $data.

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

Here is the caller graph for this function:

getExamConditionsCheckboxEnabled()

ILIAS\Test\Settings\MainSettings\SettingsIntroduction::getExamConditionsCheckboxEnabled

(

)

Definition at line 101 of file SettingsIntroduction.php.

                                                      : bool
    {
        return $this->conditions_checkbox_enabled;
    }

getIntroductionEnabled()

ILIAS\Test\Settings\MainSettings\SettingsIntroduction::getIntroductionEnabled

(

)

Definition at line 78 of file SettingsIntroduction.php.

                                            : bool
    {
        return $this->introduction_enabled;
    }

getIntroductionPageId()

ILIAS\Test\Settings\MainSettings\SettingsIntroduction::getIntroductionPageId

(

)

Definition at line 90 of file SettingsIntroduction.php.

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

toExport()

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

                              : array
    {
        return [
            'intro_enabled' => $this->getIntroductionEnabled(),
            'introduction_page_id' => $this->getIntroductionPageId(),
            'conditions_checkbox_enabled' => $this->getExamConditionsCheckboxEnabled()
        ];
    }

toForm()

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

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 40 of file SettingsIntroduction.php.

     : FormInput {
        $inputs['introduction_enabled'] = $f->checkbox(
            $lng->txt('tst_introduction'),
            $lng->txt('tst_introduction_desc')
        )->withValue($this->getIntroductionEnabled());
 
        $inputs['conditions_checkbox_enabled'] = $f->checkbox(
            $lng->txt('tst_conditions_checkbox_enabled'),
            $lng->txt('tst_conditions_checkbox_enabled_desc')
        )->withValue($this->getExamConditionsCheckboxEnabled());
 
        return $f->section($inputs, $lng->txt('tst_settings_header_intro'));
    }

toLog()

ILIAS\Test\Settings\MainSettings\SettingsIntroduction::toLog

(

AdditionalInformationGenerator

$additional_info

)

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 68 of file SettingsIntroduction.php.

                                                                          : array
    {
        return [
            AdditionalInformationGenerator::KEY_TEST_INTRODUCTION_ENABLED => $additional_info
                ->getEnabledDisabledTagForBool($this->getIntroductionEnabled()),
            AdditionalInformationGenerator::KEY_TEST_CONDITIONS_ENABLED => $additional_info
                ->getEnabledDisabledTagForBool($this->getExamConditionsCheckboxEnabled()),
        ];
    }

References ILIAS\Test\Logging\AdditionalInformationGenerator\getEnabledDisabledTagForBool(), ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_TEST_CONDITIONS_ENABLED, and ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_TEST_INTRODUCTION_ENABLED.

Here is the call graph for this function:

toStorage()

ILIAS\Test\Settings\MainSettings\SettingsIntroduction::toStorage

(

)

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 59 of file SettingsIntroduction.php.

                               : array
    {
        return [
            'intro_enabled' => ['integer', (int) $this->getIntroductionEnabled()],
            'introduction_page_id' => ['integer', $this->getIntroductionPageId()],
            'conditions_checkbox_enabled' => ['integer', (int) $this->getExamConditionsCheckboxEnabled()],
        ];
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

withExamConditionsCheckboxEnabled()

ILIAS\Test\Settings\MainSettings\SettingsIntroduction::withExamConditionsCheckboxEnabled

(

bool

$conditions_checkbox_enabled

)

Definition at line 105 of file SettingsIntroduction.php.

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

withIntroductionEnabled()

ILIAS\Test\Settings\MainSettings\SettingsIntroduction::withIntroductionEnabled

(

bool

$introduction_enabled

)

Definition at line 83 of file SettingsIntroduction.php.

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

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

Here is the caller graph for this function:

withIntroductionPageId()

ILIAS\Test\Settings\MainSettings\SettingsIntroduction::withIntroductionPageId

(

?int

$introduction_page_id

)

Definition at line 94 of file SettingsIntroduction.php.

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

---

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

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