Download the PHP package mistery23/laravel-roles without Composer

Laravel Roles

Table of contents

• About
• Features
• Installation
  • Composer
  • Service Provider
  • Publish All Assets
  • Publish Specific Assets
  • HasRoleAndPermission Trait And Contract
  • Migrations and Seeds
• Usage
  • Creating Roles
  • Attaching, Detaching Roles and Permissions
  • Assign a user role to new registered users
  • Checking For Roles
  • Levels
  • Creating Permissions
  • Attaching, Detaching and Syncing Permissions
  • Checking For Permissions
  • Permissions Inheriting
  • Entity Check
  • Blade Extensions
  • Middleware
• Configuration
  • Environment File
• Optional API Routes
• Tests
• File Tree
• License

About

A Powerful package for handling roles and permissions in Laravel. Supports Laravel 5.8, and 6.0.

Features

Installation

This package is very easy to set up. There are only couple of steps.

Composer

From your projects root folder in terminal run:

Laravel 5.8 and up use:

Service Provider

• Laravel 5.8 and up Uses package auto discovery feature, no need to edit the config/app.php file.

Publish All Assets

Publish Specific Assets

HasRoleAndPermission Trait And Contract

1. Include HasRoleAndPermission trait and also implement HasRoleAndPermission contract inside your User model. See example below.

2. Include use Mistery23\LaravelRoles\Traits\HasRoleAndPermission; in the top of your User model below the namespace and implement the HasRoleAndPermission trait. See example below.

Example User model Trait And Contract:

Migrations and seeds

This uses the default users table which is in Laravel. You should already have the migration file for the users table available and migrated.

1. Setup the needed tables:

   php artisan migrate

2. Check config/roles-seed.php. For create/update your role and perm.

3. Setup role and perm:

   php artisan roles:gen

4. Seed an initial set of Permissions, Roles. Attach role/permission to user please implement in your project. For this you should use complete use cases:

   Mistery23\LaravelRoles\Model\UseCases\User\Attach\Role Mistery23\LaravelRoles\Model\UseCases\User\Attach\Permission

Roles Seeded

Permissions Seeded:

Usage

Creating Roles

Attaching, Detaching Role and Permissions

See Mistery23\LaravelRoles\Model\UseCases\... for all actions for role, permission and user.

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:

Levels

When you are creating roles, there is optional parameter level. It is set to 1 by default, but you can overwrite it and then you can do something like this:

If user has multiple roles, method level returns the highest one.

Level has also big effect on inheriting permissions. About it later.

Checking For Permissions

You can check for multiple permissions the same way as roles. You can make use of additional methods like hasOnePermission or hasAllPermissions.

Permissions Inheriting

Role with higher level is inheriting permission from roles with lower level.

There is an example of this magic:

You have three roles: user, moderator and admin. User has a permission to read articles, moderator can manage comments and admin can create articles. User has a level 1, moderator level 2 and admin level 3. It means, moderator and administrator has also permission to read articles, but administrator can manage comments as well.

If you don't want permissions inheriting feature in you application, simply ignore level parameter when you're creating roles.

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 four Blade extensions. Basically, it is replacement for classic if statements.

Middleware

This package comes with VerifyRole, VerifyPermission and VerifyLevel middleware. The middleware aliases are already registered in \Mistery23\LaravelRoles\RolesServiceProvider.

Now you can easily protect your routes.

It throws \Mistery23\LaravelRoles\App\Exceptions\RoleDeniedException, \Mistery23\LaravelRoles\App\Exceptions\PermissionDeniedException or \Mistery23\LaravelRoles\App\Exceptions\LevelDeniedException exceptions if it goes wrong.

You can catch these exceptions inside app/Exceptions/Handler.php file and do whatever you want.

Configuration

• You can change connection for models, models path and there is also a handy pretend feature.
• There are many configurable options which have been extended to be able to configured via .env file variables.
• Editing the configuration file directly may not needed because of this.

Configuration seed data

Tests

Environment File

Optional API Routes

File Tree

• Tree command can be installed using brew: brew install tree
• File tree generated using command tree -a -I '.idea|.git|node_modules|vendor|storage|tests|composer.lock'

License

This package is free software distributed under the terms of the MIT license. Enjoy!