robypz/laravel-mongo-roles

Simple roles and permission for Laravel using MongoDB.

1.0.2 2025-07-28 14:49 UTC

Requires

• illuminate/auth: ^12.0
• illuminate/database: ^12.0
• illuminate/support: ^12.0
• mongodb/laravel-mongodb: ^5.2

Requires (Dev)

• orchestra/testbench: ^10.4
• pestphp/pest: ^3.8

MIT

• Robert Yepez

README

Logo

Simple roles and permissions for Laravel using MongoDB.

Features

• Middleware for roles and permissions.
• Blade directives for roles and permissions.
• Integration with mongodb/laravel-mongodb.
• Ready-to-use migrations and seeders.
• Easy to extend and customize.

Installation

1. Install the package via Composer:

   composer require robypz/laravel-mongo-roles

2. Publish and run the migrations:

   php artisan vendor:publish --provider="RobYpz\MongoRole\Providers\MongoRoleServiceProvider" --tag=migrations
   php artisan migrate

3. Add the ServiceProvider if necessary:

   In config/app.php:

   'providers' => [
       // ...
       RobYpz\MongoRole\Providers\MongoRoleServiceProvider::class,
   ],

Usage

Seeders

Example seeder to create users, roles, and permissions:

use RobYpz\MongoRole\Models\Role;
use RobYpz\MongoRole\Models\Permission;
use Workbench\Database\Factories\UserFactory;

$user = UserFactory::new()->create([
    'name' => 'Test User',
    'email' => '[e-mail]',
]);

$role = Role::create(['name'=> 'role']);
$permission = Permission::create(['name'=> 'permission']);

$role->permissions()->attach($permission);
$user->roles()->attach($role);

Middleware

Protect your routes using the middlewares:

Route::get('/hasRole', function () {
    return response(null,200);
})->middleware(['auth','role:role']);

Route::get('/hasPermission', function () {
    return response(null,200);
})->middleware(['auth','permission:permission']);

Route::get('/hasAnyRole', function () {
    return response(null,200);
})->middleware(['auth','any_role:role,anotherRole']);

Route::get('/hasAnyPermission', function () {
    return response(null,200);
})->middleware(['auth','any_permission:permission,anotherPermission']);

Route::get('/PermissionTo', function () {
    return response(null,200);
})->middleware(['auth','permission_to:permission']);

Route::get('/hasAnyPermissionTo', function () {
    return response(null,200);
})->middleware(['auth','any_permission_to:permission,anotherPermission']);

Blade Directives

@role('role')
    Welcome user with role
@endrole

@permission('permission')
    Welcome user with permission
@endpermission

@any_role('role,anotherRole')
    Welcome user with any of the roles
@endany_role

@any_permission('permission,anotherPermission')
    Welcome user with any of the permissions
@endany_permission

@permission_to('permission,anotherPermission')
    Welcome user with any of the permissions
@endpermission_to

@any_permission_to('permission,anotherPermission')
    Welcome user with any of the permissions
@end_any_permission_to

Traits: HasMongoRoles & HasMongoPermissions

HasMongoRoles

Add the HasMongoRoles trait to your User model to enable role and permission management via MongoDB.

Methods

• roles()
  Returns the roles related to the user.

• hasRole(string|array $roles): bool
  Returns true if the user has all the specified roles.

• hasAnyRole(string|array $roles): bool
  Returns true if the user has at least one of the specified roles.

• hasPermission(string|array $permissions): bool
  Returns true if the user has all the specified permissions through their roles.

• hasAnyPermission(string|array $permissions): bool
  Returns true if the user has at least one of the specified permissions through their roles.

HasMongoPermissions

This trait provides an alternative approach: assign permissions directly to users, without roles.
Note: HasMongoPermissions is already included in HasMongoRoles, so you do not need to add both.

Methods

• permissions()
  Returns the permissions related to the user.

• hasPermissionTo(string|array $permissions): bool
  Returns true if the user has all the specified direct permissions.

• hasAnyPermissionTo(string|array $permissions): bool
  Returns true if the user has at least one of the specified direct permissions.

Add the trait to your User model:

use RobYpz\MongoRole\Traits\HasMongoRoles;

class User extends Authenticatable
{
    use HasMongoRoles; // Includes HasMongoPermissions
    // ...

Testing

Includes tests with Pest and Orchestra Testbench:

composer test

Configuration

You can customize the configuration in src/config/mongorole.php.

License

MIT © Robert Yepez

Logo

Package Structure

• src/ Main source code.
• workbench/ Development and testing environment.
• tests/ Unit and functional tests.
• art/ Graphic resources (logo).

Questions or suggestions? Open an issue or contact me directly.