Inheritance diagram for ILIAS\User\Settings\SettingDefinition:

Collaboration diagram for ILIAS\User\Settings\SettingDefinition:

Public Member Functions
	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)

Detailed Description

Definition at line 27 of file SettingDefinition.php.

Member Function Documentation

◆ getDefaultValueForDisplay()

ILIAS\User\Settings\SettingDefinition::getDefaultValueForDisplay	(	Language	$lng,
		\ilSetting	$settings
	)

Implemented in ILIAS\Authentication\UserSettings\Password, ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline, ILIAS\Calendar\UserSettings\DateFormat, ILIAS\Calendar\UserSettings\TimeFormat, ILIAS\Calendar\UserSettings\TimeZone, ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations, ILIAS\Chatroom\UserSettings\BroadcastTyping, ILIAS\Contact\UserSettings\AllowContactRequest, ILIAS\Mail\UserSettings\IncomingMail, ILIAS\Mail\UserSettings\NewMailNotification, ILIAS\Style\System\UserSettings\Style, ILIAS\User\Settings\StartingPoint\Setting, ILIAS\User\Settings\User\LastVisited, and ILIAS\User\Settings\User\SessionReminder.

◆ getInput()

ILIAS\User\Settings\SettingDefinition::getInput	(	FieldFactory	$field_factory,
		Language	$lng,
		Refinery	$refinery,
		\ilSetting	$settings,
		?\ilObjUser	$user = `null`
	)

Implemented in ILIAS\Authentication\UserSettings\Password, ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline, ILIAS\Calendar\UserSettings\DateFormat, ILIAS\Calendar\UserSettings\TimeFormat, ILIAS\Calendar\UserSettings\TimeZone, ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations, ILIAS\Chatroom\UserSettings\BroadcastTyping, ILIAS\Contact\UserSettings\AllowContactRequest, ILIAS\Mail\UserSettings\IncomingMail, ILIAS\Mail\UserSettings\NewMailNotification, ILIAS\Style\System\UserSettings\Style, ILIAS\User\Settings\StartingPoint\Setting, ILIAS\User\Settings\User\LastVisited, and ILIAS\User\Settings\User\SessionReminder.

◆ getLegacyInput()

ILIAS\User\Settings\SettingDefinition::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.

Implemented in ILIAS\Authentication\UserSettings\Password, ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline, ILIAS\Calendar\UserSettings\DateFormat, ILIAS\Calendar\UserSettings\TimeFormat, ILIAS\Calendar\UserSettings\TimeZone, ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations, ILIAS\Chatroom\UserSettings\BroadcastTyping, ILIAS\Contact\UserSettings\AllowContactRequest, ILIAS\Mail\UserSettings\IncomingMail, ILIAS\Mail\UserSettings\NewMailNotification, ILIAS\Style\System\UserSettings\Style, ILIAS\User\Settings\StartingPoint\Setting, ILIAS\User\Settings\User\LastVisited, and ILIAS\User\Settings\User\SessionReminder.

◆ getSettingsPage()

ILIAS\User\Settings\SettingDefinition::getSettingsPage ( )

Implemented in ILIAS\Authentication\UserSettings\Password, ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline, ILIAS\Calendar\UserSettings\DateFormat, ILIAS\Calendar\UserSettings\TimeFormat, ILIAS\Calendar\UserSettings\TimeZone, ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations, ILIAS\Chatroom\UserSettings\BroadcastTyping, ILIAS\Contact\UserSettings\AllowContactRequest, ILIAS\Help\UserSettings\Help, ILIAS\Language\UserSettings\Language, ILIAS\Mail\UserSettings\IncomingMail, ILIAS\Mail\UserSettings\NewMailNotification, ILIAS\Notifications\UserSettings\PushNotification, ILIAS\Style\System\UserSettings\Style, ILIAS\User\Settings\StartingPoint\Setting, ILIAS\User\Settings\User\LastVisited, and ILIAS\User\Settings\User\SessionReminder.

◆ hasUserPersonalizedSetting()

ILIAS\User\Settings\SettingDefinition::hasUserPersonalizedSetting	(	\ilSetting	$settings,
		\ilObjUser	$user
	)

Implemented in ILIAS\Authentication\UserSettings\Password, ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline, ILIAS\Calendar\UserSettings\DateFormat, ILIAS\Calendar\UserSettings\TimeFormat, ILIAS\Calendar\UserSettings\TimeZone, ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations, ILIAS\Chatroom\UserSettings\BroadcastTyping, ILIAS\Contact\UserSettings\AllowContactRequest, ILIAS\Help\UserSettings\Help, ILIAS\Language\UserSettings\Language, ILIAS\Mail\UserSettings\IncomingMail, ILIAS\Mail\UserSettings\NewMailNotification, ILIAS\Style\System\UserSettings\Style, ILIAS\User\Settings\StartingPoint\Setting, ILIAS\User\Settings\User\LastVisited, and ILIAS\User\Settings\User\SessionReminder.

◆ isAvailable()

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.

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

Implemented in ILIAS\Authentication\UserSettings\Password, ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline, ILIAS\Calendar\UserSettings\DateFormat, ILIAS\Calendar\UserSettings\TimeFormat, ILIAS\Calendar\UserSettings\TimeZone, ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations, ILIAS\Chatroom\UserSettings\BroadcastTyping, ILIAS\Contact\UserSettings\AllowContactRequest, ILIAS\Help\UserSettings\Help, ILIAS\Language\UserSettings\Language, ILIAS\Mail\UserSettings\IncomingMail, ILIAS\Mail\UserSettings\NewMailNotification, ILIAS\Notifications\UserSettings\PushNotification, ILIAS\Style\System\UserSettings\Style, ILIAS\User\Settings\StartingPoint\Setting, ILIAS\User\Settings\User\LastVisited, and ILIAS\User\Settings\User\SessionReminder.

◆ persistUserInput()

ILIAS\User\Settings\SettingDefinition::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.

Implemented in ILIAS\Authentication\UserSettings\Password, ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline, ILIAS\Calendar\UserSettings\DateFormat, ILIAS\Calendar\UserSettings\TimeFormat, ILIAS\Calendar\UserSettings\TimeZone, ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations, ILIAS\Chatroom\UserSettings\BroadcastTyping, ILIAS\Contact\UserSettings\AllowContactRequest, ILIAS\Help\UserSettings\Help, ILIAS\Language\UserSettings\Language, ILIAS\Style\System\UserSettings\Style, ILIAS\User\Settings\User\LastVisited, and ILIAS\User\Settings\User\SessionReminder.

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

components/ILIAS/User/src/Settings/SettingDefinition.php

Public Member Functions