ILIAS\User\Settings\Repository Class Reference

Collaboration diagram for ILIAS\User\Settings\Repository:

Public Member Functions
	__construct (private readonly \ilSetting $settings, private readonly array $available_user_settings)
	get ()
	getByIdentifier (string $identifier)
	getByDefinitionClass (string $class)
	storeConfiguration (Setting $setting)

Private Member Functions
	buildSettingFromDefinition (SettingDefinition $definition)
	updateLegacyValues (SettingDefinition $definition)
	retrieveConfigurationValue (string $prefix, string $identifier)
	storeConfigurationValue (string $prefix, string $identifier, bool $value)

Detailed Description

Definition at line 25 of file Repository.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Settings\Repository::__construct	(	private readonly \ilSetting	$settings,
		private readonly array	$available_user_settings
	)

Definition at line 27 of file Repository.php.

      {
    }

Member Function Documentation

buildSettingFromDefinition()

ILIAS\User\Settings\Repository::buildSettingFromDefinition ( SettingDefinition  $definition )

private

Definition at line 87 of file Repository.php.

     : Setting {
        $this->updateLegacyValues($definition);
        return new Setting(
            $definition,
            $this->retrieveConfigurationValue(
                PropertyAttributes::ChangeableByUser->getSettingsAccessPrefix(),
                $definition->getIdentifier()
            ),
            $this->retrieveConfigurationValue(
                PropertyAttributes::ChangeableInLocalUserAdministration->getSettingsAccessPrefix(),
                $definition->getIdentifier()
            ),
            $this->retrieveConfigurationValue(
                PropertyAttributes::Export->getSettingsAccessPrefix(),
                $definition->getIdentifier()
            ),
        );
    }

Referenced by ILIAS\User\Settings\Repository\get(), ILIAS\User\Settings\Repository\getByDefinitionClass(), and ILIAS\User\Settings\Repository\getByIdentifier().

Here is the caller graph for this function:

get()

ILIAS\User\Settings\Repository::get

(

)

Definition at line 33 of file Repository.php.

                         : array
    {
        return array_reduce(
            $this->available_user_settings,
            function (array $c, string $v): array {
                $definition = new $v();
                if (!$definition->isAvailable()) {
                    return $c;
                }
                $c[] = $this->buildSettingFromDefinition($definition);
                return $c;
            },
            []
        );
    }

References $c, and ILIAS\User\Settings\Repository\buildSettingFromDefinition().

Here is the call graph for this function:

getByDefinitionClass()

ILIAS\User\Settings\Repository::getByDefinitionClass

(

string

$class

)

Definition at line 60 of file Repository.php.

                                                       : ?Setting
    {
        if (!in_array($class, $this->available_user_settings)) {
            return null;
        }
        return $this->buildSettingFromDefinition(new $class());
    }

References ILIAS\User\Settings\Repository\buildSettingFromDefinition().

Here is the call graph for this function:

getByIdentifier()

ILIAS\User\Settings\Repository::getByIdentifier

(

string

$identifier

)

Definition at line 49 of file Repository.php.

                                                       : ?Setting
    {
        foreach ($this->available_user_settings as $setting) {
            $definition = new $setting();
            if ($definition->getIdentifier() === $identifier) {
                return $this->buildSettingFromDefinition($definition);
            }
        }
        return null;
    }

References ILIAS\$setting, and ILIAS\User\Settings\Repository\buildSettingFromDefinition().

Here is the call graph for this function:

retrieveConfigurationValue()

ILIAS\User\Settings\Repository::retrieveConfigurationValue ( string  $prefix, string  $identifier  )

private

Definition at line 128 of file Repository.php.

     : bool {
        return $this->settings->get("{$prefix}_{$identifier}", '0') === '1';
    }

storeConfiguration()

ILIAS\User\Settings\Repository::storeConfiguration

(

Setting

$setting

)

Definition at line 68 of file Repository.php.

                                                        : void
    {
        $this->storeConfigurationValue(
            PropertyAttributes::ChangeableByUser->getSettingsAccessPrefix(),
            $setting->getIdentifier(),
            $setting->isChangeableByUser()
        );
        $this->storeConfigurationValue(
            PropertyAttributes::ChangeableInLocalUserAdministration->getSettingsAccessPrefix(),
            $setting->getIdentifier(),
            $setting->isChangeableInLocalUserAdministration()
        );
        $this->storeConfigurationValue(
            PropertyAttributes::Export->getSettingsAccessPrefix(),
            $setting->getIdentifier(),
            $setting->export()
        );
    }

References ILIAS\$setting, ILIAS\User\getSettingsAccessPrefix, and ILIAS\User\Settings\Repository\storeConfigurationValue().

Here is the call graph for this function:

storeConfigurationValue()

ILIAS\User\Settings\Repository::storeConfigurationValue ( string  $prefix, string  $identifier, bool  $value  )

private

Definition at line 135 of file Repository.php.

     : void {
        $this->settings->set("{$prefix}_{$identifier}", $value ? '1' : '0');
    }

Referenced by ILIAS\User\Settings\Repository\storeConfiguration().

Here is the caller graph for this function:

updateLegacyValues()

ILIAS\User\Settings\Repository::updateLegacyValues ( SettingDefinition  $definition )

private

Todo:

: Remove with ILIAS 12

Definition at line 111 of file Repository.php.

                                                                      : void
    {
        if ($this->settings->get(
            PropertyAttributes::ChangeableByUser->getSettingsAccessPrefix() . "_{$definition->getIdentifier()}"
        ) !== null) {
            return;
        }
 
        $legacy_disabled_value = $this->settings->get("usr_settings_disable_{$definition->getIdentifier()}", '0');
        $this->settings->delete("usr_settings_disable_{$definition->getIdentifier()}");
        $this->storeConfigurationValue(
            PropertyAttributes::ChangeableByUser->getSettingsAccessPrefix(),
            $definition->getIdentifier(),
            $legacy_disabled_value !== '1'
        );
    }

References ILIAS\User\Property\getIdentifier(), ILIAS\User\getSettingsAccessPrefix, and ILIAS\Repository\settings().

Here is the call graph for this function:

---

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

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