class User extends User

Traits

Notifiable

Properties

protected array $hidden The attributes hidden from the model's JSON form.
protected array $casts The attributes that should be casted to native types.
protected array $dates The attributes that should be mutated to dates.

Methods

setJsonAttr(string $key, mixed $value, string $attrs = 'attrs')

Set a dynamic JSON attribute.

mixed
getJsonAttr(string $key, mixed $default = null, string $attrs = 'attrs')

Get a dynamic JSON attribute.

setEmailAttribute(string $value)

Set the email attribute and transform it to lowercase.

BelongsToMany
projects()

The projects, this user is a member of.

BelongsToMany
labelTrees()

The label trees, this user is a member of.

BelongsTo
role()

The global role of this user.

@return
apiTokens()

Api tokens of this user.

bool
getIsGlobalAdminAttribute()

Determines if the user has the global admin role.

checkCanBeDeleted()

Checks if the user can be deleted.

setSettings(array $settings)

Set settings and merge them with the existing settings.

mixed
getSettings(string $key, mixed $default = null)

Get settings of a specific key.

bool
getIsInSuperUserModeAttribute()

Determines if the user is currently in Super User Mode.

setIsInSuperUserModeAttribute(bool $value)

Enables or disables Super User Mode if the user is a global admin.

Details

in HasJsonAttributes at line 14
protected setJsonAttr(string $key, mixed $value, string $attrs = 'attrs')

Set a dynamic JSON attribute.

Parameters

string $key Key of the attribute in the JSON.
mixed $value Value of the attribute in the JSON.
string $attrs Name of the JSON column of the model.

in HasJsonAttributes at line 36
protected mixed getJsonAttr(string $key, mixed $default = null, string $attrs = 'attrs')

Get a dynamic JSON attribute.

Parameters

string $key Key of the attribute in the JSON.
mixed $default Default value.
string $attrs Name of the JSON column of the model.

Return Value

mixed

at line 47
setEmailAttribute(string $value)

Set the email attribute and transform it to lowercase.

Parameters

string $value

at line 57
BelongsToMany projects()

The projects, this user is a member of.

Return Value

BelongsToMany

at line 67
BelongsToMany labelTrees()

The label trees, this user is a member of.

Return Value

BelongsToMany

at line 77
BelongsTo role()

The global role of this user.

Return Value

BelongsTo

at line 87
@return apiTokens()

Api tokens of this user.

Return Value

@return \Illuminate\Database\Eloquent\Relations\HasMany

at line 97
bool getIsGlobalAdminAttribute()

Determines if the user has the global admin role.

Return Value

bool

at line 106
checkCanBeDeleted()

Checks if the user can be deleted.

Throws an exception if not.

at line 126
setSettings(array $settings)

Set settings and merge them with the existing settings.

Parameters

array $settings

at line 143
mixed getSettings(string $key, mixed $default = null)

Get settings of a specific key.

Parameters

string $key
mixed $default Default value if the settings key was not set

Return Value

mixed

at line 153
bool getIsInSuperUserModeAttribute()

Determines if the user is currently in Super User Mode.

Return Value

bool

at line 162
setIsInSuperUserModeAttribute(bool $value)

Enables or disables Super User Mode if the user is a global admin.

Parameters

bool $value