ilObjTestSettingsAccess Class Reference

Inheritance diagram for ilObjTestSettingsAccess:

Collaboration diagram for ilObjTestSettingsAccess:

Public Member Functions
	__construct (int $test_id, 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 bool $fixed_participants=false,)
	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, array $environment=null)
	toStorage ()
	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)
	getFixedParticipants ()
	withFixedParticipants (bool $fixed_participants)
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
	getInputAccessWindow (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, array $environment=null)
	getSubInputsAccessWindow (\ilLanguage $lng, FieldFactory $f, array $environment)
	getInputPassword (\ilLanguage $lng, FieldFactory $f, Refinery $refinery)

Private Attributes
const	MAX_PASSWORD_LENGTH = 20

Additional Inherited Members
Protected Attributes inherited from TestSettings
int	$test_id

Detailed Description

Definition at line 28 of file ilObjTestSettingsAccess.php.

Constructor & Destructor Documentation

__construct()

ilObjTestSettingsAccess::__construct	(	int	$test_id,
		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 bool	$fixed_participants = false
	)

Definition at line 32 of file ilObjTestSettingsAccess.php.

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

      {
        parent::__construct($test_id);
    }

Here is the call graph for this function:

Member Function Documentation

getEndTime()

ilObjTestSettingsAccess::getEndTime

(

)

Definition at line 208 of file ilObjTestSettingsAccess.php.

Referenced by getSubInputsAccessWindow(), and toStorage().

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

Here is the caller graph for this function:

getEndTimeEnabled()

ilObjTestSettingsAccess::getEndTimeEnabled

(

)

Definition at line 197 of file ilObjTestSettingsAccess.php.

Referenced by toStorage().

                                       : bool
    {
        return $this->end_time_enabled;
    }

Here is the caller graph for this function:

getFixedParticipants()

ilObjTestSettingsAccess::getFixedParticipants

(

)

Definition at line 241 of file ilObjTestSettingsAccess.php.

Referenced by toForm(), and toStorage().

                                          : bool
    {
        return $this->fixed_participants;
    }

Here is the caller graph for this function:

getInputAccessWindow()

ilObjTestSettingsAccess::getInputAccessWindow ( \ilLanguage  $lng, FieldFactory  $f, Refinery  $refinery, array  $environment = null  )

private

Definition at line 66 of file ilObjTestSettingsAccess.php.

References getSubInputsAccessWindow(), and ilLanguage\txt().

Referenced by toForm().

     : 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInputPassword()

ilObjTestSettingsAccess::getInputPassword ( \ilLanguage  $lng, FieldFactory  $f, Refinery  $refinery  )

private

Definition at line 124 of file ilObjTestSettingsAccess.php.

References getPassword(), getPasswordEnabled(), ilLanguage\txt(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by toForm().

     : 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()]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPassword()

ilObjTestSettingsAccess::getPassword

(

)

Definition at line 230 of file ilObjTestSettingsAccess.php.

Referenced by getInputPassword(), and toStorage().

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

Here is the caller graph for this function:

getPasswordEnabled()

ilObjTestSettingsAccess::getPasswordEnabled

(

)

Definition at line 219 of file ilObjTestSettingsAccess.php.

Referenced by getInputPassword(), and toStorage().

                                        : bool
    {
        return $this->password_enabled;
    }

Here is the caller graph for this function:

getStartTime()

ilObjTestSettingsAccess::getStartTime

(

)

Definition at line 186 of file ilObjTestSettingsAccess.php.

Referenced by getSubInputsAccessWindow(), and toStorage().

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

Here is the caller graph for this function:

getStartTimeEnabled()

ilObjTestSettingsAccess::getStartTimeEnabled

(

)

Definition at line 175 of file ilObjTestSettingsAccess.php.

Referenced by toStorage().

                                         : bool
    {
        return $this->start_time_enabled;
    }

Here is the caller graph for this function:

getSubInputsAccessWindow()

ilObjTestSettingsAccess::getSubInputsAccessWindow ( \ilLanguage  $lng, FieldFactory  $f, array  $environment  )

private

Definition at line 91 of file ilObjTestSettingsAccess.php.

References getEndTime(), getStartTime(), and ilLanguage\txt().

Referenced by getInputAccessWindow().

     : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

toForm()

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

Definition at line 45 of file ilObjTestSettingsAccess.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, getFixedParticipants(), getInputAccessWindow(), getInputPassword(), ilLanguage\txt(), and ILIAS\UI\Implementation\Component\Input\withValue().

     : FormInput {
        $inputs['access_window'] = $this->getInputAccessWindow($lng, $f, $refinery, $environment);
        $inputs['test_password'] = $this->getInputPassword($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'));
    }

Here is the call graph for this function:

toStorage()

ilObjTestSettingsAccess::toStorage

(

)

Definition at line 162 of file ilObjTestSettingsAccess.php.

References getEndTime(), getEndTimeEnabled(), getFixedParticipants(), getPassword(), getPasswordEnabled(), getStartTime(), getStartTimeEnabled(), and ILIAS\Repository\int().

                               : 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()],
            'fixed_participants' => ['integer', (int) $this->getFixedParticipants()]
        ];
    }

Here is the call graph for this function:

withEndTime()

ilObjTestSettingsAccess::withEndTime

(

?DateTimeImmutable

$end_time

)

Definition at line 212 of file ilObjTestSettingsAccess.php.

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

withEndTimeEnabled()

ilObjTestSettingsAccess::withEndTimeEnabled

(

bool

$end_time_enabled

)

Definition at line 201 of file ilObjTestSettingsAccess.php.

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

withFixedParticipants()

ilObjTestSettingsAccess::withFixedParticipants

(

bool

$fixed_participants

)

Definition at line 245 of file ilObjTestSettingsAccess.php.

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

withPassword()

ilObjTestSettingsAccess::withPassword

(

?string

$password

)

Definition at line 234 of file ilObjTestSettingsAccess.php.

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

withPasswordEnabled()

ilObjTestSettingsAccess::withPasswordEnabled

(

bool

$password_enabled

)

Definition at line 223 of file ilObjTestSettingsAccess.php.

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

withStartTime()

ilObjTestSettingsAccess::withStartTime

(

?DateTimeImmutable

$start_time

)

Definition at line 190 of file ilObjTestSettingsAccess.php.

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

withStartTimeEnabled()

ilObjTestSettingsAccess::withStartTimeEnabled

(

bool

$start_time_enabled

)

Definition at line 179 of file ilObjTestSettingsAccess.php.

Referenced by ilObjTestSettingsMainGUI\getAccessSettingsForStorage().

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

Here is the caller graph for this function:

Field Documentation

MAX_PASSWORD_LENGTH

const ilObjTestSettingsAccess::MAX_PASSWORD_LENGTH = 20

private

Definition at line 30 of file ilObjTestSettingsAccess.php.

---

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

• Modules/Test/classes/MainSettings/ilObjTestSettingsAccess.php