Download the PHP package adexaja/rbac without Composer
On this page you can find all versions of the php package adexaja/rbac. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package rbac
RBAC For Laravel 5.3 Less Model
Powerful package for handling roles and permissions in Laravel 5.3
Based on the Bican/Roles Package.
So whats Different?
The difference is how Inheritance work. With Bican/Roles, permissions are inherited based on your highest role level
.
Instead this package uses a parent_id
column to enable roles to be inherited from each other.
This enables us to only pull permissions of roles that our users inherits, or that are directly assigned to the user.
- Installation
- Composer
- Service Provider
- Config File And Migrations
- HasRoleAndPermission Trait And Contract
- Usage
- Roles
- Creating Roles
- Attaching And Detaching Roles
- Deny Roles
- Checking For Roles
- Permissions
- Creating Permissions
- Attaching And Detaching Permissions
- Deny Permissions
- Checking For Permissions
- Inheritance
- Entity Check
- Blade Extensions
- Middleware
- Roles
- Config File
- More Information
- License
Installation
This package is very easy to set up. There are only couple of steps.
Composer
Pull this package in through Composer (file composer.json
).
Run this command inside your terminal.
composer update
Service Provider
Add the package to your application service providers in config/app.php
file.
Config File And Migrations
Publish the package config file and migrations to your application. Run these commands inside your terminal.
php artisan vendor:publish --provider="DCN\RBAC\RBACServiceProvider" --tag=config
php artisan vendor:publish --provider="DCN\RBAC\RBACServiceProvider" --tag=migrations
And also run migrations.
php artisan migrate
There must be created migration file for users table, which is in Laravel out of the box.
HasRoleAndPermission Trait And Contract
Include HasRoleAndPermission
trait and also implement HasRoleAndPermission
contract inside your User
model.
And that's it!
Usage
Creating Roles
Because of
Slugable
trait, if you make a mistake and for example leave a space in slug parameter, it'll be replaced with a dot automatically, because ofstr_slug
function.
Attaching And Detaching Roles
It's really simple. You fetch a user from database and call attachRole
method. There is BelongsToMany
relationship between User
and Role
model.
Deny Roles
To deny a user a role and all of its children roles, see the following example.
We recommend that you plan your roles accordingly if you plan on using this feature. As you could easily lock out users without realizing it.
Checking For Roles
You can now check if the user has required role.
You can also do this:
And of course, there is a way to check for multiple roles:
As well as Wild Cards:
Creating Permissions
It's very simple thanks to Permission
model.
Attaching And Detaching Permissions
You can attach permissions to a role or directly to a specific user (and of course detach them as well).
Deny Permissions
You can deny a user a permission, or you can deny an entire role a permission.
To do this, when attaching a permission simply pass a second parameter of false. This will deny that user that permission regardless of what they are assigned. Denied permissions take precedent over inherited and granted permissions.
Checking For Permissions
You can check for multiple permissions the same way as roles.
Inheritance
If you don't want the inheritance feature in you application, simply ignore the
parent_id
parameter when you're creating roles.
Roles that are assigned a parent_id of another role are automatically inherited when a user is assigned or inherits the parent role.
Here is an example:
You have 5 administrative groups. Admins, Store Admins, Store Inventory Managers, Blog Admins, and Blog Writers.
Role | Parent |
---|---|
Admins | |
Store Admins | Admins |
Store Inventory Managers | Store Admins |
Blog Admins | Admins |
Blog Writers | Blog Admins |
The Admins Role
is the parent of both Store Admins Role
as well as Blog Admins Role
.
While the Store Admins Role
is the parent to Store Inventory Managers Role
.
And the Blog Admins Role
is the parent to Blog Writers
.
This enables the Admins Role
to inherit both Store Inventory Managers Role
and Blog Writers Role
.
But the Store Admins Role
only inherits the Store Inventory Managers Role
,
And the Blog Admins Role
only inherits the Blog Writers Role
.
Another Example:
id | slug | parent_id |
---|---|---|
1 | admin | NULL |
2 | admin.user | 1 |
3 | admin.blog | 1 |
4 | blog.writer | 3 |
5 | development | NULL |
Here,
admin
inherits admin.user
, admin.blog
, and blog.writer
.
While admin.user
doesn't inherit anything, and admin.blog
inherits blog.writer
.
Nothing inherits development
and, development
doesn't inherit anything.
Entity Check
Let's say you have an article and you want to edit it. This article belongs to a user (there is a column user_id
in articles table).
This condition checks if the current user is the owner of article. If not, it will be looking inside user permissions for a row we created before.
Blade Extensions
There are three Blade extensions. Basically, it is replacement for classic if statements.
Middleware
This package comes with VerifyRole
and VerifyPermission
middleware. You must add them inside your app/Http/Kernel.php
file.
Now you can easily protect your routes.
It throws \DCN\RBAC\Exception\RoleDeniedException
or \DCN\RBAC\Exception\PermissionDeniedException
exceptions if it goes wrong.
You can catch these exceptions inside app/Exceptions/Handler.php
file and do whatever you want.
Config File
You can change connection for models, slug separator, models path and there is also a handy pretend feature. Have a look at config file for more information.
More Information
This project is based on Bican/Roles.
License
This package is free software distributed under the terms of the MIT license.
I don't care what you do with it.
Contribute
I honestly don't know what I'm doing. If you see something that could be fixed. Make a pull request on the develop branch!.