ILIAS\Language\UserSettings\Language Class Reference

Inheritance diagram for ILIAS\Language\UserSettings\Language:

Collaboration diagram for ILIAS\Language\UserSettings\Language:

Public Member Functions
	__construct ()
	isAvailable ()
	If this function returns false the setting will not be shown, even if it's PropertyAttributes would allow it to be. More...
	getIdentifier ()
	getLabel (SystemLanguage $lng)
	getSettingsPage ()
	getSection ()
	getInput (FieldFactory $field_factory, SystemLanguage $lng, Refinery $refinery, \ilSetting $settings, ?\ilObjUser $user=null)
	getLegacyInput (SystemLanguage $lng, \ilSetting $settings, ?\ilObjUser $user=null)
	getDefaultValueForDisplay (SystemLanguage $lng, \ilSetting $settings)
	hasUserPersonalizedSetting (\ilSetting $settings, \ilObjUser $user)
	persistUserInput (\ilObjUser $user, mixed $input)
	retrieveValueFromUser (\ilObjUser $user)
Public Member Functions inherited from ILIAS\User\Settings\SettingDefinition
	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)
Public Member Functions inherited from ILIAS\User\Property
	getIdentifier ()
	getLabel (Language $lng)
	getSection ()
	retrieveValueFromUser (\ilObjUser $user)

Private Member Functions
	buildSelectOptions (SystemLanguage $lng)

Private Attributes
ilLanguage	$lng

Detailed Description

Definition at line 31 of file Language.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Language\UserSettings\Language::__construct

(

)

Definition at line 35 of file Language.php.

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

References $DIC, and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

buildSelectOptions()

ILIAS\Language\UserSettings\Language::buildSelectOptions ( SystemLanguage  $lng )

private

Definition at line 132 of file Language.php.

                                                            : array
    {
        return array_reduce(
            $lng->getInstalledLanguages(),
            function (array $c, string $lang_key) use ($lng): array {
                $c[$lang_key] = $lng->txtlng('meta', 'meta_l_' . $lang_key, $lang_key);
                return $c;
            },
            []
        );
    }

References $c, and $lng.

getDefaultValueForDisplay()

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

Definition at line 105 of file Language.php.

     : null {
        return null;
    }

getIdentifier()

ILIAS\Language\UserSettings\Language::getIdentifier

(

)

Implements ILIAS\User\Property.

Definition at line 46 of file Language.php.

                                   : string
    {
        return 'language';
    }

Referenced by ILIAS\Language\UserSettings\Language\getLabel().

Here is the caller graph for this function:

getInput()

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

Definition at line 66 of file Language.php.

     : Input {
        $options = $this->buildSelectOptions($lng);
        return $field_factory->select(
            $this->getLabel($lng),
            $options
        )->withDisabled(
            count($options) <= 1
        )->withRequired(true)
        ->withValue(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : $this->lng->getDefaultLanguage()
        );
    }

getLabel()

ILIAS\Language\UserSettings\Language::getLabel

(

SystemLanguage

$lng

)

Definition at line 51 of file Language.php.

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

References ILIAS\Language\UserSettings\Language\$lng, ILIAS\Language\UserSettings\Language\getIdentifier(), and ilLanguage\txt().

Here is the call graph for this function:

getLegacyInput()

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

Definition at line 87 of file Language.php.

     : \ilFormPropertyGUI {
        $options = $this->buildSelectOptions($lng);
        $input = new \ilSelectInputGUI($this->getLabel($lng));
        $input->setOptionsLangAttribute(fn($options, $key) => $key);
        $input->setOptions($options);
        $input->setDisabled(count($options) <= 1);
        $input->setValue(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : $this->lng->getDefaultLanguage()
        );
        return $input;
    }

getSection()

ILIAS\Language\UserSettings\Language::getSection

(

)

Implements ILIAS\User\Property.

Definition at line 61 of file Language.php.

                                : AvailableSections
    {
        return AvailableSections::Main;
    }

getSettingsPage()

ILIAS\Language\UserSettings\Language::getSettingsPage

(

)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 56 of file Language.php.

                                     : AvailablePages
    {
        return AvailablePages::MainSettings;
    }

hasUserPersonalizedSetting()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 112 of file Language.php.

     : bool {
        return true;
    }

isAvailable()

ILIAS\Language\UserSettings\Language::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 41 of file Language.php.

                                 : bool
    {
        return true;
    }

persistUserInput()

ILIAS\Language\UserSettings\Language::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 119 of file Language.php.

     : \ilObjUser {
        $user->setLanguage($input);
        return $user;
    }

retrieveValueFromUser()

ILIAS\Language\UserSettings\Language::retrieveValueFromUser

(

\ilObjUser

$user

)

Implements ILIAS\User\Property.

Definition at line 127 of file Language.php.

                                                           : string
    {
        return $user->getLanguage();
    }

References ilObjUser\getLanguage().

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ILIAS\Language\UserSettings\Language::$lng

private

Definition at line 33 of file Language.php.

Referenced by ILIAS\Language\UserSettings\Language\getLabel().

---

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

• components/ILIAS/Language/src/UserSettings/Language.php