1. class
  2. Biigle
  3. \
  4. Modules
  5. \
  6. UserStorage
  7. \
  8. User

User

class User extends User

Traits

Notifiable
HasJsonAttributes
HasFactory

Properties

string $uuid from  User

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
array
casts()

Get the attributes that should be cast.

from  User
setEmailAttribute(string $value)

Set the email attribute and transform it to lowercase.

from  User
Project, $this>
projects()

The projects, this user is a member of.

from  User
LabelTree, $this>
labelTrees()

The label trees, this user is a member of.

from  User
Role, $this>
role()

The global role of this user.

from  User
ApiToken, $this>
apiTokens()

Api tokens of this user.

from  User
FederatedSearchModel, $this>
federatedSearchModels()

The federated search models that the user can access

from  User
bool
getIsGlobalAdminAttribute()

Determines if the user has the global admin role.

from  User
checkCanBeDeleted()

Checks if the user can be deleted.

from  User
setSettings(array $settings)

Set settings and merge them with the existing settings.

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

Get settings of a specific key.

from  User
array|null
getSettingsAttribute()

Get the settings array.

from  User
bool
getIsInSuperUserModeAttribute()

Determines if the user is currently in Super User Mode.

from  User
setIsInSuperUserModeAttribute(bool $value)

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

from  User
bool
getCanReviewAttribute()

Determines if the user can review e.g. new user registrations (without being super user).

from  User
setCanReviewAttribute(bool $value)

Enables or disables the ability to review.

from  User
bool
getHasNoRateLimitAttribute()

Determines if the API rate limit applies to the user.

from  User
setHasNoRateLimitAttribute(bool $value)

Enable or disable the API rate limit for (editor) users.

from  User
static User
convert(User $model)

Converts a regular user to an user storage user.

int
getStorageQuotaAvailableAttribute()

Get the available storage quota of the user in bytes.

setStorageQuotaAvailableAttribute($value)

Set the allowed user storage quota.

int
getStorageQuotaUsedAttribute()

Get the used storage quota of the user in bytes.

int
getStorageQuotaRemainingAttribute()

Get the remaining storage quota of the user in bytes.

Details

in HasJsonAttributes at line 16
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 38
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

in User at line 27
protected array casts()

Get the attributes that should be cast.

Return Value

array

in User at line 44
setEmailAttribute(string $value)

Set the email attribute and transform it to lowercase.

Parameters

string $value

in User at line 54
Project, $this> projects()

The projects, this user is a member of.

Return Value

Project, $this>

in User at line 64
LabelTree, $this> labelTrees()

The label trees, this user is a member of.

Return Value

LabelTree, $this>

in User at line 74
Role, $this> role()

The global role of this user.

Return Value

Role, $this>

in User at line 84
ApiToken, $this> apiTokens()

Api tokens of this user.

Return Value

ApiToken, $this>

in User at line 94
FederatedSearchModel, $this> federatedSearchModels()

The federated search models that the user can access

Return Value

FederatedSearchModel, $this>

in User at line 104
bool getIsGlobalAdminAttribute()

Determines if the user has the global admin role.

Return Value

bool

in User at line 113
checkCanBeDeleted()

Checks if the user can be deleted.

Throws an exception if not.

in User at line 133
setSettings(array $settings)

Set settings and merge them with the existing settings.

Parameters

array $settings

in User at line 152
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

in User at line 162
array|null getSettingsAttribute()

Get the settings array.

Return Value

array|null

in User at line 172
bool getIsInSuperUserModeAttribute()

Determines if the user is currently in Super User Mode.

Return Value

bool

in User at line 181
setIsInSuperUserModeAttribute(bool $value)

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

Parameters

bool $value

in User at line 194
bool getCanReviewAttribute()

Determines if the user can review e.g. new user registrations (without being super user).

Return Value

bool

in User at line 206
setCanReviewAttribute(bool $value)

Enables or disables the ability to review.

Parameters

bool $value

in User at line 216
bool getHasNoRateLimitAttribute()

Determines if the API rate limit applies to the user.

Return Value

bool

in User at line 228
setHasNoRateLimitAttribute(bool $value)

Enable or disable the API rate limit for (editor) users.

Parameters

bool $value

at line 17
static User convert(User $model)

Converts a regular user to an user storage user.

Parameters

User $model

Return Value

User

at line 31
int getStorageQuotaAvailableAttribute()

Get the available storage quota of the user in bytes.

Return Value

int

at line 41
setStorageQuotaAvailableAttribute($value)

Set the allowed user storage quota.

@@param int|null $value

Parameters

$value

at line 51
int getStorageQuotaUsedAttribute()

Get the used storage quota of the user in bytes.

Return Value

int

at line 67
int getStorageQuotaRemainingAttribute()

Get the remaining storage quota of the user in bytes.

Return Value

int