Authorize
Authorize is a package for Laravel that provides User Access Control using Roles and Permissions., (*1)
Installation
Step 1: Composer
From the command line, run:, (*2)
composer require crabbly/authorize
Step 2: Service Provider
For your Laravel app, open config/app.php and, within the providers array, append:, (*3)
Crabbly\Authorize\AuthorizeServiceProvider::class
This will bootstrap the package into Laravel., (*4)
Step 3: Publish and Run Migrations
php artisan vendor:publish --provider="Crabbly\Authorize\AuthorizeServiceProvider" --tag="migrations", (*5)
php artisan migrate, (*6)
Step 4: Add the UserAuthorizeTrait to your User model:
<?php
namespace App;
use Crabbly\Authorize\UserAuthorizeTrait;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
use UserAuthorizeTrait;
//...
}
Basics
Tables
After the migration, four new tables will be present:
- roles — stores role records
- role_user — stores many-to-many relations between roles and users
- permissions — stores permission records
- permission_role — stores many-to-many relations between roles and permissions, (*7)
Models
The package comes with two models, Role and Permission., (*8)
Role
The Role model has three main attributes:
- name — Unique name for the Role, used for looking up role information in the application layer. For example: "admin", "owner", "employee".
- display_name — Human readable name for the Role. For example: "User Administrator", "Project Owner", "Company Employee".
- description — A more detailed explanation of what the Role does. This field is optional and nullable in the database., (*9)
Permission
The Permission model has the same three attributes as the Role:
- name — Unique name for the permission, used for looking up permission information in the application layer. For example: "create-post", "edit-user".
- display_name — Human readable name for the permission. Not necessarily unique. For example "Create Posts", "Edit Users".
- description — A more detailed explanation of the Permission., (*10)
Usage
Creating Roles
Create an admin role:, (*11)
<?php
use Crabbly\Authorize\Role;
...
Role::create([
'name' => 'admin',
'display_name' => "Administrator",
'description' => '' //optional
]);
Assigning and Removing Roles
Roles and Users have a Many to Many relationship. We can attach and detach roles to users like this:, (*12)
<?php
//add role of id $role_id to $user
$user->roles()->attach($role_id);
//remove role of id $role_id to $user
$user->roles()->detach($role_id);
Checking if User has a Role
To check if a User is assigned with the Role admin:, (*13)
<?php
if ($user->hasRole('admin')) // pass in role name
{
//admin only code
}
Most apps will probably have an admin Role, for this we can just use:, (*14)
<?php
if ($user->isAdmin())
{
//admin only code
}
Creating Permissions
Create an delete_users permission:, (*15)
<?php
use Crabbly\Authorize\Permission;
...
Permission::create([
'name' => 'delete_users',
'display_name' => "Delete Users",
'description' => '' //optional
]);
Assigning and Removing Permissions
Permissions and Roles have a Many to Many relationship. We can attach and detach permissions to roles like this:, (*16)
<?php
//add permission of id $permission_id to $role
$role->permissions()->attach($permission_id);
//remove permission of id $permission_id to $role
$user->permissions()->detach($permission_id);
Checking if User has Permission
To check if a User has the Permission delete_users:, (*17)
<?php
if ($user->hasPermission('delete_users')) // pass in permission name
{
//delete users code
}
This will check if any of the Roles that were assigned to the user, has the Permission delete_users., (*18)
Contribution
Pull requests are welcome.
Please report any issue you find in the issues page., (*19)
License
Authorize is free software distributed under the terms of the MIT license., (*20)
Wallogit.com
