Group  

class Group extends AbstractModel

Traits

EventGeneratorTrait
ScopeVisibilityTrait

Constants

ADMINISTRATOR_ID

The ID of the administrator group.
GUEST_ID

The ID of the guest group.
MEMBER_ID

The ID of the member group.
MODERATOR_ID

The ID of the mod group.

Properties

bool $timestamps Indicates if the model should be timestamped. Turn off by default. from AbstractModel
protected callable[] $afterSaveCallbacks An array of callbacks to be run once after the model is saved. from AbstractModel
protected callable[] $afterDeleteCallbacks An array of callbacks to be run once after the model is deleted. from AbstractModel
static $customRelations from AbstractModel
static $dateAttributes from AbstractModel
static $defaults from AbstractModel
protected array $pendingEvents from EventGeneratorTrait
static protected $visibilityScopers from ScopeVisibilityTrait
protected array $dates The attributes that should be mutated to dates.
int $id
string $name_singular
string $name_plural
string|null $color
string|null $icon
bool $is_hidden
Collection $users
Collection $permissions

Methods

static 
boot()

Boot the model.

__construct(array $attributes = [])

{@inheritdoc}

from AbstractModel
array
getDates()

Get the attributes that should be converted to dates.

from AbstractModel
mixed
getAttribute(string $key)

Get an attribute from the model. If nothing is found, attempt to load a custom relation method with this key.

from AbstractModel
mixed
getCustomRelation(string $name)

Get a custom relation object.

from AbstractModel
void
afterSave(callable $callback)

Register a callback to be run once after the model is saved.

from AbstractModel
void
afterDelete(callable $callback)

Register a callback to be run once after the model is deleted.

from AbstractModel
callable[]
releaseAfterSaveCallbacks()

No description

from AbstractModel
callable[]
releaseAfterDeleteCallbacks()

No description

from AbstractModel
__call($method, $arguments)

{@inheritdoc}

from AbstractModel
raise(mixed $event)

Raise a new event.

from EventGeneratorTrait
array
releaseEvents()

Return and reset all pending events.

from EventGeneratorTrait
static 
registerVisibilityScoper($scoper, $ability = null)

No description

from ScopeVisibilityTrait
scopeWhereVisibleTo(Builder $query, User $actor, string $ability = 'view')

Scope a query to only include records that are visible to a user.

from ScopeVisibilityTrait
static Group
build(string $nameSingular, string $namePlural, string $color = null, string $icon = null, bool $isHidden = false)

Create a new group.

$this
rename(string $nameSingular, string $namePlural)

Rename the group.

BelongsToMany
users()

Define the relationship with the group's users.

HasMany
permissions()

Define the relationship with the group's permissions.

bool
hasPermission(string $permission)

Check whether the group has a certain permission.

Details

at line 67
static boot()

Boot the model.

in AbstractModel at line 85
__construct(array $attributes = [])

{@inheritdoc}

Parameters

array $attributes

in AbstractModel at line 105
array getDates()

Get the attributes that should be converted to dates.

Return Value

array

in AbstractModel at line 123
mixed getAttribute(string $key)

Get an attribute from the model. If nothing is found, attempt to load a custom relation method with this key.

Parameters

string $key

Return Value

mixed

in AbstractModel at line 149
protected mixed getCustomRelation(string $name)

Get a custom relation object.

Parameters

string $name

Return Value

mixed

in AbstractModel at line 165
void afterSave(callable $callback)

Register a callback to be run once after the model is saved.

Parameters

callable $callback

Return Value

void

in AbstractModel at line 176
void afterDelete(callable $callback)

Register a callback to be run once after the model is deleted.

Parameters

callable $callback

Return Value

void

in AbstractModel at line 184
callable[] releaseAfterSaveCallbacks()

Return Value

callable[]

in AbstractModel at line 196
callable[] releaseAfterDeleteCallbacks()

Return Value

callable[]

in AbstractModel at line 208
__call($method, $arguments)

{@inheritdoc}

Parameters

$method
$arguments

in EventGeneratorTrait at line 24
raise(mixed $event)

Raise a new event.

Parameters

mixed $event

in EventGeneratorTrait at line 34
array releaseEvents()

Return and reset all pending events.

Return Value

array

in ScopeVisibilityTrait at line 20
static registerVisibilityScoper($scoper, $ability = null)

Parameters

$scoper
$ability

in ScopeVisibilityTrait at line 41
scopeWhereVisibleTo(Builder $query, User $actor, string $ability = 'view')

Scope a query to only include records that are visible to a user.

Parameters

Builder $query
User $actor
string $ability

at line 86
static Group build(string $nameSingular, string $namePlural, string $color = null, string $icon = null, bool $isHidden = false)

Create a new group.

Parameters

string $nameSingular
string $namePlural
string $color
string $icon
bool $isHidden

Return Value

Group

at line 108
$this rename(string $nameSingular, string $namePlural)

Rename the group.

Parameters

string $nameSingular
string $namePlural

Return Value

$this

at line 123
BelongsToMany users()

Define the relationship with the group's users.

Return Value

BelongsToMany

at line 133
HasMany permissions()

Define the relationship with the group's permissions.

Return Value

HasMany

at line 144
bool hasPermission(string $permission)

Check whether the group has a certain permission.

Parameters

string $permission

Return Value

bool