PHPackages bbs-lab/nova-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. bbs-lab/nova-permission ActiveLibrary[Authentication & Authorization](/categories/authentication) bbs-lab/nova-permission ======================= A Laravel Nova permission tool. v1.1.1(12mo ago)69.0k↓33.3%3MITPHPPHP ^8.1 || ^8.2 || ^8.3CI failing Since Nov 21Pushed 12mo ago6 watchersCompare [ Source](https://github.com/BBS-Lab/nova-permission)[ Packagist](https://packagist.org/packages/bbs-lab/nova-permission)[ RSS](/packages/bbs-lab-nova-permission/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (9)Dependencies (20)Versions (13)Used By (0) Laravel Nova permission tool ============================ [](#laravel-nova-permission-tool) [![Latest Version on Packagist](https://camo.githubusercontent.com/3b5ed6bea1b6cd6167681198a54c2806b4225b030a9d59c18f43901039dced0f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6262732d6c61622f6e6f76612d7065726d697373696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/bbs-lab/nova-permission)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![StyleCI](https://camo.githubusercontent.com/b04ee0bc8a6cd188e534a709ad22867f5ca4b82f5fa68bc7cafb0c5183fee5c5/68747470733a2f2f7374796c6563692e696f2f7265706f732f3232303738343931312f736869656c64)](https://styleci.io/repos/220784911)[![Quality Score](https://camo.githubusercontent.com/b196712eb26014ed2f32c45ce28ae3f6d42cdd80ba50236978c12384f832d4d9/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f6262732d6c61622f6e6f76612d7065726d697373696f6e2e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/bbs-lab/nova-permission)[![Total Downloads](https://camo.githubusercontent.com/fd95ebbb18dca3c4115df0143b323c68e8aa9b9ed10a21db4cd2af994e8f6d73/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6262732d6c61622f6e6f76612d7065726d697373696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/bbs-lab/nova-permission) Based on [spatie/permission](https://github.com/spatie/laravel-permission), this tool gives you ability to manage roles and permission. The tool provides permission builder. [![permission tool screenshot](docs/nova-permission-tool.png)](docs/nova-permission-tool.png) Contents -------- [](#contents) - [Installation](#installation) - [Usage](#usage) - [Generate permissions](#generate-permissions) - [Protect resources](#protect-resources) - [Super admin](#super-admin) - [Changelog](#changelog) - [Security](#security) - [Contributing](#contributing) - [Credits](#credits) - [License](#license) Installation ------------ [](#installation) To get started, you will need to install the following dependencies ``` composer require bbs-lab/nova-permission ``` The service provider will automatically get registered. Or you may manually add the service provider in your `config/app.php` file: ``` 'providers' => [ // ... BBSLab\NovaPermission\NovaPermissionServiceProvider::class, ], ``` You should publish the migrations with: ``` php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="migrations" php artisan vendor:publish --provider="BBSLab\NovaPermission\NovaPermissionServiceProvider" --tag="migrations" ``` You can publish the config files with: ``` php artisan vendor:publish --provider="BBSLab\NovaPermission\NovaPermissionServiceProvider" --tag="config" ``` This will publish `config/permission.php` and `config/nova-permission.php` files with the following contents: ``` // config/permission.php return [ 'models' => [ /* * When using the "HasPermissions" 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 * `BBSLab\NovaPermission\Contracts\Permission` contract. */ 'permission' => BBSLab\NovaPermission\Models\Permission::class, /* * 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 * `BBSLab\NovaPermission\Contracts\Role` contract. */ 'role' => BBSLab\NovaPermission\Models\Role::class, ], 'table_names' => [ /* * 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', /* * When using the "HasPermissions" 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', /* * When using the "HasPermissions" trait from this package, we need to know which * table should be used to retrieve your models permissions. We have chosen a * basic default value but you may easily change it to any table you like. */ 'model_has_permissions' => 'model_has_permissions', /* * When using the "HasRoles" trait from this package, we need to know which * table should be used to retrieve your models roles. We have chosen a * basic default value but you may easily change it to any table you like. */ 'model_has_roles' => 'model_has_roles', /* * 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', ], 'column_names' => [ /* * Change this if you want to name the related model primary key other than * `model_id`. * * For example, this would be nice if your primary keys are all UUIDs. In * that case, name this `model_uuid`. */ 'model_morph_key' => 'model_id', ], /* * When set to true, the required permission/role names are added to the exception * message. This could be considered an information leak in some contexts, so * the default setting is false here for optimum safety. */ 'display_permission_in_exception' => false, 'cache' => [ /* * By default all permissions are cached for 24 hours to speed up performance. * When permissions or roles are updated the cache is flushed automatically. */ 'expiration_time' => \DateInterval::createFromDateString('24 hours'), /* * The cache key used to store all permissions. */ 'key' => 'spatie.permission.cache', /* * When checking for a permission against a model by passing a Permission * instance to the check, this key determines what attribute on the * Permissions model is used to cache against. * * Ideally, this should match your preferred way of checking permissions, eg: * `$user->can('view-posts')` would be 'name'. */ 'model_key' => 'name', /* * You may optionally indicate a specific cache driver to use for permission and * role caching using any of the `store` drivers listed in the cache.php config * file. Using 'default' here means to use the `default` set in cache.php. */ 'store' => 'default', ], ]; ``` ``` // config/nova-permission return [ 'authorizable_models' => [ // \App\Models\Post::class, ], 'generate_without_resources' => [ \Laravel\Nova\Actions\ActionResource::class, \BBSLab\NovaPermission\Resources\Role::class, \BBSLab\NovaPermission\Resources\Permission::class, ] ]; ``` After the migration has been published you can create the role and permission tables by running the migrations : ``` php artisan migrate ``` Usage ----- [](#usage) You must register the tool with Nova. This is typically done in the `tools` method of the `NovaServiceProvider`: ``` // app/Providers/NovaServiceProvider.php