ILIAS\User\Settings\Setting Class Reference

Inheritance diagram for ILIAS\User\Settings\Setting:

Collaboration diagram for ILIAS\User\Settings\Setting:

Public Member Functions
	__construct (private SettingDefinition $definition, private bool $changeable_by_user, private bool $changeable_in_local_user_administration, private bool $export)
	getIdentifier ()
	getLabel (Language $lng)
	isChangeableByUser ()
	isChangeableInLocalUserAdministration ()
	export ()
	getSettingsPage ()
	getSection ()
	getTableRow (DataRowBuilder $row_builder, Language $lng)
	getInput (FieldFactory $field_factory, Language $lng, Refinery $refinery, \ilSetting $settings, ?\ilObjUser $user=null)
	getLegacyInput (Language $lng, \ilSetting $settings, ?\ilObjUser $user=null)
	getForm (Language $lng, FieldFactory $ff, Refinery $refinery)
	getDefaultValueForDisplay (Language $lng, \ilSetting $settings)
	hasUserPersonalizedSetting (\ilSetting $settings, ?\ilObjUser $user)
	persistUserInput (\ilObjUser $user, Context $context, mixed $input, ?\ilPropertyFormGUI $form=null)
	retrieveValueFromUser (\ilObjUser $user)
	validateUserChoice (\ilGlobalTemplateInterface $tpl, Language $lng, \ilPropertyFormGUI $form)
	getIdentifier ()
	getLabel (Language $lng)
	getSection ()
	retrieveValueFromUser (\ilObjUser $user)

Private Member Functions
	buildCreateSettingTransformation (Refinery $refinery)

Detailed Description

Definition at line 34 of file Setting.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Settings\Setting::__construct	(	private SettingDefinition	$definition,
		private bool	$changeable_by_user,
		private bool	$changeable_in_local_user_administration,
		private bool	$export
	)

Definition at line 36 of file Setting.php.

      {
    }

Member Function Documentation

buildCreateSettingTransformation()

ILIAS\User\Settings\Setting::buildCreateSettingTransformation ( Refinery  $refinery )

private

Definition at line 190 of file Setting.php.

     : Transformation {
        return $refinery->custom()->transformation(
            function (array $vs): self {
                $clone = clone $this;
                $clone->changeable_by_user = $vs['changeable_by_user'];
                $clone->changeable_in_local_user_administration = $vs['changeable_in_local_user_administration'];
                $clone->export = $vs['export'];
                return $clone;
            }
        );
    }

export()

ILIAS\User\Settings\Setting::export

(

)

Definition at line 64 of file Setting.php.

                            : bool
    {
        return $this->export;
    }

Referenced by ILIAS\User\Settings\ConfigurationGUI\sortRows().

Here is the caller graph for this function:

getDefaultValueForDisplay()

ILIAS\User\Settings\Setting::getDefaultValueForDisplay	(	Language	$lng,
		\ilSetting	$settings
	)

Definition at line 144 of file Setting.php.

     : string {
        $default_value = $this->definition->getDefaultValueForDisplay($lng, $settings);
        if ($default_value === null) {
            return '';
        }
        return $default_value;
    }

getForm()

ILIAS\User\Settings\Setting::getForm	(	Language	$lng,
		FieldFactory	$ff,
		Refinery	$refinery
	)

Returns

array<string, Input>

Definition at line 122 of file Setting.php.

     : array {
        return [
            'setting' => $ff->group([
                'changeable_by_user' => $ff->checkbox($lng->txt(
                    PropertyAttributes::ChangeableByUser->value
                ))->withValue($this->changeable_by_user),
                'changeable_in_local_user_administration' => $ff->checkbox($lng->txt(
                    PropertyAttributes::ChangeableInLocalUserAdministration->value
                ))->withValue($this->changeable_in_local_user_administration),
                'export' => $ff->checkbox($lng->txt(
                    PropertyAttributes::Export->value
                ))->withValue($this->export),
            ])->withAdditionalTransformation(
                $this->buildCreateSettingTransformation($refinery)
            )
        ];
    }

getIdentifier()

ILIAS\User\Settings\Setting::getIdentifier

(

)

Implements ILIAS\User\Property.

Definition at line 44 of file Setting.php.

                                   : string
    {
        return $this->definition->getIdentifier();
    }

Referenced by ILIAS\User\Settings\SettingsImplementation\addAdditionalInputsToLegacyForm(), and ILIAS\User\Settings\SettingsImplementation\retrieveValueFromInputs().

Here is the caller graph for this function:

getInput()

ILIAS\User\Settings\Setting::getInput	(	FieldFactory	$field_factory,
		Language	$lng,
		Refinery	$refinery,
		\ilSetting	$settings,
		?\ilObjUser	$user = null
	)

Definition at line 94 of file Setting.php.

     : Input {
        return $this->definition->getInput($field_factory, $lng, $refinery, $settings, $user);
    }

getLabel()

ILIAS\User\Settings\Setting::getLabel

(

Language

$lng

)

Implements ILIAS\User\Property.

Definition at line 49 of file Setting.php.

                                           : string
    {
        return $this->definition->getLabel($lng);
    }

References $lng.

Referenced by ILIAS\User\Settings\ConfigurationGUI\sortRows().

Here is the caller graph for this function:

getLegacyInput()

ILIAS\User\Settings\Setting::getLegacyInput	(	Language	$lng,
		\ilSetting	$settings,
		?\ilObjUser	$user = null
	)

Definition at line 104 of file Setting.php.

     : \ilFormPropertyGUI {
        $input = $this->definition->getLegacyInput(
            $lng,
            $settings,
            $user
        );
 
        $input->setPostVar($this->definition->getIdentifier());
        return $input;
    }

Referenced by ILIAS\User\Settings\SettingsImplementation\addAdditionalInputsToLegacyForm().

Here is the caller graph for this function:

getSection()

ILIAS\User\Settings\Setting::getSection

(

)

Implements ILIAS\User\Property.

Definition at line 74 of file Setting.php.

                                : AvailableSections
    {
        return $this->definition->getSection();
    }

Referenced by ILIAS\User\Settings\SettingsImplementation\buildSectionKey().

Here is the caller graph for this function:

getSettingsPage()

ILIAS\User\Settings\Setting::getSettingsPage

(

)

Definition at line 69 of file Setting.php.

                                     : AvailablePages
    {
        return $this->definition->getSettingsPage();
    }

Referenced by ILIAS\User\Settings\SettingsImplementation\buildSectionKey().

Here is the caller graph for this function:

getTableRow()

ILIAS\User\Settings\Setting::getTableRow	(	DataRowBuilder	$row_builder,
		Language	$lng
	)

Definition at line 79 of file Setting.php.

     : DataRow {
        return $row_builder->buildDataRow(
            $this->definition->getIdentifier(),
            [
                'field' => $this->definition->getLabel($lng),
                'changeable_by_user' => $this->changeable_by_user,
                'changeable_in_local_user_administration' => $this->changeable_in_local_user_administration,
                'export' => $this->export
            ]
        );
    }

hasUserPersonalizedSetting()

ILIAS\User\Settings\Setting::hasUserPersonalizedSetting	(	\ilSetting	$settings,
		?\ilObjUser	$user
	)

Definition at line 155 of file Setting.php.

     : bool {
        if ($user === null) {
            return false;
        }
        return $this->definition->hasUserPersonalizedSetting($settings, $user);
    }

Referenced by ILIAS\User\Settings\SettingsImplementation\addAdditionalInputsToLegacyForm().

Here is the caller graph for this function:

isChangeableByUser()

ILIAS\User\Settings\Setting::isChangeableByUser

(

)

Definition at line 54 of file Setting.php.

                                        : bool
    {
        return $this->changeable_by_user;
    }

Referenced by ILIAS\User\Settings\ConfigurationGUI\sortRows().

Here is the caller graph for this function:

isChangeableInLocalUserAdministration()

ILIAS\User\Settings\Setting::isChangeableInLocalUserAdministration

(

)

Definition at line 59 of file Setting.php.

                                                           : bool
    {
        return $this->changeable_in_local_user_administration;
    }

Referenced by ILIAS\User\Settings\ConfigurationGUI\sortRows().

Here is the caller graph for this function:

persistUserInput()

ILIAS\User\Settings\Setting::persistUserInput	(	\ilObjUser	$user,
		Context	$context,
		mixed	$input,
		?\ilPropertyFormGUI	$form = null
	)

Definition at line 165 of file Setting.php.

     : \ilObjUser {
        if (!$context->isSettingAvailable($this)) {
            throw new \DomainException('It is not possible to Change this from here!');
        }
        return $this->definition->persistUserInput($user, $input, $form);
    }

retrieveValueFromUser()

ILIAS\User\Settings\Setting::retrieveValueFromUser

(

\ilObjUser

$user

)

Implements ILIAS\User\Property.

Definition at line 177 of file Setting.php.

                                                           : mixed
    {
        return $this->definition->retrieveValueFromUser($user);
    }

validateUserChoice()

ILIAS\User\Settings\Setting::validateUserChoice	(	\ilGlobalTemplateInterface	$tpl,
		Language	$lng,
		\ilPropertyFormGUI	$form
	)

Definition at line 182 of file Setting.php.

     : ?bool {
        return $this->definition->validateUserChoice($tpl, $lng, $form);
    }

---

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

• components/ILIAS/User/src/Settings/Setting.php