cyrixbiz/acl

There is no license information available for the latest version (1.0) of this package.

An Access Control List for Laravel without Gates

1.0 2019-04-04 15:44 UTC

Requires

• php: >= 7.1
• doctrine/dbal: >=2.9.2

Unknown License

• Christian Kupka

README

With this ACL is it possible to protect routes as well as single methods / functions It's possible to give Single authorizations to users or to divide into roles which can also get single authorizations.

Install the ACL

• Composer

  composer require cyrixbiz/acl dev-master

• Edit config\app and add the following lines

  'providers' => [
  // ...
  cyrixbiz\acl\AclServiceProvider::class,
  // ...
  ];

• Got to your User Model - Default Value: App\Models\User.php and set this

  //after namespace .....
  use cyrixbiz\acl\traits\hasRelation;
  
  //after Notifiable in Class
  //for Example: use Notifiable, hasRelation;
  
  , hasRelation;

• Install all

  php artisan make:acl

• Install a Single Method

  • Allow Arguments:

    • setAuth ( Laravel Auth )
    • setRoutes ( ACL Routes to web.php )
    • setResourceFiles ( Lang and View Files)
    • setTables ( Set Database Tables )
    • setSeeds ( Insert Database Seeds)
    • setAdmin ( Set an Admin )

  • Allow Options

    • setAdmin --admin=Adminname --admin=AdminMail --admin=AdminPassword

      Rules = Name 5 Letters Email Valid-Email and Unique Password = Min. 8 Signs and 3 of 4 Rules 1 Low- and 1 Upper- Case / 1 Number / Special Chars

  php artisan make:acl argument

• Edit App\Http\Kernel and add the following lines

  protected $middlewareGroups = [
    //
  'acl' => [\cyrixbiz\acl\Http\Middleware\Acl::class,
          ],

• Error - Handling

  Exception: PDOException::("SQLSTATE[42000]: Syntax error or access violation: 1071 Specified key was too long; max key length is 767 bytes")

  Fix this Issue:

  • App\Providers

  // after namespace
  use Illuminate\Support\Facades\Schema;
  // Inside Boot-Method
  Schema::defaultStringLength(191);

Config - File

• ACL

  • Enable / Disable the Routeprotection

    'enable' => true | false

  • Method to check the Routes

    'method' => getActionName | getName

    Description: If i use the method 'getActionName', the controller will be used and dissolved for the determination of the resources. Out of the rolecontroller@index it will create role.index. If u use the method 'getName', the alias of the controller will be used for the determination.

    'fallback' => getActionName | getName

    Description: Set a Fallback to Check the Method

  • Set a Secure User

    'superAdmin' => 1 - UserID

    Description: This User has Full Rights and can't be deleted

  • Set a newMemberRole

    'newMemberRole' => 3 - UserID

    Description: Members receive this Role after an active registration

  • Set a Blocked Role

    'blockedRole' => 5 - RoleID

    Description: This Role has zero Rights and can't be deleted. Set a User to this Role and all other Roles and Resources will be deleted.

• Cache

  • Set Cache Time in Seconds

    'time' => '60'

    Description: This Method set the Time to Cache the User-Resources

Usage

Middleware

For Example: Set this to your Route-File and all routes in this group are checked

• routes/web

Route::middleware(['web' , 'acl'])
    ->group(function () {
        Route::get('user', 'cyrixbiz\acl\controller\UserController@index')
            ->name('user.index');
});

Blade

For Example: Single Check @perm @endperm

@perm('user.index')
    <a class="btn btn-xs btn-warning" href="#">Anzeigen</a>
@endperm

For Example: Multi Check @perms @endperms

@perms(['acl.getPermissions' , 'role.user'])
<a class="btn btn-xs btn-success" href="#">Anker</a>
@endperms

For Example: Multi Check, One must true @orPerms @endorPerms

@orPerms(['acl.getPermissions' , 'role.user'])
<a class="btn btn-xs btn-success" href="#">Anker</a>
@endorPerms

Requirements

• Laravel 8.x
• Auth