User
class User extends User
Traits
Properties
| string | $uuid | ||
| Role | $role |
Methods
Set a dynamic JSON attribute.
Get a dynamic JSON attribute.
Get the attributes that should be cast.
Set the email attribute and transform it to lowercase.
The projects, this user is a member of.
The label trees, this user is a member of.
Api tokens of this user.
The federated search models that the user can access
Determines if the user has the global admin role.
Checks if the user can be deleted.
Set settings and merge them with the existing settings.
Get settings of a specific key.
Get the settings array.
Determines if the user is currently in Super User Mode.
Enables or disables Super User Mode if the user is a global admin.
Determines if the user can review e.g. new user registrations (without being super user).
Enables or disables the ability to review.
Determines if the API rate limit applies to the user.
Enable or disable the API rate limit for (editor) users.
Details
in
HasJsonAttributes at line 16
protected
setJsonAttr(string $key, mixed $value, string $attrs = 'attrs')
Set a dynamic JSON attribute.
in
HasJsonAttributes at line 38
protected mixed
getJsonAttr(string $key, mixed $default = null, string $attrs = 'attrs')
Get a dynamic JSON attribute.
at line 29
protected array
casts()
Get the attributes that should be cast.
at line 46
setEmailAttribute(string $value)
Set the email attribute and transform it to lowercase.
at line 56
Project, $this>
projects()
The projects, this user is a member of.
at line 66
LabelTree, $this>
labelTrees()
The label trees, this user is a member of.
at line 76
ApiToken, $this>
apiTokens()
Api tokens of this user.
at line 86
FederatedSearchModel, $this>
federatedSearchModels()
The federated search models that the user can access
at line 96
bool
getIsGlobalAdminAttribute()
Determines if the user has the global admin role.
at line 105
checkCanBeDeleted()
Checks if the user can be deleted.
Throws an exception if not.
at line 125
setSettings(array $settings)
Set settings and merge them with the existing settings.
at line 144
mixed
getSettings(string $key, mixed $default = null)
Get settings of a specific key.
at line 154
array|null
getSettingsAttribute()
Get the settings array.
at line 164
bool
getIsInSuperUserModeAttribute()
Determines if the user is currently in Super User Mode.
at line 173
setIsInSuperUserModeAttribute(bool $value)
Enables or disables Super User Mode if the user is a global admin.
at line 186
bool
getCanReviewAttribute()
Determines if the user can review e.g. new user registrations (without being super user).
at line 198
setCanReviewAttribute(bool $value)
Enables or disables the ability to review.
at line 208
bool
getHasNoRateLimitAttribute()
Determines if the API rate limit applies to the user.
at line 220
setHasNoRateLimitAttribute(bool $value)
Enable or disable the API rate limit for (editor) users.