1. class
  2. Biigle
  3. \
  4. User

User

class User extendsUser

Traits

Notifiable
HasJsonAttributes

Properties

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

Methods

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

Set a dynamic JSON attribute.

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

Get a dynamic JSON attribute.

from HasJsonAttributes
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

inHasJsonAttributesat line16
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.

inHasJsonAttributesat line38
protectedmixed 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 line47
setEmailAttribute(string$value)

Set the email attribute and transform it to lowercase.

Parameters

string $value

at line57
BelongsToMany projects()

The projects, this user is a member of.

Return Value

BelongsToMany

at line67
BelongsToMany labelTrees()

The label trees, this user is a member of.

Return Value

BelongsToMany

at line77
BelongsTo role()

The global role of this user.

Return Value

BelongsTo

at line87
@return apiTokens()

Api tokens of this user.

Return Value

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

at line97
bool getIsGlobalAdminAttribute()

Determines if the user has the global admin role.

Return Value

bool

at line106
checkCanBeDeleted()

Checks if the user can be deleted.

Throws an exception if not.

at line126
setSettings(array$settings)

Set settings and merge them with the existing settings.

Parameters

array $settings

at line143
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 line153
bool getIsInSuperUserModeAttribute()

Determines if the user is currently in Super User Mode.

Return Value

bool

at line162
setIsInSuperUserModeAttribute(bool$value)

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

Parameters

bool $value