ILIAS\User\Settings\SettingsImplementation Class Reference

Inheritance diagram for ILIAS\User\Settings\SettingsImplementation:

Collaboration diagram for ILIAS\User\Settings\SettingsImplementation:

Public Member Functions
	__construct (private readonly Language $lng, private readonly \ilSetting $settings, private readonly \ilGlobalTemplateInterface $tpl, private readonly UIFactory $ui_factory, private readonly Refinery $refinery, private readonly Repository $user_settings_repository)
	buildFormInputs (array $pages, Context $context, ?\ilObjUser $user)
	addSectionsToLegacyForm (\ilPropertyFormGUI $form, array $pages, Context $context, ?\ilObjUser $user)
	performAdditionalChecks (\ilPropertyFormGUI $form)
	saveForm (\ilPropertyFormGUI|array $form, array $pages, Context $context, \ilObjUser $user)
	If it is possible to set the preference on the user, this is what will be done, the user needs to be updated/stored after calling this function. More...
	getSettingByDefinitionClass (string $definition_class)
	getValueFromLegacyFormByDefinitionClass (string $definition_class, \ilPropertyFormGUI $form)
	settingAvailableToUser (string $definition_class)
	getSettingByDefinitionClass (string $definition_class)
	getValueFromLegacyFormByDefinitionClass (string $definition_class, \ilPropertyFormGUI $form)
	settingAvailableToUser (string $definition_class)

Private Member Functions
	getSettingsForPagesBySections (array $pages)
	reorderSections (array $sections)
	buildInputsForSection (array $settings, ?\ilObjUser $user)
	addSectionToLegacyForm (\ilPropertyFormGUI $form, ?\ilObjUser $user, array $section)
	addDefaultInputsToLegacyForm (\ilPropertyFormGUI $form, ?\ilObjUser $user, array $section)
	addAdditionalInputsToLegacyForm (\ilPropertyFormGUI $form, ?\ilObjUser $user, array $section)
	buildSectionKey (Setting $setting)
	filterSettingsInSectionForAvailability (Context $context, array $settings)
	retrieveValuefromInputs (\ilPropertyFormGUI|array $form, Setting $setting)
	checkStartingPointValue (\ilPropertyFormGUI $form)

Detailed Description

Definition at line 28 of file SettingsImplementation.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Settings\SettingsImplementation::__construct	(	private readonly Language	$lng,
		private readonly \ilSetting	$settings,
		private readonly \ilGlobalTemplateInterface	$tpl,
		private readonly UIFactory	$ui_factory,
		private readonly Refinery	$refinery,
		private readonly Repository	$user_settings_repository
	)

Definition at line 30 of file SettingsImplementation.php.

      {
    }

Member Function Documentation

addAdditionalInputsToLegacyForm()

ILIAS\User\Settings\SettingsImplementation::addAdditionalInputsToLegacyForm ( \ilPropertyFormGUI  $form, ?\ilObjUser  $user, array  $section  )

private

Definition at line 283 of file SettingsImplementation.php.

     : \ilPropertyFormGUI {
        $section_key = $this->buildSectionKey($section[0]);
        $values = array_reduce(
            $section,
            function (array $c, Setting $v) use ($user): array {
                $input = $v->getLegacyInput($this->lng, $this->settings, $user);
                $input->setPostVar($v->getIdentifier());
                $c['checkbox']->addSubItem($input);
                $c['defaults'] .= "{$v->getLabel($this->lng)}: "
                    . "{$v->getDefaultValueForDisplay($this->lng, $this->settings)}; ";
                if ($v->hasUserPersonalizedSetting($this->settings, $user)) {
                    $c['has_personalization'] = true;
                }
                return $c;
            },
            [
                'checkbox' => new \ilCheckboxInputGUI(
                    $this->lng->txt("personalise_{$section_key}"),
                    $section_key
                ),
                'defaults' => "{$this->lng->txt('default')}<br>",
                'has_personalization' => false
            ]
        );
        $values['checkbox']->setInfo(trim($values['defaults']));
        $values['checkbox']->setChecked($values['has_personalization']);
 
        $form->addItem($values['checkbox']);
 
        return $form;
    }

References $c, ILIAS\User\Settings\Setting\getIdentifier(), ILIAS\User\Settings\Setting\getLegacyInput(), ILIAS\User\Settings\Setting\hasUserPersonalizedSetting(), if, ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Here is the call graph for this function:

addDefaultInputsToLegacyForm()

ILIAS\User\Settings\SettingsImplementation::addDefaultInputsToLegacyForm ( \ilPropertyFormGUI  $form, ?\ilObjUser  $user, array  $section  )

private

Definition at line 267 of file SettingsImplementation.php.

     : \ilPropertyFormGUI {
        return array_reduce(
            $section,
            function (\ilPropertyFormGUI $c, Setting $v) use ($user): \ilPropertyFormGUI {
                $input = $v->getLegacyInput($this->lng, $this->settings, $user);
                $c->addItem($input);
                return $c;
            },
            $form
        );
    }

addSectionsToLegacyForm()

ILIAS\User\Settings\SettingsImplementation::addSectionsToLegacyForm	(	\ilPropertyFormGUI	$form,
		array	$pages,
		Context	$context,
		?\ilObjUser	$user
	)

Parameters

array<ILIAS

User\Settings\AvailablePages> $pages

Definition at line 89 of file SettingsImplementation.php.

     : \ilPropertyFormGUI {
        return array_reduce(
            $this->getSettingsForPagesBySections($pages),
            fn(\ilPropertyFormGUI $c, array $v): \ilPropertyFormGUI => $this->addSectionToLegacyForm(
                $c,
                $user,
                $this->filterSettingsInSectionForAvailability($context, $v)
            ),
            $form
        );
    }

addSectionToLegacyForm()

ILIAS\User\Settings\SettingsImplementation::addSectionToLegacyForm ( \ilPropertyFormGUI  $form, ?\ilObjUser  $user, array  $section  )

private

Definition at line 250 of file SettingsImplementation.php.

     : \ilPropertyFormGUI {
        if ($section === []) {
            return $form;
        }
 
        if ($section[0]->getSettingsPage() === AvailablePages::MainSettings
            && $section[0]->getSection() === AvailableSections::Main) {
            return $this->addDefaultInputsToLegacyForm($form, $user, $section);
        }
 
        return $this->addAdditionalInputsToLegacyForm($form, $user, $section);
    }

buildFormInputs()

ILIAS\User\Settings\SettingsImplementation::buildFormInputs	(	array	$pages,
		Context	$context,
		?\ilObjUser	$user
	)

Parameters

array<ILIAS

User\Settings\AvailablePages> $pages

Definition at line 43 of file SettingsImplementation.php.

     : array {
        return array_reduce(
            $this->getSettingsForPagesBySections($pages),
            function (array $c, array $v) use ($pages, $context, $user): array {
                $settings = $this->filterSettingsInSectionForAvailability($context, $v);
                if ($settings === []) {
                    return $c;
                }
 
                $page = $settings[0]->getSettingsPage();
                $section = $settings[0]->getSection();
                $section_key = $this->buildSectionKey($settings[0]);
 
                ['inputs' => $inputs, 'byline' => $byline, 'personalized' => $personalized] = $this->buildInputsForSection(
                    $settings,
                    $user
                );
 
                if (!in_array(AvailablePages::MainSettings, $pages)
                    || $page === AvailablePages::MainSettings && $section === AvailableSections::Main) {
                    return $c + $inputs;
                }
 
                $c[$section_key] = $this->ui_factory->input()->field()->optionalGroup(
                    $inputs,
                    $this->lng->txt("personalise_{$section_key}"),
                    $byline
                );
 
                if (!$personalized) {
                    $c[$section_key] = $c[$section_key]->withValue(null);
                }
 
                return $c;
            },
            []
        );
    }

References $c.

buildInputsForSection()

ILIAS\User\Settings\SettingsImplementation::buildInputsForSection ( array  $settings, ?\ilObjUser  $user  )

private

Definition at line 221 of file SettingsImplementation.php.

     : array {
        return array_reduce(
            $settings,
            function (array $c, Setting $v) use ($user): array {
                $c['inputs'][$v->getIdentifier()] = $v->getInput(
                    $this->ui_factory->input()->field(),
                    $this->lng,
                    $this->refinery,
                    $this->settings,
                    $user
                );
                $c['byline'] .= "{$v->getLabel($this->lng)}: "
                    . "{$v->getDefaultValueForDisplay($this->lng, $this->settings)}; ";
                if ($v->hasUserPersonalizedSetting($this->settings, $user)) {
                    $c['personalized'] = true;
                }
                return $c;
            },
            [
                'inputs' => [],
                'byline' => "{$this->lng->txt('default')}<br>",
                'personalized' => false
            ]
        );
    }

References $c.

buildSectionKey()

ILIAS\User\Settings\SettingsImplementation::buildSectionKey ( Setting  $setting )

private

Definition at line 319 of file SettingsImplementation.php.

                                                      : string
    {
        return $setting->getSettingsPage() === AvailablePages::MainSettings
            ? $setting->getSection()->value
            : $setting->getSettingsPage()->value;
    }

References ILIAS\User\Settings\Setting\getSection(), and ILIAS\User\Settings\Setting\getSettingsPage().

Here is the call graph for this function:

checkStartingPointValue()

ILIAS\User\Settings\SettingsImplementation::checkStartingPointValue ( \ilPropertyFormGUI  $form )

private

Definition at line 354 of file SettingsImplementation.php.

                                                                      : bool
    {
        return $form->getInput('additional') === ''
            || $this->user_settings_repository->getByIdentifier('starting_point')->validateUserChoice($this->tpl, $this->lng, $form);
    }

References ilPropertyFormGUI\getInput(), and ILIAS\Repository\lng().

Here is the call graph for this function:

filterSettingsInSectionForAvailability()

ILIAS\User\Settings\SettingsImplementation::filterSettingsInSectionForAvailability ( Context  $context, array  $settings  )

private

Definition at line 326 of file SettingsImplementation.php.

     : array {
        return array_values(
            array_filter(
                $settings,
                static fn(Setting $v): bool => $context->isSettingAvailableInType($v)
            )
        );
    }

getSettingByDefinitionClass()

ILIAS\User\Settings\SettingsImplementation::getSettingByDefinitionClass

(

string

$definition_class

)

Implements ILIAS\User\Settings\Settings.

Definition at line 150 of file SettingsImplementation.php.

     : Setting {
        $setting = $this->user_settings_repository->getByDefinitionClass($definition_class);
        if ($setting === null) {
            throw new \UnexpectedValueException('No class by that name');
        }
        return $setting;
    }

getSettingsForPagesBySections()

ILIAS\User\Settings\SettingsImplementation::getSettingsForPagesBySections ( array  $pages )

private

Parameters

array<ILIAS

User\Settings\AvailablePages> $pages

Definition at line 180 of file SettingsImplementation.php.

     : array {
        return $this->reorderSections(
            array_reduce(
                $this->user_settings_repository->get(),
                function (array $c, Setting $v) use ($pages): array {
                    if (!in_array($v->getSettingsPage(), $pages)) {
                        return $c;
                    }
 
                    $section_key = $this->buildSectionKey($v);
                    if (!array_key_exists($section_key, $c)) {
                        $c[$section_key] = [];
                    }
 
                    $c[$section_key][] = $v;
                    return $c;
                },
                []
            )
        );
    }

References $c.

getValueFromLegacyFormByDefinitionClass()

ILIAS\User\Settings\SettingsImplementation::getValueFromLegacyFormByDefinitionClass	(	string	$definition_class,
		\ilPropertyFormGUI	$form
	)

Implements ILIAS\User\Settings\Settings.

Definition at line 160 of file SettingsImplementation.php.

     : mixed {
        return $form->getInput(
            $this->getSettingByDefinitionClass($definition_class)->getIdentifier()
        );
    }

performAdditionalChecks()

ILIAS\User\Settings\SettingsImplementation::performAdditionalChecks

(

\ilPropertyFormGUI

$form

)

Definition at line 106 of file SettingsImplementation.php.

     : bool {
        return $this->checkStartingPointValue($form);
    }

reorderSections()

ILIAS\User\Settings\SettingsImplementation::reorderSections ( array  $sections )

private

Definition at line 204 of file SettingsImplementation.php.

     : array {
        if (isset($sections[AvailableSections::Main->value])) {
            $default_section = $sections[AvailableSections::Main->value];
            unset($sections[AvailableSections::Main->value]);
            array_unshift($sections, $default_section);
        }
 
        if (isset($sections[AvailableSections::Additional->value])) {
            $additional_section = $sections[AvailableSections::Additional->value];
            unset($sections[AvailableSections::Additional->value]);
            $sections[AvailableSections::Additional->value] = $additional_section;
        }
        return $sections;
    }

retrieveValuefromInputs()

ILIAS\User\Settings\SettingsImplementation::retrieveValuefromInputs ( \ilPropertyFormGUI|array  $form, Setting  $setting  )

private

Definition at line 338 of file SettingsImplementation.php.

     : mixed {
        if ($form instanceof \ilPropertyFormGUI) {
            return $form->getInput($setting->getIdentifier());
        }
 
        $section_key = $this->buildSectionKey($setting);
 
        if ($section_key === AvailableSections::Main->value) {
            return $form[$setting->getIdentifier()];
        }
        return $form[$section_key][$setting->getIdentifier()];
    }

References ILIAS\User\Settings\Setting\getIdentifier().

Here is the call graph for this function:

saveForm()

ILIAS\User\Settings\SettingsImplementation::saveForm	(	\ilPropertyFormGUI|array	$form,
		array	$pages,
		Context	$context,
		\ilObjUser	$user
	)

If it is possible to set the preference on the user, this is what will be done, the user needs to be updated/stored after calling this function.

Parameters

array<ILIAS

User\Settings\AvailablePages> $pages

Definition at line 118 of file SettingsImplementation.php.

     : \ilObjUser {
        foreach ($this->getSettingsForPagesBySections($pages) as $section => $settings) {
            $available_settings = $this->filterSettingsInSectionForAvailability($context, $settings);
            $set_settings_to_default = false;
            if ($section !== 0
                && (
                    is_array($form) && $form[$section] === null
                    || $form instanceof \ilPropertyFormGUI
                        && (($input = $form->getInput($section)) === '' || $input === '0')
                )
            ) {
                $set_settings_to_default = true;
            }
            foreach ($available_settings as $setting) {
                $setting->persistUserInput(
                    $user,
                    $context,
                    $set_settings_to_default ? null : $this->retrieveValueFromInputs($form, $setting),
                    $form instanceof \ilPropertyFormGUI ? $form : null
                );
            }
        }
 
        $user->update();
        return $user;
    }

References $context.

settingAvailableToUser()

ILIAS\User\Settings\SettingsImplementation::settingAvailableToUser

(

string

$definition_class

)

Implements ILIAS\User\Settings\Settings.

Definition at line 169 of file SettingsImplementation.php.

     : bool {
        return Context::User->isSettingAvailableInType(
            $this->getSettingByDefinitionClass($definition_class)
        );
    }

---

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

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