PHPackages doc88/flux-role-permission - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Authentication & Authorization](/categories/authentication) 4. / 5. doc88/flux-role-permission ActiveLibrary[Authentication & Authorization](/categories/authentication) doc88/flux-role-permission ========================== Library for implementing access control by permissions in Laravel applications. 1.0.2(5y ago)04.4k1MITPHPPHP >= 7.2.0 Since Jul 8Pushed 5y ago1 watchersCompare [ Source](https://github.com/douglas-men/flux-role-permission)[ Packagist](https://packagist.org/packages/doc88/flux-role-permission)[ RSS](/packages/doc88-flux-role-permission/feed)WikiDiscussions master Synced 4d ago READMEChangelog (3)DependenciesVersions (4)Used By (1) Flux Role Permission ==================== [](#flux-role-permission) Library for managing user permissions in Laravel applications. Requirements ============ [](#requirements) - Laravel >= 6.0 Installation ============ [](#installation) - Run the command below at the project root to add the package to the Laravel application: ``` composer require doc88/flux-role-permission ``` - In the *providers* list in the *config/app.php* file add: ``` 'providers' => [ ... Doc88\FluxRolePermission\FluxRolePermissionServiceProvider::class, ] ``` - Run the command below at the root of your project to publish the new provider: ``` php artisan vendor:publish ``` - Run migrations ``` php artisan migrate ``` - In your User Model add the following lines: ``` use Doc88\FluxRolePermission\Traits\HasRolePermissions; class User { use HasRolePermissions; } ``` Usage ===== [](#usage) Doc88\\FluxRolePermission\\Permission Class ------------------------------------------- [](#doc88fluxrolepermissionpermission-class) Class used to List, Register, Verify and Revoke permissions. - **List All Permissions** ``` // All Registered Permissions Permission::all(); // Return (array): [ [ "id" => 3 "name" => "List Companies" "slug" => "list-companies" ], [ "id" => 4 "name" => "Delete Companies" "slug" => "delete-companies" ] ] ``` - **List a Permission** ``` // Get the Permission Permission::get('list-users'); // Return (array): [ "id" => 3 "name" => "List Users" "slug" => "list-users" ] ``` - **Create a Permission** ``` // Creating a new Permission Permission::create('create-companies'); // Return (boolean): true or false ``` - **Delete a Permission** ``` // Deleting a Permission Permission::delete('list-companies'); // Return (boolean): true or false ``` - **List User’s Permissions** ``` // List all the User's Permissions Permission::list($user); // Return (array): [ [ "id" => 3 "name" => "List Companies" "slug" => "list-companies" ], [ "id" => 4 "name" => "Delete Companies" "slug" => "delete-companies" ], [ "id" => 5 "name" => "Create Company" "slug" => "create-companies" ] ] ``` - **Checks a User’s Permission** ``` // Checking if the user has permission Permission::has(auth()->user(), 'list-companies'); // Return (boolean): true or false ``` - **Records permission to an User** ``` // Grants permission for the User Permission::register(auth()->user(), 'list-companies'); // Return (boolean): true or false ``` - **Revokes a permission** ``` // Revokes permission Permission::revoke(auth()->user(), 'list-companies'); // Return (boolean): true or false ``` Using the User Model -------------------- [](#using-the-user-model) It is possible to List, Register, Verify and Revoke permissions using the User class. - **List User Permissions** ``` $user = User::find(1); // User's Permissions $user->listPermissions(); // Return (array): [ [ "id" => 3 "name" => "List Companies" "slug" => "list-companies" ], [ "id" => 4 "name" => "Delete Companies" "slug" => "delete-companies" ], [ "id" => 5 "name" => "Create Company" "slug" => "create-companies" ] ] ``` - **Checks User Permission** ``` $user = User::find(1); // Checking if the user has permission $user->hasPermission('list-companies'); // Return (boolean): true or false ``` - **Records permission to an User** ``` $user = User::find(1); // Grants permission to the User $user->registerPermission('list-companies'); // Return (boolean): true or false ``` - **Revokes permission** ``` $user = User::find(1); // Revokes permission $user->revokePermission('list-companies'); // Return (boolean): true or false ``` Doc88\\FluxRolePermission\\Role Class ------------------------------------- [](#doc88fluxrolepermissionrole-class) Class used to List, Register, Verify and Revoke roles. - **List All Roles** ``` // All Registered Roles Role::all(); // Return (array): [ [ "id" => 3 "name" => "Companies" "slug" => "companies" ], [ "id" => 4 "name" => "Users" "slug" => "users" ] ] ``` - **List a Role** ``` // Get the role Role::get('users'); // Return (array): [ "id" => 5 "name" => "Users" "slug" => "users" "permissions" => { [ 0 => array:3 [ "id" => 3 "name" => "List Users" "slug" => "list-users" ], 1 => array:3 [ "id" => 4 "name" => "Delete Users" "slug" => "delete-users" ], 2 => array:3 [ "id" => 5 "name" => "Create Users" "slug" => "create-users" ] ] } ] ``` - **Create a Role** ``` // Creating a new Role Role::create('Users'); // Creating a new Role with permissions Role::create('users', ['list-users', 'create-users', 'delete-users']); // Return (array): [ "id": 7, "name": "Users", "slug": "users" ] ``` - **Update a Role** ``` // Updating a Role Role::update('users', ['slug' => 'new-slug', 'permissions' => ['list-users', 'create-users']]); // Return (array): [ "id" => 4 "name" => "New Slug" "slug" => "new-slug" "permissions" => { [ "id" => 7 "name" => "List Users" "slug" => "list-users" ], [ "id" => 8 "name" => "Create Users" "slug" => "create-users" ] } ] ``` - **Add Permission to a Role** ``` // Deleting a Role Role::addPermission('sales', 'list-sales'); // Return (boolean): true or false ``` - **Remove Permission from a Role** ``` // Deleting a Role Role::removePermission('sales', 'list-sales'); // Return (boolean): true or false ``` - **Delete a Role** ``` // Deleting a Role Role::delete('sales'); // Return (boolean): true or false ``` - **List User’s Roles** ``` // List all the User's Roles Role::list($user); // Return (array): [ [ "id" => 3 "name" => "Companies" "slug" => "companies" ], [ "id" => 4 "name" => "Sales" "slug" => "sales" ] ] ``` - **Checks a User’s Role** ``` // Checking if the user has role Role::has(auth()->user(), 'companies'); // Return (boolean): true or false ``` - **Records Role to an User** ``` // Grants role for the User Role::register(auth()->user(), 'companies'); // Return (boolean): true or false ``` - **Revokes a Role** ``` // Revokes role Role::revoke(auth()->user(), 'companies'); // Return (boolean): true or false ``` Using the User Model -------------------- [](#using-the-user-model-1) It is possible to List, Register, Verify and Revoke roles using the User class. - **List User Roles** ``` $user = User::find(1); // User's Roles $user->listRoles(); // Return (array): [ [ "id" => 3 "name" => "Companies" "slug" => "companies" ], [ "id" => 4 "name" => "Sales" "slug" => "sales" ] ] ``` - **Checks User Role** ``` $user = User::find(1); // Checking if the user has role $user->hasRole('companies'); // Return (boolean): true or false ``` - **Records role to an User** ``` $user = User::find(1); // Grants role to the User $user->registerRole('companies'); // Return (boolean): true or false ``` - **Revokes role** ``` $user = User::find(1); // Revokes role $user->revokeRole('companies'); // Return (boolean): true or false ``` Middleware ========== [](#middleware) - In the *$routeMiddleware* array in the *app\\Http\\Kernel.php* file add: ``` protected $routeMiddleware = [ ... 'permissions' => Doc88\FluxRolePermission\Http\Middleware\FluxRolePermission::class, ... ] ``` - Middleware Usage: ``` // routes/web.php Route::get('list-companies', 'CompanyController@index')->middleware('permissions:list-companies'); // or Route::group(['middleware' => 'permissions:list-companies'], function () { Route::get('list-companies', 'CompanyController@index'); }); ``` ### Health Score 27 — LowBetter than 49% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community9 Small or concentrated contributor base Maturity52 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~1 days Total 3 Last Release 2135d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/0a267e73f18e12044346da1ead7ff5b8c393b260499471a1d5b155a43884f99b?d=identicon)[doc88](/maintainers/doc88) --- Top Contributors [![douglas-men](https://avatars.githubusercontent.com/u/65043552?v=4)](https://github.com/douglas-men "douglas-men (6 commits)") ### Embed Badge ![Health badge](/badges/doc88-flux-role-permission/health.svg) ``` [![Health](https://phpackages.com/badges/doc88-flux-role-permission/health.svg)](https://phpackages.com/packages/doc88-flux-role-permission) ``` ### Alternatives [namshi/jose JSON Object Signing and Encryption library for PHP. 1.8k99.6M101](/packages/namshi-jose)[league/oauth1-client OAuth 1.0 Client Library 99698.8M106](/packages/league-oauth1-client)[bezhansalleh/filament-shield Filament support for `spatie/laravel-permission`. 2.8k2.9M88](/packages/bezhansalleh-filament-shield)[gesdinet/jwt-refresh-token-bundle Implements a refresh token system over Json Web Tokens in Symfony 70516.4M35](/packages/gesdinet-jwt-refresh-token-bundle)[league/oauth2-google Google OAuth 2.0 Client Provider for The PHP League OAuth2-Client 41721.2M118](/packages/league-oauth2-google)[illuminate/auth The Illuminate Auth package. 9327.3M1.0k](/packages/illuminate-auth) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)