ILIAS\Authentication\UserSettings\Password Class Reference

Inheritance diagram for ILIAS\Authentication\UserSettings\Password:

Collaboration diagram for ILIAS\Authentication\UserSettings\Password:

Public Member Functions
	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 $current_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 $current_user)
	persistUserInput (\ilObjUser $current_user, mixed $input)
	retrieveValueFromUser (\ilObjUser $current_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)

Detailed Description

Definition at line 31 of file Password.php.

Member Function Documentation

getDefaultValueForDisplay()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 76 of file Password.php.

     : null {
        return null;
    }

getIdentifier()

ILIAS\Authentication\UserSettings\Password::getIdentifier

(

)

Implements ILIAS\User\Property.

Definition at line 33 of file Password.php.

                                   : string
    {
        return 'password';
    }

Referenced by ILIAS\Authentication\UserSettings\Password\getLabel().

Here is the caller graph for this function:

getInput()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 58 of file Password.php.

     : Input {
        throw new \Exception('This Setting does not provide an Input.');
    }

getLabel()

ILIAS\Authentication\UserSettings\Password::getLabel

(

Language

$lng

)

Implements ILIAS\User\Property.

Definition at line 43 of file Password.php.

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

References $lng, and ILIAS\Authentication\UserSettings\Password\getIdentifier().

Here is the call graph for this function:

getLegacyInput()

ILIAS\Authentication\UserSettings\Password::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 68 of file Password.php.

     : \ilFormPropertyGUI {
        throw new \Exception('This Setting does not provide an Input.');
    }

getSection()

ILIAS\Authentication\UserSettings\Password::getSection

(

)

Implements ILIAS\User\Property.

Definition at line 53 of file Password.php.

                                : AvailableSections
    {
        return AvailableSections::Main;
    }

getSettingsPage()

ILIAS\Authentication\UserSettings\Password::getSettingsPage

(

)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 48 of file Password.php.

                                     : AvailablePages
    {
        return AvailablePages::Password;
    }

References ILIAS\User\Settings\Password.

hasUserPersonalizedSetting()

ILIAS\Authentication\UserSettings\Password::hasUserPersonalizedSetting	(	\ilSetting	$settings,
		\ilObjUser	$current_user
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 83 of file Password.php.

     : bool {
        return true;
    }

isAvailable()

ILIAS\Authentication\UserSettings\Password::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 38 of file Password.php.

                                 : bool
    {
        return true;
    }

persistUserInput()

ILIAS\Authentication\UserSettings\Password::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 90 of file Password.php.

     : \ilObjUser {
        throw new \Exception('We do cannot store this Setting.');
    }

retrieveValueFromUser()

ILIAS\Authentication\UserSettings\Password::retrieveValueFromUser

(

\ilObjUser

$current_user

)

Implements ILIAS\User\Property.

Definition at line 97 of file Password.php.

                                                                   : null
    {
        return null;
    }

---

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

• components/ILIAS/Authentication/src/UserSettings/Password.php