Chuimi/Laravel-ACL
, (*1)
Laravel ACL adds role based permissions to built in Auth System of Laravel 5. ACL middleware protects routes and even crud controller methods., (*2)
Table of Contents
Requirements
- This package requires PHP 5.5+
Getting Started
- Require the package in your
composer.json
and update your dependency with composer update
:
"require": {
...
"kodeine/laravel-acl": "~1.0@dev",
...
},
- Add the package to your application service providers in
config/app.php
.
'providers' => [
'Illuminate\Foundation\Providers\ArtisanServiceProvider',
'Illuminate\Auth\AuthServiceProvider',
...
'Chuimi\Acl\AclServiceProvider',
],
- Publish the package migrations to your application and run these with `php artisan migrate.
$ php artisan vendor:publish --provider="Chuimi\Acl\AclServiceProvider"
Use your own models.
Once you publish, it publishes the configuration file where you can define your own models which should extend to Acl models., (*3)
- Add the middleware to your
app/Http/Kernel.php
.
protected $routeMiddleware = [
....
'acl' => 'Chuimi\Acl\Middleware\HasPermission',
];
- Add the HasRole trait to your
User
model.
use Chuimi\Acl\Traits\HasRole;
class User extends Model implements AuthenticatableContract, CanResetPasswordContract
{
use Authenticatable, CanResetPassword, HasRole;
}
Documentation
Follow along the Wiki to find out more., (*4)
Roadmap
Here's the TODO list for the next release (2.0)., (*5)
- [ ] Refactoring the source code.
- [ ] Correct all issues.
- [ ] Adding cache to final user permissions.
Change Logs
September 22, 2016
* [x] Added unit tests, (*6)
September 20, 2016
* [x] Added support for Laravel 5.3, (*7)
September 19, 2016
* [x] Added cache support to Roles and Permissions., (*8)
June 14, 2015
* [x] Added backward compatibility to l5.0 for lists() method.
* [x] Added Blade Template Extensions., (*9)
March 28, 2015
* [x] Added Role Scope to get all users having a specific role. e.g User::role('admin')->get();
will list all users having admin
role., (*10)
March 7, 2015
* [x] is()
and can()
methods now support comma for AND
and pipe as OR
operator. Or pass an operator as a second param. more information
* [x] You can bind multiple permissions together so they inherit ones permission. more information, (*11)
Contribution Guidelines
Support follows PSR-2 PHP coding standards, and semantic versioning., (*12)
Please report any issue you find in the issues page.
Pull requests are welcome., (*13)