##Permissions
This package lets you use Laravel's native @can
directive to check if a user has a certain permission (whether you gave them that permission directly or if you granted it indirectly via a role):
@can('edit articles')
@endcan
or
@if(auth()->user()->can('edit articles') && $some_other_condition)
@endif
You can use @can
, @cannot
, @canany
, and @guest
to test for permission-related access.
When using a permission-name associated with permissions created in this package, you can use @can('permission-name', 'guard_name')
if you need to check against a specific guard.
Example:
@can('edit articles', 'guard_name')
@endcan
You can also use @haspermission('permission-name')
or @haspermission('permission-name', 'guard_name')
in similar fashion. With corresponding @endhaspermission
.
There is no @hasanypermission
directive: use @canany
instead.
##Roles
As discussed in the Best Practices section of the docs, it is strongly recommended to always use permission directives, instead of role directives.
Additionally, if your reason for testing against Roles is for a Super-Admin, see the Defining A Super-Admin section of the docs.
If you actually need to directly test for Roles, this package offers some Blade directives to verify whether the currently logged in user has all or any of a given list of roles.
Optionally you can pass in the guard
that the check will be performed on as a second argument.
##Blade and Roles
Check for a specific role:
@role('writer')
I am a writer!
@else
I am not a writer...
@endrole
is the same as
@hasrole('writer')
I am a writer!
@else
I am not a writer...
@endhasrole
which is also the same as
@if(auth()->user()->hasRole('writer'))
@endif
Check for any role in a list:
@hasanyrole($collectionOfRoles)
I have one or more of these roles!
@else
I have none of these roles...
@endhasanyrole
@hasanyrole('writer|admin')
I am either a writer or an admin or both!
@else
I have none of these roles...
@endhasanyrole
Check for all roles:
@hasallroles($collectionOfRoles)
I have all of these roles!
@else
I do not have all of these roles...
@endhasallroles
@hasallroles('writer|admin')
I am both a writer and an admin!
@else
I do not have all of these roles...
@endhasallroles
Alternatively, @unlessrole
gives the reverse for checking a singular role, like this:
@unlessrole('does not have this role')
I do not have the role
@else
I do have the role
@endunlessrole
You can also determine if a user has exactly all of a given list of roles:
@hasexactroles('writer|admin')
I am both a writer and an admin and nothing else!
@else
I do not have all of these roles or have more other roles...
@endhasexactroles