luongtran / laravel-mongodb-permission-spatie
Permission handling for Laravel using Mongodb (Moloquent) based on Spatie package
Requires
- illuminate/container: ^10.0
- jenssegers/mongodb: 4.0.0-rc1
- luongtran/moloquent: ^1.0.0
- spatie/laravel-permission: ^5.5
This package is not auto-updated.
Last update: 2024-11-04 19:29:51 UTC
README
This package allows to save permissions and roles in a database. It is built extend from Spatie Laravel Permission
Once installed you can do stuff like this:
//adding permissions to a user $user->givePermissionTo('edit articles'); //adding permissions via a role $user->assignRole('writer'); $user2->assignRole('writer'); $role->givePermissionTo('edit articles');
You can test if a user has a permission with Laravel's default can
-function.
$user->can('edit articles');
Install
You can install the package via composer:
$ composer require fahmiardi/laravel-mongodb-permission
This service provider must be installed. And Spatie provider too.
// config/app.php 'providers' => [ ... Spatie\Permission\PermissionServiceProvider::class, Fahmiardi\Mongodb\Permissions\PermissionServiceProvider::class, ];
You can publish the config-file with:
php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="config"
This is the contents of the published config file:
// config/laravel-permission.php return [ /* |-------------------------------------------------------------------------- | Authorization Models |-------------------------------------------------------------------------- */ 'models' => [ /* |-------------------------------------------------------------------------- | Permission Model |-------------------------------------------------------------------------- | | When using the "HasRoles" trait from this package, we need to know which | Eloquent model should be used to retrieve your permissions. Of course, it | is often just the "Permission" model but you may use whatever you like. | | The model you want to use as a Permission model needs to implement the | `Spatie\Permission\Contracts\Permission` contract. | */ 'permission' => Spatie\Permission\Models\Permission::class, /* |-------------------------------------------------------------------------- | Role Model |-------------------------------------------------------------------------- | | When using the "HasRoles" trait from this package, we need to know which | Eloquent model should be used to retrieve your roles. Of course, it | is often just the "Role" model but you may use whatever you like. | | The model you want to use as a Role model needs to implement the | `Spatie\Permission\Contracts\Role` contract. | */ 'role' => Spatie\Permission\Models\Role::class, ], /* |-------------------------------------------------------------------------- | Authorization Tables |-------------------------------------------------------------------------- */ 'table_names' => [ /* |-------------------------------------------------------------------------- | Roles Table |-------------------------------------------------------------------------- | | When using the "HasRoles" trait from this package, we need to know which | table should be used to retrieve your roles. We have chosen a basic | default value but you may easily change it to any table you like. | */ 'roles' => 'roles', /* |-------------------------------------------------------------------------- | Permissions Table |-------------------------------------------------------------------------- | | When using the "HasRoles" trait from this package, we need to know which | table should be used to retrieve your permissions. We have chosen a basic | default value but you may easily change it to any table you like. | */ 'permissions' => 'permissions', /* |-------------------------------------------------------------------------- | User Permissions Table |-------------------------------------------------------------------------- | | When using the "HasRoles" trait from this package, we need to know which | table should be used to retrieve your users permissions. We have chosen a | basic default value but you may easily change it to any table you like. | */ 'user_has_permissions' => 'user_has_permissions', /* |-------------------------------------------------------------------------- | User Roles Table |-------------------------------------------------------------------------- | | When using the "HasRoles" trait from this package, we need to know which | table should be used to retrieve your users roles. We have chosen a | basic default value but you may easily change it to any table you like. | */ 'user_has_roles' => 'user_has_roles', /* |-------------------------------------------------------------------------- | Role Permissions Table |-------------------------------------------------------------------------- | | When using the "HasRoles" trait from this package, we need to know which | table should be used to retrieve your roles permissions. We have chosen a | basic default value but you may easily change it to any table you like. | */ 'role_has_permissions' => 'role_has_permissions', ], ];
Adjust the table_names
config above for support mongodb many to many relationships (using EmbedsMany)
'user_has_permissions' => Fahmiardi\Mongodb\Permissions\Models\EmbedPermission::class, 'user_has_roles' => Fahmiardi\Mongodb\Permissions\Models\EmbedRole::class, 'role_has_permissions' => Fahmiardi\Mongodb\Permissions\Models\EmbedPermission::class,
Usage
First add the Spatie\Permission\Traits\HasRoles
-trait to your User model.
use Illuminate\Foundation\Auth\User as Authenticatable; use Spatie\Permission\Traits\HasRoles; class User extends Authenticatable { use HasRoles; // ... }
This package allows for users to be associated with roles. Permissions can be associated with roles.
A Role
and a Permission
are regular Eloquent-models. They can have a name and can be created like this:
use Spatie\Permission\Models\Role; use Spatie\Permission\Models\Permission; $role = Role::create(['name' => 'writer']); $permission = Permission::create(['name' => 'edit articles']);
The HasRoles
adds eloquent relationships to your models, which can be accessed directly or used as a base query.
$permissions = $user->permissions; $roles = $user->roles()->pluck('name'); // returns a collection
###Using permissions A permission can be given to a user:
$user->givePermissionTo('edit articles'); //you can also give multiple permission at once $user->givePermissionTo('edit articles', 'delete articles'); //you may also pass an array $user->givePermissionTo(['edit articles', 'delete articles']);
A permission can be revoked from a user:
$user->revokePermissionTo('edit articles');
You can test if a user has a permission:
$user->hasPermissionTo('edit articles');
Saved permissions will be registered with the Illuminate\Auth\Access\Gate
-class. So you can
test if a user has a permission with Laravel's default can
-function.
$user->can('edit articles');
###Using roles and permissions A role can be assigned to a user:
$user->assignRole('writer'); // you can also assign multiple roles at once $user->assignRole('writer', 'admin'); $user->assignRole(['writer', 'admin']);
A role can be removed from a user:
$user->removeRole('writer');
Roles can also be synced :
//all current roles will be removed from the user and replace by the array given $user->syncRoles(['writer', 'admin']);
You can determine if a user has a certain role:
$user->hasRole('writer');
You can also determine if a user has any of a given list of roles:
$user->hasAnyRole(Role::all());
You can also determine if a user has all of a given list of roles:
$user->hasAllRoles(Role::all());
The assignRole
, hasRole
, hasAnyRole
, hasAllRoles
and removeRole
-functions can accept a
string, a Spatie\Permission\Models\Role
-object or an \Illuminate\Support\Collection
-object.
A permission can be given to a role:
$role->givePermissionTo('edit articles');
You can determine if a role has a certain permission:
$role->hasPermissionTo('edit articles');
A permission can be revoked from a role:
$role->revokePermissionTo('edit articles');
The givePermissionTo
and revokePermissionTo
-functions can accept a
string or a Spatie\Permission\Models\Permission
-object.
Saved permission and roles are also registered with the Illuminate\Auth\Access\Gate
-class.
$user->can('edit articles');
###Using blade directives This package also adds Blade directives to verify whether the currently logged in user has all or any of a given list of roles.
@role('writer') I'm a writer! @else I'm not a writer... @endrole
@hasrole('writer') I'm a writer! @else I'm not a writer... @endhasrole
@hasanyrole(Role::all()) I have one or more of these roles! @else I have none of these roles... @endhasanyrole
@hasallroles(Role::all()) I have all of these roles! @else I don't have all of these roles... @endhasallroles
You can use Laravel's native @can
directive to check if a user has a certain permission.
Using a middleware
The package doesn't contain a middleware to check permissions but it's very trivial to add this yourself.
$ php artisan make:middleware RoleMiddleware
This will create a RoleMiddleware for you, where you can handle your role and permissions check.
// app/Http/Middleware/RoleMiddleware.php use Auth; ... public function handle($request, Closure $next, $role, $permission) { if (Auth::guest()) { return redirect($urlOfYourLoginPage); } if (! $request->user()->hasRole($role)) { abort(403); } if (! $request->user()->can($permission)) { abort(403); } return $next($request); }
Don't forget to add the route middleware to your Kernel:
// app/Http/Kernel.php protected $routeMiddleware = [ ... 'role' => \App\Http\Middleware\RoleMiddleware::class, ... ];
Now you can protect your routes using the middleware you just set up:
Route::group(['middleware' => ['role:admin,access_backend']], function () { // });
Extending
If you need to extend or replace the existing Role
or Permission
models you just need to
keep the following things in mind:
- Your
Role
model needs to implement theSpatie\Permission\Contracts\Role
contract - Your
Permission
model needs to implement theSpatie\Permission\Contracts\Permission
contract - You must publish the configuration with this command:
php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="config"
and update themodels.role
andmodels.permission
values
Unit Test
Soon.