ILIAS\Test\Settings\MainSettings\SettingsAccess Class Reference

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

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

Public Member Functions
	__construct (protected bool $start_time_enabled=false, protected ?\DateTimeImmutable $start_time=null, protected bool $end_time_enabled=false, protected ?\DateTimeImmutable $end_time=null, protected bool $password_enabled=false, protected ?string $password=null, protected ?string $ip_range_from=null, protected ?string $ip_range_to=null, protected bool $fixed_participants=false)
	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, ?array $environment=null)
	toStorage ()
	toLog (AdditionalInformationGenerator $additional_info)
	getStartTimeEnabled ()
	withStartTimeEnabled (bool $start_time_enabled)
	getStartTime ()
	withStartTime (?\DateTimeImmutable $start_time)
	getEndTimeEnabled ()
	withEndTimeEnabled (bool $end_time_enabled)
	getEndTime ()
	withEndTime (?\DateTimeImmutable $end_time)
	getPasswordEnabled ()
	withPasswordEnabled (bool $password_enabled)
	getPassword ()
	withPassword (?string $password)
	getIpRangeFrom ()
	withIpRangeFrom (?string $ip_range_from)
	getIpRangeTo ()
	withIpRangeTo (?string $ip_range_to)
	isIpRangeEnabled ()
	getFixedParticipants ()
	withFixedParticipants (bool $fixed_participants)
	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
	getInputAccessWindow (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, ?array $environment=null)
	getSubInputsAccessWindow (\ilLanguage $lng, FieldFactory $f, array $environment)
	getInputPassword (\ilLanguage $lng, FieldFactory $f, Refinery $refinery)
	getInputIpRange (\ilLanguage $lng, FieldFactory $f, Refinery $refinery)
	checkIpRangeValidity (string $start, string $end)

Private Attributes
const	MAX_PASSWORD_LENGTH = 20

Detailed Description

Definition at line 32 of file SettingsAccess.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Settings\MainSettings\SettingsAccess::__construct	(	protected bool	$start_time_enabled = false,
		protected ?\DateTimeImmutable	$start_time = null,
		protected bool	$end_time_enabled = false,
		protected ?\DateTimeImmutable	$end_time = null,
		protected bool	$password_enabled = false,
		protected ?string	$password = null,
		protected ?string	$ip_range_from = null,
		protected ?string	$ip_range_to = null,
		protected bool	$fixed_participants = false
	)

Definition at line 36 of file SettingsAccess.php.

      {
        parent::__construct();
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

checkIpRangeValidity()

ILIAS\Test\Settings\MainSettings\SettingsAccess::checkIpRangeValidity ( string  $start, string  $end  )

private

Definition at line 231 of file SettingsAccess.php.

                                                                     : bool
    {
        if (filter_var($start, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false
           && filter_var($end, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false) {
            return ip2long($start) <= ip2long($end);
        }
 
        if (filter_var($start, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false
           && filter_var($end, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false) {
            return bin2hex(inet_pton($start)) <= bin2hex(inet_pton($end));
        }
        return false;
    }

fromExport()

static ILIAS\Test\Settings\MainSettings\SettingsAccess::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 403 of file SettingsAccess.php.

                                                  : static
    {
        return new self(
            (bool) $data['starting_time_enabled'],
            $data['starting_time'] !== null ? new \DateTimeImmutable($data['starting_time']) : null,
            (bool) $data['ending_time_enabled'],
            $data['ending_time'] !== null ? new \DateTimeImmutable($data['ending_time']) : null,
            (bool) $data['password_enabled'],
            $data['password'],
            $data['ip_range_from'],
            $data['ip_range_to'],
            (bool) $data['fixed_participants'],
        );
    }

References $data.

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

Here is the caller graph for this function:

getEndTime()

ILIAS\Test\Settings\MainSettings\SettingsAccess::getEndTime

(

)

Definition at line 317 of file SettingsAccess.php.

                                : ?\DateTimeImmutable
    {
        return $this->end_time;
    }

getEndTimeEnabled()

ILIAS\Test\Settings\MainSettings\SettingsAccess::getEndTimeEnabled

(

)

Definition at line 306 of file SettingsAccess.php.

                                       : bool
    {
        return $this->end_time_enabled;
    }

getFixedParticipants()

ILIAS\Test\Settings\MainSettings\SettingsAccess::getFixedParticipants

(

)

Definition at line 377 of file SettingsAccess.php.

                                          : bool
    {
        return $this->fixed_participants;
    }

getInputAccessWindow()

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

private

Definition at line 72 of file SettingsAccess.php.

     : Group {
        $constraint = $refinery->custom()->constraint(
            static fn(array $vs) =>
                $vs['start_time'] === null || $vs['end_time'] === null || $vs['start_time'] < $vs['end_time'],
            $lng->txt('duration_end_must_not_be_earlier_than_start')
        );
 
        $trafo = $refinery->custom()->transformation(
            static function (array $vs): array {
                $vs['start_time_enabled'] = $vs['start_time'] !== null;
                $vs['end_time_enabled'] = $vs['end_time'] !== null;
                return $vs;
            }
        );
 
        return $f->group($this->getSubInputsAccessWindow($lng, $f, $environment))
            ->withAdditionalTransformation($constraint)
            ->withAdditionalTransformation($trafo);
    }

getInputIpRange()

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

private

Definition at line 168 of file SettingsAccess.php.

     : FormInput {
        $validate_ip = $refinery->custom()->constraint(
            static function (?string $v): bool {
                if ($v === null) {
                    return true;
                }
                return filter_var($v, FILTER_VALIDATE_IP) !== false;
            },
            $lng->txt('invalid_ip')
        );
 
        $validate_order = $refinery->custom()->constraint(
            function (?array $vs): bool {
                if ($vs === null) {
                    return true;
                }
                return $this->checkIpRangeValidity(
                    $vs['ip_range_from'],
                    $vs['ip_range_to']
                );
            },
            sprintf($lng->txt('not_greater_than'), $lng->txt('max_ip_label'), $lng->txt('min_ip_label'))
        );
        $trafo = $refinery->custom()->transformation(
            static function (?array $vs): array {
                if ($vs === null) {
                    $vs = [
                        'ip_range_from' => null,
                        'ip_range_to' => null
                    ];
                }
                return $vs;
            }
        );
 
        $get_ip_range = $f->optionalGroup(
            [
                'ip_range_from' => $f->text($lng->txt('min_ip_label'))
                    ->withAdditionalTransformation($validate_ip),
                'ip_range_to' => $f->text($lng->txt('max_ip_label'))
                    ->withAdditionalTransformation($validate_ip)
            ],
            $lng->txt('ip_range_label'),
            $lng->txt('ip_range_info')
        )->withValue(null);
 
        if ($this->isIpRangeEnabled()) {
            $get_ip_range = $get_ip_range->withValue(
                [
                    'ip_range_from' => $this->getIpRangeFrom(),
                    'ip_range_to' => $this->getIpRangeTo()
                ]
            );
        }
 
        return $get_ip_range->withAdditionalTransformation($validate_order)
            ->withAdditionalTransformation($trafo);
    }

getInputPassword()

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

private

Definition at line 130 of file SettingsAccess.php.

     : OptionalGroup {
        $trafo = $refinery->custom()->transformation(
            static function (?array $vs): array {
                if ($vs === null) {
                    return [
                        'password_enabled' => false,
                        'password_value' => null
                    ];
                }
 
                $vs['password_enabled'] = true;
                return $vs;
            }
        );
 
        $sub_inputs_password['password_value'] = $f->text($lng->txt('tst_password_enter'))
            ->withRequired(true)->withMaxLength(self::MAX_PASSWORD_LENGTH);
 
        $password_input = $f->optionalGroup(
            $sub_inputs_password,
            $lng->txt('tst_password'),
            $lng->txt('tst_password_details')
        )->withValue(null)
            ->withAdditionalTransformation($trafo);
 
        if (!$this->getPasswordEnabled()) {
            return $password_input;
        }
 
        return $password_input->withValue(
            ['password_value' => $this->getPassword()]
        );
    }

getIpRangeFrom()

ILIAS\Test\Settings\MainSettings\SettingsAccess::getIpRangeFrom

(

)

Definition at line 350 of file SettingsAccess.php.

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

getIpRangeTo()

ILIAS\Test\Settings\MainSettings\SettingsAccess::getIpRangeTo

(

)

Definition at line 361 of file SettingsAccess.php.

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

getPassword()

ILIAS\Test\Settings\MainSettings\SettingsAccess::getPassword

(

)

Definition at line 339 of file SettingsAccess.php.

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

getPasswordEnabled()

ILIAS\Test\Settings\MainSettings\SettingsAccess::getPasswordEnabled

(

)

Definition at line 328 of file SettingsAccess.php.

                                        : bool
    {
        return $this->password_enabled;
    }

getStartTime()

ILIAS\Test\Settings\MainSettings\SettingsAccess::getStartTime

(

)

Definition at line 295 of file SettingsAccess.php.

                                  : ?\DateTimeImmutable
    {
        return $this->start_time;
    }

getStartTimeEnabled()

ILIAS\Test\Settings\MainSettings\SettingsAccess::getStartTimeEnabled

(

)

Definition at line 284 of file SettingsAccess.php.

                                         : bool
    {
        return $this->start_time_enabled;
    }

getSubInputsAccessWindow()

ILIAS\Test\Settings\MainSettings\SettingsAccess::getSubInputsAccessWindow ( \ilLanguage  $lng, FieldFactory  $f, array  $environment  )

private

Definition at line 97 of file SettingsAccess.php.

     : array {
        $sub_inputs_access_window['start_time'] = $f->dateTime(
            $lng->txt('tst_starting_time'),
            $lng->txt('tst_starting_time_desc')
        )->withTimezone($environment['user_time_zone'])
            ->withFormat($environment['user_date_format'])
            ->withUseTime(true);
        if ($this->getStartTime() !== null) {
            $sub_inputs_access_window['start_time'] = $sub_inputs_access_window['start_time']
                ->withValue($this->getStartTime()->setTimezone(new \DateTimeZone($environment['user_time_zone'])));
        }
        if ($environment['participant_data_exists']) {
            $sub_inputs_access_window['start_time'] = $sub_inputs_access_window['start_time']->withDisabled(true);
        }
 
        $sub_inputs_access_window['end_time'] = $f->dateTime(
            $lng->txt('tst_ending_time'),
            $lng->txt('tst_ending_time_desc')
        )->withTimezone($environment['user_time_zone'])
            ->withFormat($environment['user_date_format'])
            ->withUseTime(true);
        if ($this->getEndTime() !== null) {
            $sub_inputs_access_window['end_time'] = $sub_inputs_access_window['end_time']
                ->withValue($this->getEndTime()->setTimezone(new \DateTimeZone($environment['user_time_zone'])));
        }
 
        return $sub_inputs_access_window;
    }

isIpRangeEnabled()

ILIAS\Test\Settings\MainSettings\SettingsAccess::isIpRangeEnabled

(

)

Definition at line 372 of file SettingsAccess.php.

                                      : ?bool
    {
        return $this->ip_range_from !== null && $this->ip_range_to !== null;
    }

toExport()

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

                              : array
    {
        return [
            'starting_time_enabled' => $this->getStartTimeEnabled(),
            'starting_time' => $this->getStartTime()?->format(\DateTimeInterface::ATOM),
            'ending_time_enabled' => $this->getEndTimeEnabled(),
            'ending_time' => $this->getEndTime()?->format(\DateTimeInterface::ATOM),
            'password_enabled' => $this->getPasswordEnabled(),
            'password' => $this->getPassword(),
            'ip_range_from' => $this->getIpRangeFrom(),
            'ip_range_to' => $this->getIpRangeTo(),
            'fixed_participants' => $this->getFixedParticipants()
        ];
    }

toForm()

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

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 50 of file SettingsAccess.php.

     : FormInput {
        $inputs['access_window'] = $this->getInputAccessWindow($lng, $f, $refinery, $environment);
        $inputs['test_password'] = $this->getInputPassword($lng, $f, $refinery);
        $inputs['ip_range'] = $this->getInputIpRange($lng, $f, $refinery);
 
        $inputs['fixed_participants_enabled'] = $f->checkbox(
            $lng->txt('participants_invitation'),
            $lng->txt('participants_invitation_description')
        )->withValue($this->getFixedParticipants());
        if ($environment['participant_data_exists']) {
            $inputs['fixed_participants_enabled'] = $inputs['fixed_participants_enabled']
                ->withDisabled(true);
        }
 
        return $f->section($inputs, $lng->txt('tst_settings_header_execution'));
    }

toLog()

ILIAS\Test\Settings\MainSettings\SettingsAccess::toLog

(

AdditionalInformationGenerator

$additional_info

)

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 260 of file SettingsAccess.php.

                                                                          : array
    {
        $starting_time = $additional_info->getNoneTag();
        if (($st_immutable = $this->getStartTime()) instanceof \DateTimeImmutable) {
            $starting_time = $st_immutable->format(AdditionalInformationGenerator::DATE_STORAGE_FORMAT);
        }
 
        $end_time = $additional_info->getNoneTag();
        if (($et_immutable = $this->getEndTime()) instanceof \DateTimeImmutable) {
            $end_time = $et_immutable->format(AdditionalInformationGenerator::DATE_STORAGE_FORMAT);
        }
 
        return [
            AdditionalInformationGenerator::KEY_TEST_START_TIME => $starting_time,
            AdditionalInformationGenerator::KEY_TEST_END_TIME => $end_time,
            AdditionalInformationGenerator::KEY_TEST_PASSWORD => $this->getPassword() ?? $additional_info->getNoneTag(),
            AdditionalInformationGenerator::KEY_TEST_IP_RANGE => $this->isIpRangeEnabled()
                ? $this->getIpRangeFrom() . ' - ' . $this->getIpRangeTo()
                : $additional_info->getEnabledDisabledTagForBool(false),
            AdditionalInformationGenerator::KEY_TEST_FIXED_PARTICIPANTS => $additional_info
                ->getEnabledDisabledTagForBool($this->getFixedParticipants())
        ];
    }

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

Here is the call graph for this function:

toStorage()

ILIAS\Test\Settings\MainSettings\SettingsAccess::toStorage

(

)

Reimplemented from ILIAS\Test\Settings\TestSettings.

Definition at line 245 of file SettingsAccess.php.

                               : array
    {
        return [
            'starting_time_enabled' => ['integer', (int) $this->getStartTimeEnabled()],
            'starting_time' => ['integer', $this->getStartTime() !== null ? $this->getStartTime()->getTimestamp() : 0],
            'ending_time_enabled' => ['integer', (int) $this->getEndTimeEnabled()],
            'ending_time' => ['integer', $this->getEndTime() !== null ? $this->getEndTime()->getTimestamp() : 0],
            'password_enabled' => ['integer', (int) $this->getPasswordEnabled()],
            'password' => ['text', $this->getPassword()],
            'ip_range_from' => ['text', $this->getIpRangeFrom()],
            'ip_range_to' => ['text', $this->getIpRangeTo()],
            'fixed_participants' => ['integer', (int) $this->getFixedParticipants()]
        ];
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

withEndTime()

ILIAS\Test\Settings\MainSettings\SettingsAccess::withEndTime

(

?\DateTimeImmutable

$end_time

)

Definition at line 321 of file SettingsAccess.php.

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

withEndTimeEnabled()

ILIAS\Test\Settings\MainSettings\SettingsAccess::withEndTimeEnabled

(

bool

$end_time_enabled

)

Definition at line 310 of file SettingsAccess.php.

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

withFixedParticipants()

ILIAS\Test\Settings\MainSettings\SettingsAccess::withFixedParticipants

(

bool

$fixed_participants

)

Definition at line 381 of file SettingsAccess.php.

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

withIpRangeFrom()

ILIAS\Test\Settings\MainSettings\SettingsAccess::withIpRangeFrom

(

?string

$ip_range_from

)

Definition at line 354 of file SettingsAccess.php.

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

withIpRangeTo()

ILIAS\Test\Settings\MainSettings\SettingsAccess::withIpRangeTo

(

?string

$ip_range_to

)

Definition at line 365 of file SettingsAccess.php.

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

withPassword()

ILIAS\Test\Settings\MainSettings\SettingsAccess::withPassword

(

?string

$password

)

Definition at line 343 of file SettingsAccess.php.

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

withPasswordEnabled()

ILIAS\Test\Settings\MainSettings\SettingsAccess::withPasswordEnabled

(

bool

$password_enabled

)

Definition at line 332 of file SettingsAccess.php.

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

withStartTime()

ILIAS\Test\Settings\MainSettings\SettingsAccess::withStartTime

(

?\DateTimeImmutable

$start_time

)

Definition at line 299 of file SettingsAccess.php.

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

withStartTimeEnabled()

ILIAS\Test\Settings\MainSettings\SettingsAccess::withStartTimeEnabled

(

bool

$start_time_enabled

)

Definition at line 288 of file SettingsAccess.php.

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

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

Here is the caller graph for this function:

Field Documentation

MAX_PASSWORD_LENGTH

const ILIAS\Test\Settings\MainSettings\SettingsAccess::MAX_PASSWORD_LENGTH = 20

private

Definition at line 34 of file SettingsAccess.php.

---

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

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