HasRoles
trait HasRoles
Traits
Build Permission relations from one immutable partition and team snapshot.
Methods
Build a partition-aware belongs-to-many relation.
Build a partition-aware morph-to-many relation.
Build the related query using the relation's captured partition.
Ensure a partition-bearing relation parent belongs to the captured partition.
Apply the captured partition to pivot reads and writes.
Boot permission cleanup and queued assignment handling.
Delete the model and its permission assignments atomically.
Determine whether deleting the model removes permission assignments.
Delete one kind of assignment for a hard-deleted subject.
Delete assignment pivots owned by a Role or Permission record.
Resolve and validate a permission record's deletion partition.
Build the direct permission assignment relation for a captured context.
Get the immutable context captured by a permission assignment relation.
Forget an assignment relation loaded for an earlier context.
Get cached direct permission assignments for this model.
Get direct permissions for a model-returning public API.
Scope the model query to certain permissions only.
Add an effective permission predicate for the given permission ids.
Add a permission-effect predicate for direct and role-granted permissions.
Add a direct permission-effect predicate.
Add a role permission-effect predicate.
Scope the model query to only those without certain permissions, whether indirectly by role or by direct permission.
Convert the given permissions to permission models.
Find a permission.
Determine if the model may perform the given permission.
Validates a wildcard permission against all permissions of a user.
An alias to hasPermissionTo(), but avoids throwing an exception.
Determine if the model has any of the given permissions.
Determine if the model has all of the given permissions.
Determine if the model has, via roles, the given permission.
Determine if the model has the given permission.
Return all the permissions the model has via roles.
Return all the permissions the model has, both directly and via roles.
Return all the permissions the model is denied, both directly and via roles.
Grant the given permission(s) to the model.
Deny the given permission(s) for the model.
Build a collision-safe assignment ID identity.
Index assignment IDs by their collision-safe identities.
Normalize an ID read directly from an assignment pivot.
Read current assignment pivots through their captured relation constraints.
Queue permission assignments until the model is saved.
Remove permission assignments queued for a captured context.
Flush all assignments queued before the model was saved.
Insert queued permission assignments, with one insert per context and effect.
Dispatch the permission attached event when enabled and listened for.
Determine whether the permission attached event has listeners.
Remove all current permissions and set the given ones.
Remove all current permissions and set allowed and denied permissions.
Revoke the given permission(s).
Dispatch the permission detached event when enabled and listened for.
Determine whether the permission detached event has listeners.
Determine if the model has an explicit denied direct permission.
Determine if the model has an explicit denied permission via roles.
Return permissions granted through the model's roles with role-permission pivot data.
Load permissions granted through the model's roles with role-permission pivot data.
Resolve a permission for matching without throwing.
Build lookup keys for denied permissions.
Clone a permission with the matching role-permission pivot.
Normalize a permission assignment effect.
Determine if a stored permission matches an input permission.
Resolve the guard to use when matching stored permissions.
Get the stored permission models for the given permissions.
Ensure the given role or permission uses one of the model's guards.
Check if the model has All of the requested Direct permissions.
Check if the model has Any of the requested Direct permissions.
Boot role cleanup.
Get the role model class.
A model may have multiple roles.
Build the role assignment relation for a captured context.
Get cached role assignments for this model.
Scope the model query to certain roles only.
Scope the model query to only those without certain roles.
A model may be part of multiple teams.
Scope the model query to certain teams only.
Scope the model query to those without certain teams.
Assign the given role to the model.
Queue role assignments until the model is saved.
Replace role assignments queued for a captured context.
Remove role assignments queued for a captured context.
Dispatch the role attached event when enabled and listened for.
Determine whether the role attached event has listeners.
Revoke the given role from the model.
Dispatch the role detached event when enabled and listened for.
Determine whether the role detached event has listeners.
Remove all current roles and set the given ones.
Determine if the model has (one of) the given role(s).
Determine if the model has any of the given role(s).
Determine if the model has all of the given role(s).
Determine if the model has exactly all of the given role(s).
Return allowed permissions directly assigned to the model.
Get the role names.
Get a stored role instance.
Convert a pipe-delimited role string to an array.
Details
in
BuildsPermissionRelations at line 35
protected BelongsToMany
permissionBelongsToMany(string $related, string $table, string $foreignPivotKey, string $relatedPivotKey, string $relationName, PermissionRelationContext|null $context = null)
Build a partition-aware belongs-to-many relation.
in
BuildsPermissionRelations at line 72
protected MorphToMany
permissionMorphToMany(string $related, string $table, string $foreignPivotKey, string $relatedPivotKey, string $relationName, bool $inverse = false, bool $teamScoped = false, PermissionRelationContext|null $context = null)
Build a partition-aware morph-to-many relation.
in
BuildsPermissionRelations at line 129
protected Builder
permissionRelationQuery(Model $related, PermissionPartition|null $partition)
Build the related query using the relation's captured partition.
in
BuildsPermissionRelations at line 144
protected void
ensurePermissionRelationParentMatches(PermissionRegistrar $registrar, PermissionPartition|null $partition)
Ensure a partition-bearing relation parent belongs to the captured partition.
in
BuildsPermissionRelations at line 178
protected BelongsToMany
applyPermissionPartitionToRelation(BelongsToMany $relation, PermissionPartition|null $partition)
Apply the captured partition to pivot reads and writes.
in
HasPermissions at line 54
protected PermissionRegistrar
permissionRegistrar()
Get the permission registrar.
in
HasPermissions at line 62
protected Dispatcher
eventDispatcher()
Get the event dispatcher.
in
HasPermissions at line 70
static void
bootHasPermissions()
Boot permission cleanup and queued assignment handling.
in
HasPermissions at line 169
int|bool|null
delete()
Delete the model and its permission assignments atomically.
in
HasPermissions at line 183
static protected bool
shouldDeletePermissionAssignments(Model $model)
Determine whether deleting the model removes permission assignments.
in
HasPermissions at line 193
static protected array|null
deleteSubjectAssignments(string $morphType, mixed $modelKey, string $table)
Delete one kind of assignment for a hard-deleted subject.
in
HasPermissions at line 249
static protected void
deletePermissionRecordAssignments(mixed $modelKey, string $modelAssignmentsTable, string $pivotKey, PermissionPartition|null $partition)
Delete assignment pivots owned by a Role or Permission record.
in
HasPermissions at line 276
static protected PermissionPartition|null
permissionRecordDeletionPartition(Model $model, PermissionRegistrar $registrar)
Resolve and validate a permission record's deletion partition.
in
HasPermissions at line 306
string
getPermissionClass()
Get the permission model class.
in
HasPermissions at line 318
string
getWildcardClass()
Get the wildcard permission class.
in
HasPermissions at line 340
BelongsToMany
permissions()
A model may have multiple direct permissions.
in
HasPermissions at line 348
protected BelongsToMany
permissionAssignmentRelation(PermissionRelationContext|null $context = null)
Build the direct permission assignment relation for a captured context.
in
HasPermissions at line 368
protected PermissionRelationContext
permissionRelationContext(BelongsToMany $relation)
Get the immutable context captured by a permission assignment relation.
in
HasPermissions at line 377
protected void
forgetStalePermissionRelation(PermissionRegistrar $registrar, string $relation)
Forget an assignment relation loaded for an earlier context.
in
HasPermissions at line 388
protected Collection
getCachedDirectPermissions()
Get cached direct permission assignments for this model.
in
HasPermissions at line 482
protected Collection
directPermissionsForModelResult()
Get direct permissions for a model-returning public API.
in
HasPermissions at line 500
protected Collection
allowedDirectPermissions()
Return allowed direct permissions.
in
HasPermissions at line 514
Builder
scopePermission(Builder $query, array|Collection|int|Permission|string|UnitEnum $permissions, bool $without = false)
Scope the model query to certain permissions only.
in
HasPermissions at line 539
protected Builder
whereEffectivePermission(Builder $query, array $permissionIds)
Add an effective permission predicate for the given permission ids.
in
HasPermissions at line 564
protected Builder
wherePermissionEffect(Builder $query, int|string $permissionId, bool $denied)
Add a permission-effect predicate for direct and role-granted permissions.
in
HasPermissions at line 584
protected Builder
whereDirectPermissionEffect(Builder $query, int|string $permissionId, bool $denied)
Add a direct permission-effect predicate.
in
HasPermissions at line 599
protected Builder
whereRolePermissionEffect(Builder $query, int|string $permissionId, bool $denied)
Add a role permission-effect predicate.
in
HasPermissions at line 616
Builder
scopeWithoutPermission(Builder $query, array|Collection|int|Permission|string|UnitEnum $permissions)
Scope the model query to only those without certain permissions, whether indirectly by role or by direct permission.
in
HasPermissions at line 626
protected array
convertToPermissionModels(array|Collection|int|Permission|string|UnitEnum $permissions)
Convert the given permissions to permission models.
in
HasPermissions at line 659
Permission
filterPermission(mixed $permission, string|null $guardName = null)
Find a permission.
in
HasPermissions at line 696
bool
hasPermissionTo(mixed $permission, string|null $guardName = null)
Determine if the model may perform the given permission.
in
HasPermissions at line 720
protected bool
hasWildcardPermission(mixed $permission, string|null $guardName = null)
Validates a wildcard permission against all permissions of a user.
in
HasPermissions at line 757
bool
checkPermissionTo(mixed $permission, string|null $guardName = null)
An alias to hasPermissionTo(), but avoids throwing an exception.
in
HasPermissions at line 771
bool
hasAnyPermission(mixed ...$permissions)
Determine if the model has any of the given permissions.
in
HasPermissions at line 789
bool
hasAllPermissions(mixed ...$permissions)
Determine if the model has all of the given permissions.
in
HasPermissions at line 805
protected bool
hasPermissionViaRole(Permission $permission)
Determine if the model has, via roles, the given permission.
in
HasPermissions at line 825
bool
hasDirectPermission(mixed $permission)
Determine if the model has the given permission.
in
HasPermissions at line 838
Collection
getPermissionsViaRoles()
Return all the permissions the model has via roles.
in
HasPermissions at line 853
Collection
getAllPermissions()
Return all the permissions the model has, both directly and via roles.
in
HasPermissions at line 872
Collection
getDeniedPermissions()
Return all the permissions the model is denied, both directly and via roles.
in
HasPermissions at line 931
HasPermissions
givePermissionTo(array|Collection|int|Permission|string|UnitEnum|null ...$permissions)
Grant the given permission(s) to the model.
in
HasPermissions at line 939
HasPermissions
denyPermissionTo(array|Collection|int|Permission|string|UnitEnum|null ...$permissions)
Deny the given permission(s) for the model.
in
HasPermissions at line 1044
protected string
assignmentIdIdentity(int|string $id)
Build a collision-safe assignment ID identity.
in
HasPermissions at line 1055
protected array
indexAssignmentIds(array $ids)
Index assignment IDs by their collision-safe identities.
in
HasPermissions at line 1069
protected int|string
normalizeRelatedPivotId(BelongsToMany $relation, mixed $id)
Normalize an ID read directly from an assignment pivot.
in
HasPermissions at line 1082
protected Collection
readCurrentAssignmentPivots(BelongsToMany $relation, array $columns, array|null $ids = null)
Read current assignment pivots through their captured relation constraints.
in
HasPermissions at line 1250
protected void
queuePermissionAssignments(array $permissions, bool $isDenied, PermissionRelationContext $context, string $pivotClass)
Queue permission assignments until the model is saved.
Queuing a permission again replaces its queued effect.
in
HasPermissions at line 1299
protected void
removeQueuedPermissionAssignments(array $permissions, PermissionRelationContext $context)
Remove permission assignments queued for a captured context.
at line 511
protected void
flushQueuedPermissionAssignments()
Flush all assignments queued before the model was saved.
in
HasPermissions at line 1348
protected void
attachQueuedPermissionAssignments(array $assignments)
Insert queued permission assignments, with one insert per context and effect.
in
HasPermissions at line 1396
protected void
dispatchPermissionAttachedEvent(array $permissions)
Dispatch the permission attached event when enabled and listened for.
in
HasPermissions at line 1408
protected bool
permissionAttachedEventIsListenedFor()
Determine whether the permission attached event has listeners.
in
HasPermissions at line 1417
void
forgetWildcardPermissionIndex()
Forget the wildcard permission index.
in
HasPermissions at line 1427
HasPermissions
syncPermissions(array|Collection|int|Permission|string|UnitEnum|null ...$permissions)
Remove all current permissions and set the given ones.
in
HasPermissions at line 1444
array
syncPermissionEffects(array|Collection $allowed = [], array|Collection $denied = [])
Remove all current permissions and set allowed and denied permissions.
For unsaved models, assignments are queued until the model is saved and the returned change set is empty because no database rows are changed yet.
in
HasPermissions at line 1505
HasPermissions
revokePermissionTo(array|Collection|int|Permission|string|UnitEnum $permission)
Revoke the given permission(s).
in
HasPermissions at line 1543
protected void
dispatchPermissionDetachedEvent(mixed $permission)
Dispatch the permission detached event when enabled and listened for.
in
HasPermissions at line 1555
protected bool
permissionDetachedEventIsListenedFor()
Determine whether the permission detached event has listeners.
in
HasPermissions at line 1564
bool
hasDeniedPermission(int|Permission|string|UnitEnum $permission, string|null $guardName = null)
Determine if the model has an explicit denied direct permission.
in
HasPermissions at line 1578
bool
hasDeniedPermissionViaRoles(int|Permission|string|UnitEnum $permission, string|null $guardName = null)
Determine if the model has an explicit denied permission via roles.
in
HasPermissions at line 1615
protected Collection
getPermissionsViaRolesWithPivots()
Return permissions granted through the model's roles with role-permission pivot data.
in
HasPermissions at line 1634
protected Collection
loadPermissionsViaRolesWithPivots()
Load permissions granted through the model's roles with role-permission pivot data.
in
HasPermissions at line 1665
protected Model|null
permissionForMatch(int|Permission|string|UnitEnum $permission, string $guardName)
Resolve a permission for matching without throwing.
in
HasPermissions at line 1692
protected array
deniedPermissionKeys(Collection ...$permissionCollections)
Build lookup keys for denied permissions.
in
HasPermissions at line 1710
protected string
permissionComparisonKey(Model $permission)
Build a permission comparison key.
in
HasPermissions at line 1718
protected Model
permissionWithRolePivot(Model $permission, Model $role, PermissionRegistrar $registrar)
Clone a permission with the matching role-permission pivot.
in
HasPermissions at line 1741
protected bool
pivotIsDenied(Model $model)
Determine if a hydrated pivot marks the permission as denied.
in
HasPermissions at line 1750
protected bool
permissionEffectIsDenied(mixed $value)
Normalize a permission assignment effect.
in
HasPermissions at line 1759
protected Collection
relationCollection(Model $model, string $relation)
Get a hydrated relation collection.
in
HasPermissions at line 1778
protected bool
storedPermissionMatches(Model $storedPermission, int|Permission|string|UnitEnum $permission, string|null $guardName = null)
Determine if a stored permission matches an input permission.
in
HasPermissions at line 1803
protected string
guardNameForPermissionMatch(int|Permission|string|UnitEnum $permission, string|null $guardName = null)
Resolve the guard to use when matching stored permissions.
in
HasPermissions at line 1830
Collection
getPermissionNames()
Get the permission names.
in
HasPermissions at line 1841
protected mixed
getStoredPermission(mixed $permissions, PermissionPartition|null $partition = null)
Get the stored permission models for the given permissions.
in
HasPermissions at line 1931
protected void
ensureModelSharesGuard(Permission|Role $roleOrPermission)
Ensure the given role or permission uses one of the model's guards.
in
HasPermissions at line 1941
protected Collection
getGuardNames()
Get the guard names for the model.
in
HasPermissions at line 1949
protected string
getDefaultGuardName()
Get the default guard name for the model.
in
HasPermissions at line 1957
void
forgetCachedPermissions()
Forget the cached permissions.
in
HasPermissions at line 1967
bool
hasAllDirectPermissions(mixed ...$permissions)
Check if the model has All of the requested Direct permissions.
in
HasPermissions at line 1985
bool
hasAnyDirectPermission(mixed ...$permissions)
Check if the model has Any of the requested Direct permissions.
at line 41
static void
bootHasRoles()
Boot role cleanup.
at line 117
string
getRoleClass()
Get the role model class.
at line 129
BelongsToMany
roles()
A model may have multiple roles.
at line 137
protected BelongsToMany
roleAssignmentRelation(PermissionRelationContext|null $context = null)
Build the role assignment relation for a captured context.
at line 170
protected Collection
getCachedRoles()
Get cached role assignments for this model.
at line 204
Builder
scopeRole(Builder $query, array|Collection|int|Role|string|UnitEnum $roles, string|null $guard = null, bool $without = false)
Scope the model query to certain roles only.
at line 256
Builder
scopeWithoutRole(Builder $query, array|Collection|int|Role|string|UnitEnum $roles, string|null $guard = null)
Scope the model query to only those without certain roles.
at line 268
BelongsToMany
teams()
A model may be part of multiple teams.
When the teams feature is disabled this returns an empty BelongsToMany so tooling that introspects model relations (e.g. ide-helper:models) does not break. Querying it is a no-op and produces no rows.
at line 304
Builder
scopeTeam(Builder $query, array|Collection|int|Model|string $teams, bool $without = false)
Scope the model query to certain teams only.
at line 345
Builder
scopeWithoutTeam(Builder $query, array|Collection|int|Model|string $teams)
Scope the model query to those without certain teams.
at line 383
HasRoles
assignRole(array|Collection|int|Role|string|UnitEnum|null ...$roles)
Assign the given role to the model.
at line 440
protected void
queueRoleAssignments(array $roles, PermissionRelationContext $context, string $pivotClass)
Queue role assignments until the model is saved.
at line 467
protected void
replaceQueuedRoleAssignments(array $roles, PermissionRelationContext $context, string $pivotClass)
Replace role assignments queued for a captured context.
at line 484
protected void
removeQueuedRoleAssignments(array $roles, PermissionRelationContext $context)
Remove role assignments queued for a captured context.
at line 577
protected void
dispatchRoleAttachedEvent(array $roles)
Dispatch the role attached event when enabled and listened for.
at line 589
protected bool
roleAttachedEventIsListenedFor()
Determine whether the role attached event has listeners.
at line 600
HasRoles
removeRole(array|Collection|int|Role|string|UnitEnum|null ...$role)
Revoke the given role from the model.
at line 639
protected void
dispatchRoleDetachedEvent(array $roles)
Dispatch the role detached event when enabled and listened for.
at line 651
protected bool
roleDetachedEventIsListenedFor()
Determine whether the role detached event has listeners.
at line 662
HasRoles
syncRoles(array|Collection|int|Role|string|UnitEnum|null ...$roles)
Remove all current roles and set the given ones.
at line 722
bool
hasRole(array|Collection|int|Role|string|UnitEnum $roles, string|null $guard = null)
Determine if the model has (one of) the given role(s).
at line 781
bool
hasAnyRole(array|Collection|int|Role|string|UnitEnum ...$roles)
Determine if the model has any of the given role(s).
Alias to hasRole() but without Guard controls
at line 789
bool
hasAllRoles(array|Collection|Role|string|UnitEnum $roles, string|null $guard = null)
Determine if the model has all of the given role(s).
at line 831
bool
hasExactRoles(array|Collection|Role|string|UnitEnum $roles, string|null $guard = null)
Determine if the model has exactly all of the given role(s).
at line 856
Collection
getDirectPermissions()
Return allowed permissions directly assigned to the model.
at line 866
Collection
getRoleNames()
Get the role names.
at line 876
protected Role
getStoredRole(int|Role|string|UnitEnum $role, PermissionPartition|null $partition = null)
Get a stored role instance.
at line 955
protected array
convertPipeToArray(string $pipeString)
Convert a pipe-delimited role string to an array.