powerlib/acl

A simple sitemap generator for Laravel.

Codebank/Laravel-ACL

Laravel ACL adds role based permissions to built in Auth System of Laravel 5. ACL middleware protects routes methods., _(*1)

Table of Contents

• Team Members
• Requirements
• Getting Started
• Documentation
• Roadmap

Team Members

• Ajay Bhosale (ajay.bhosale@silicus.com)

Requirements

• This package requires following things
• PHP 5.5+
• MySQL 5.5+
• Laravel 5.1

Getting Started

1. On root level create a folder named as "packages"., _(*2)

2. Copy and past "Codebank/Acl" into "packages" folder., _(*3)

3. Require the package in your 'composer.json' and update your dependency with 'composer update':, _(*4)

    "psr-4": {
            "App\\": "app/",
            "Codebank\\Acl\\": "packages/Codebank/Acl/src/" 
        }

1. Add the package to your application service providers in 'config/app.php'.

    'providers' => [
        'Codebank\Acl\AclServiceProvider',
    ],

1. Publish the package migrations to your application and run these with `php artisan migrate. $ php artisan vendor:publish --provider="Codebank\Acl\AclServiceProvider", _(*5)

2. Add the middleware to your 'app/Http/Kernel.php', _(*6)

    protected $routeMiddleware = [
        'acl' => 'Codebank\Acl\Middleware\Acl',
    ];

1. Add the "UserPermission" trait to your 'User' model.

    use Codebank\Acl\Traits\UserPermission;


    class User extends Model implements AuthenticatableContract, CanResetPasswordContract {

        use Authenticatable, CanResetPassword, UserPermission;

    }

Documentation

1. Add permission as an array into config/view.php

    'permission' => []

1. Adding rules into 'app/Http/routs.php'. You have to specify module name as well as action name inside 'permission'

    Route::group(['middleware' => ['auth', 'acl']], function()
        {
            Route::get('/contact', [
                'uses'       => 'ContactController@index',
                'permission' => ['module' => 'contact', 'action' => 'view']
            ]);

            Route::get('/contact/show', [
                'uses'       => 'ContactController@show',
                'permission' => ['module' => 'contact', 'action' => 'show']
            ]);

            Route::get('/contact/create', [
                'uses'       => 'ContactController@create',
                'permission' => ['module' => 'contact', 'action' => 'create']
            ]);

            Route::get('/contact/store', [
                'uses'       => 'ContactController@store',
                'permission' => ['module' => 'contact', 'action' => 'store']
            ]);

            Route::get('/contact/edit', [
                'uses'       => 'ContactController@edit',
                'permission' => ['module' => 'contact', 'action' => 'edit']
            ]);

            Route::get('/contact/update', [
                'uses'       => 'ContactController@update',
                'permission' => ['module' => 'contact', 'action' => 'update']
            ]);

            Route::get('/contact/destroy', [
                'uses'       => 'ContactController@destroy',
                'permission' => ['module' => 'contact', 'action' => 'destroy']
            ]);
        });

1. Control the menu based on permission in view/template section.

    @if (!Auth::guest())

@if(auth()->user()->can('view', 'contact'))
• Show
@endif @if(auth()->user()->can('create', 'contact'))
• Create
@endif @if(auth()->user()->can('save', 'contact'))
• Store
@endif @if(auth()->user()->can('edit', 'contact'))
• Edit
@endif @if(auth()->user()->can('update', 'contact'))
• Update
@endif @if(auth()->user()->can('delete', 'contact'))
• Destroy
@endif

Roadmap

Here's the TODO list for the next release (2.0)., _(*7)

• [ ] Refactoring the source code.
• [ ] Correct all issues.