ILIAS\Style\System\UserSettings\Style Class Reference

Inheritance diagram for ILIAS\Style\System\UserSettings\Style:

Collaboration diagram for ILIAS\Style\System\UserSettings\Style:

Public Member Functions
	__construct ()
	getIdentifier ()
	isAvailable ()
	If this function returns false the setting will not be shown, even if it's PropertyAttributes would allow it to be. More...
	getLabel (Language $lng)
	getSettingsPage ()
	getSection ()
	getInput (FieldFactory $field_factory, Language $lng, Refinery $refinery, \ilSetting $settings, ?\ilObjUser $user=null)
	getLegacyInput (Language $lng, \ilSetting $settings, ?\ilObjUser $user=null)
	You don't need to add a post_var to the input as the User will handle this for you, thus you can also not rely on the post_var anywhere else, as it will be changed. More...
	getDefaultValueForDisplay (Language $lng, \ilSetting $settings)
	hasUserPersonalizedSetting (\ilSetting $settings, \ilObjUser $user)
	persistUserInput (\ilObjUser $user, mixed $input)
	retrieveValueFromUser (\ilObjUser $user)
	isAvailable ()
	If this function returns false the setting will not be shown, even if it's PropertyAttributes would allow it to be. More...
	getSettingsPage ()
	getDefaultValueForDisplay (Language $lng, \ilSetting $settings)
	hasUserPersonalizedSetting (\ilSetting $settings, \ilObjUser $user)
	getInput (FieldFactory $field_factory, Language $lng, Refinery $refinery, \ilSetting $settings, ?\ilObjUser $user=null)
	getLegacyInput (Language $lng, \ilSetting $settings, ?\ilObjUser $user=null)
	You don't need to add a post_var to the input as the User will handle this for you, thus you can also not rely on the post_var anywhere else, as it will be changed. More...
	persistUserInput (\ilObjUser $user, mixed $input)
	getIdentifier ()
	getLabel (Language $lng)
	getSection ()
	retrieveValueFromUser (\ilObjUser $user)

Private Member Functions
	buildStyleOptions ()
	buildStyleIdFromUserOrDefault (?\ilObjUser $user)

Private Attributes
readonly ilStyleDefinition	$style_definition

Detailed Description

Definition at line 31 of file Style.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Style\System\UserSettings\Style::__construct

(

)

Definition at line 35 of file Style.php.

    {
        global $DIC;
        $this->style_definition = $DIC['styleDefinition'];
    }

References $DIC.

Member Function Documentation

buildStyleIdFromUserOrDefault()

ILIAS\Style\System\UserSettings\Style::buildStyleIdFromUserOrDefault ( ?\ilObjUser  $user )

private

Definition at line 158 of file Style.php.

     : string {
        if ($user !== null) {
            ['style' => $style, 'skin' => $skin] = $this->retrieveValueFromUser($user);
        } else {
            $style = $this->style_definition->getSystemStylesConf()->getDefaultStyleId();
            $skin = $this->style_definition->getSystemStylesConf()->getDefaultSkinId();
        }
        return "{$skin}:{$style}";
    }

buildStyleOptions()

ILIAS\Style\System\UserSettings\Style::buildStyleOptions ( )

private

Definition at line 140 of file Style.php.

                                        : array
    {
        $options = [];
        foreach ($this->style_definition::getAllSkins() as $skin) {
            foreach ($skin->getStyles() as $style) {
                if (
                    !\ilSystemStyleSettings::_lookupActivatedStyle($skin->getId(), $style->getId()) ||
                    $style->isSubstyle()
                ) {
                    continue;
                }
 
                $options[$skin->getId() . ':' . $style->getId()] = $skin->getName() . ' / ' . $style->getName();
            }
        }
        return $options;
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, and ilSystemStyleSettings\_lookupActivatedStyle().

Here is the call graph for this function:

getDefaultValueForDisplay()

ILIAS\Style\System\UserSettings\Style::getDefaultValueForDisplay	(	Language	$lng,
		\ilSetting	$settings
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 97 of file Style.php.

     : string {
        $default_skin = $this->style_definition->getSkin();
        return "{$default_skin->getName()} / {$default_skin->getDefaultStyle()->getName()}";
    }

getIdentifier()

ILIAS\Style\System\UserSettings\Style::getIdentifier

(

)

Implements ILIAS\User\Property.

Definition at line 41 of file Style.php.

                                   : string
    {
        return 'style';
    }

Referenced by ILIAS\Style\System\UserSettings\Style\getLabel().

Here is the caller graph for this function:

getInput()

ILIAS\Style\System\UserSettings\Style::getInput	(	FieldFactory	$field_factory,
		Language	$lng,
		Refinery	$refinery,
		\ilSetting	$settings,
		?\ilObjUser	$user = null
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 66 of file Style.php.

     : Input {
        $lng->loadLanguageModule('style');
 
        return $field_factory->select(
            $lng->txt('usr_skin_style'),
            $this->buildStyleOptions(),
        )->withRequired(true)
        ->withValue(
            $this->buildStyleIdFromUserOrDefault($user)
        );
    }

getLabel()

ILIAS\Style\System\UserSettings\Style::getLabel

(

Language

$lng

)

Implements ILIAS\User\Property.

Definition at line 51 of file Style.php.

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

References $lng, and ILIAS\Style\System\UserSettings\Style\getIdentifier().

Here is the call graph for this function:

getLegacyInput()

ILIAS\Style\System\UserSettings\Style::getLegacyInput	(	Language	$lng,
		\ilSetting	$settings,
		?\ilObjUser	$user = null
	)

You don't need to add a post_var to the input as the User will handle this for you, thus you can also not rely on the post_var anywhere else, as it will be changed.

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 84 of file Style.php.

     : \ilFormPropertyGUI {
        $lng->loadLanguageModule('style');
 
        $input = new \ilSelectInputGUI($lng->txt('usr_skin_style'));
        $input->setOptions($this->buildStyleOptions());
        $input->setValue($this->buildStyleIdFromUserOrDefault($user));
        return $input;
    }

getSection()

ILIAS\Style\System\UserSettings\Style::getSection

(

)

Implements ILIAS\User\Property.

Definition at line 61 of file Style.php.

                                : AvailableSections
    {
        return AvailableSections::Additional;
    }

References ILIAS\User\Settings\Additional.

getSettingsPage()

ILIAS\Style\System\UserSettings\Style::getSettingsPage

(

)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 56 of file Style.php.

                                     : AvailablePages
    {
        return AvailablePages::MainSettings;
    }

hasUserPersonalizedSetting()

ILIAS\Style\System\UserSettings\Style::hasUserPersonalizedSetting	(	\ilSetting	$settings,
		\ilObjUser	$user
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 105 of file Style.php.

     : bool {
        $system_style_config = $this->style_definition->getSystemStylesConf();
        ['style' => $user_style, 'skin' => $user_skin] = $this->retrieveValueFromUser($user);
        return $user_style !== $system_style_config->getDefaultStyleId()
            || $user_skin !== $system_style_config->getDefaultSkinId();
    }

isAvailable()

ILIAS\Style\System\UserSettings\Style::isAvailable

(

)

If this function returns false the setting will not be shown, even if it's PropertyAttributes would allow it to be.

This is meant e.g. to check if the chat server is configured or the badges enabled. Settings that are not available will also not be available on the table to define their PropertyAttributes

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 46 of file Style.php.

                                 : bool
    {
        return true;
    }

persistUserInput()

ILIAS\Style\System\UserSettings\Style::persistUserInput	(	\ilObjUser	$user,
		mixed	$input
	)

Parameters

mixed

$input

Null will be handed in, if the user wants to use the system default. If you are able to set the preference on the user without saving it, you can rely on the User-object being saved after the call to this function. If your input has different structures depending on its provenience (KS-Input, Legacy-Input, ...), the function needs to be able to handle them all.

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 115 of file Style.php.

     : \ilObjUser {
        if ($input === null) {
            $system_style_config = $this->style_definition->getSystemStylesConf();
            $user->setPref('style', $system_style_config->getDefaultStyleId());
            $user->setPref('skin', $system_style_config->getDefaultSkinId());
            return $user;
        }
 
        $sknst = explode(':', $input);
        $user->setPref('skin', $sknst[0]);
        $user->setPref('style', $sknst[1]);
        return $user;
    }

References ilObjUser\setPref().

Here is the call graph for this function:

retrieveValueFromUser()

ILIAS\Style\System\UserSettings\Style::retrieveValueFromUser

(

\ilObjUser

$user

)

Implements ILIAS\User\Property.

Definition at line 132 of file Style.php.

                                                           : array
    {
        return [
            'style' => $user->getPref('style'),
            'skin' => $user->getSkin()
        ];
    }

References ilObjUser\getPref(), and ilObjUser\getSkin().

Here is the call graph for this function:

Field Documentation

$style_definition

readonly ilStyleDefinition ILIAS\Style\System\UserSettings\Style::$style_definition

private

Definition at line 33 of file Style.php.

---

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

• components/ILIAS/Style/System/classes/UserSettings/Style.php