UserPreferenceService

UserPreferenceService.php : 19 Copy path

User Preference Service.

This service provides methods for managing user preferences. It works in the context of a current User (obtained from the PermissionResolver).

Methods¶

UserPreferenceService.php : 41 Copy path

Get currently logged user preference by key.

public getUserPreference(string $userPreferenceName) : UserPreference

Name	Type	Default value	Description
$userPreferenceName	string	-	-

UserPreferenceService.php : 60 Copy path

Get count of total preferences for currently logged user.

public getUserPreferenceCount() : int

int

UserPreferenceService.php : 53 Copy path

Get currently logged user preferences.

public loadUserPreferences([int $offset = 0 ][, int $limit = 25 ]) : UserPreferenceList

Name	Type	Default value	Description
$offset	int	0	the start offset for paging
$limit	int	25	the number of user preferences returned

UserPreferenceService.php : 29 Copy path

Set user preference.

public setUserPreference(array<string|int, UserPreferenceSetStruct> $userPreferenceSetStructs) : void

Name	Type	Default value	Description
$userPreferenceSetStructs	array<string\|int, UserPreferenceSetStruct>	-	-