Grant Users the superpower of Marvel characters

Download

composer require inani/maravel-permissions

Installation

Then include the service provider inside

config/app.php

'providers' => [
    ...
    Inani\Maravel\Providers\MaravelServiceProvider::class,
    ...
];

Publish resources, and migrate

php artisan vendor:publish

PS : You can edit

2020_05_27_221346_add_role_id_to_users

Edit the

config/maravels.php

 [
        'add', 'delete', 'create', 'search', 'update'
    ],

// define the class path for the entities
'entities' => [
    \App\Models\User::class,
],
];

And then migrate

php artisan migrate

Setup a Model

To setup the user model, all you have to do is add (and import) the

IsMarvel

use Inani\Maravel\HasRole;

class User extends Model
{
    use HasRole;
    ...
}

Usage

All roles are role and permissions are powers

Because every user deserves to be a hero, The Maravel API is based on the Marvel Jargon, and here are how it can be used

// Having a user
$user = User::first();

// Create a new role, description is not mandotary
$userManager = RoleBuilder::create('User Manager', 'The role to manage users')
                ->havingPower([
                   'name' => 'can_update',
                   'description' => 'The abilitiy to update a user',
                   'action' => 'update',
                   'entity' => \App\Models\User::class,
               ]);
// we can grant a power to it
$userManager = RoleBuilder::of($userManager)
                        ->grant([
                             'name' => 'can_create',
                             'description' => 'The abilitiy to create a user',
                             'action' => 'create',
                             'entity' => \App\Models\User::class,
                         ]);
// Or take it off
$ability = Ability::first();
$storm = RoleBuilder::of($userManager)->takeOff($ability);
// bless the user with the abilities of the role
$user->roleManager()->blessWith($storm);
// check if it has the ability
$user->roleManager()->owns($ability);
// check if it has one of the provided abilities
$user->roleManager()->ownsOneOf([$ability, $anOtherAbility]);
// make it human again (remove its role)
$user->roleManager()->humanize();

You can also manage the instances directly ```php

// Create Ability $ability = Ability::create([ 'name' => 'post_write', 'description' => 'Abitlity to create new Posts', 'action' => 'add', 'entity' => \App\Models\Post::class, ]);

// Create a Marvel $writer = Role::create([ 'name' => 'Webmaster', 'description' => 'A Role that allows you create new posts' ]);

// Grant the ability $writer->grant($ability);

// remove a certain ability $writer->takeOff($ability);

// remove all and keep only those $abilities = [1, 2]; // or the models $writer->keep($abilities);

// bless it to our user $user = \App\Models\User::first();

$user->roleManager()->blessWith($writer); ```

Am I missing something?

Submit a PR or issue with details!