README

Milebits Authorizer gives you access to simplified role/permissions management system for your laravel application in one simple installation.

How to Install

Install the package

composer require milebits/authorizer

Add it to the Model

use Illuminate\Database\Eloquent\Model;
use Milebits\Authorizer\Concerns\Authorizer;

class User extends Model{
    use Authorizer;
}

Installing the permissions

Once you are satisfied with the actual models that you have in your application, you can run the artisan authorizer:permInstall command in order to generate permissions for every Model that exists in your applicationModels folder.

php artisan authorizer:permInstall

CAUTION: this command should be used only ONCE, and it is highly advised to run it after a fresh migration not after

And that's it, you are done! you can now use this package

How to use it

Relations

User roles

$user= App\Models\User::find(1);

$user->roles();

User permissions

$user= App\Models\User::find(1);

$user->permissions();

Getting permissions

getByClassAction

use App\Models\User;
use Milebits\Authorizer\Models\Permission;

$permissions = Permission::getByClassAction(class: User::class, action: 'viewAny', getCollection: true);

$permissions = Permission::getByClassAction(['class' => User::class, 'action'=> 'viewAny'], getCollection: true);

$permissions = Permission::getByClassAction([User::class, 'viewAny'], getCollection: true);

$permissions = Permission::getByClassAction('App\Models\User.viewAny', getCollection: true);

Methods

Adding a role to a user

use App\Models\User;use Milebits\Authorizer\Models\Role;
$user = User::find(1);

$role = Role::find(2);
$user->addRole($role);

$role = 'admin';
$user->addRole($role);

In this case $role should be the ID of the desired role to add

Removing a role from a user

use App\Models\User;use Milebits\Authorizer\Models\Role;
$user = User::find(1);

$role = Role::find(2);
$user->removeRole($role);

$role = 'admin';
$user->removeRole($role);

In this case $role should be the ID of the desired role to add

Checking if a user has a certain role

use App\Models\User;
use Milebits\Authorizer\Models\Role;
$user = User::find(1);

$heHasIt = $user->hasRole('editor');
$heHasIt = $user->hasRole(Role::find(1));
$heHasIt = $user->hasRole(Role::slug('editor')->first());

Checking if a user has a certain permission

use App\Models\User;use Milebits\Authorizer\Models\Permission;
$user = User::find(1);

$canViewAnyUser = $user->hasPermission('App\Models\User.viewAny');

$canViewAnyUser = $user->hasPermission(class: User::class,action: 'viewAny');

$canViewAnyUser = $user->hasPermission([User::class, 'viewAny']);

$canViewAnyUser = $user->hasPermission([
    'class' => User::class,
    'action' => 'viewAny',
]);

// Or you can do it using the hasPermissions instead of hasPermission
$canViewOrUpdateUser = $user->hasPermissions([1, 2, 3]);

$canViewOrUpdateUser = $user->hasPermissions([
    ...Permission::getByClassAction(action: 'view', pluck: 'id'),
    ...Permission::getByClassAction(action: 'update', pluck: 'id'),
]);

Using Middlewares

HasPermission Middleware

use Milebits\Authorizer\Http\Middleware\HasPermission;
$this->middleware(HasPermission::class.':permission_slug_or_id');

HasRole Middleware

use Milebits\Authorizer\Http\Middleware\HasRole;
$this->middleware(HasRole::class.':role_slug_or_id');

Contributions

If in any case while using this package, and you which to request a new functionality to it, please contact us at suggestions@os.milebits.com and mention the package you are willing to contribute or suggest a new functionality.

Vulnerabilities

If in any case while using this package, you encounter security issues or security vulnerabilities, please do report them as soon as possible by issuing an issue here in Github or by sending an email to security@os.milebits.com with the mention Vulnerability Report milebits/authorizer as your subject.

milebits / authorizer

Maintainers

Details