drafolin / filament-inverse-shield
Package to facilitate persistance of Filament Shield's roles and permissions
Requires
- bezhansalleh/filament-shield: ^3.0
- illuminate/support: >=10.0
- laravel/framework: >= 10.0
- spatie/laravel-permission: ^6.10
README
This plugin is aimed to users of the Filament Shield plugin, who want to persist their settings in a file, and load them back later.
Introduction
By default, the Filament Shield plugin saves roles and roles/permission relationships in the database. This makes it quite difficult to manage the roles and permissions in a version control system, or to share them between different instances of the same application.
This plugin allows you to save the roles and permissions in a seeder file, which can be loaded back later.
Installation
To install this plugin, you need to add it to your composer.json file:
composer require drafolin/filament-inverse-shield
Usage
To save the roles and permissions in a seeder file, you need to run the following command:
php artisan inverse-shield
This will create a seeder file in the database/seeds directory.
To load the roles and permissions from the seeder file, you need to run the following command:
php artisan db:seed --class=ShieldSeeder
Caution
This command deletes all roles and permissions, restoring them to the time the inverse-shield command was run.
It also tries its best to restore the roles to each user, accordingly to the name of the role. If the role was renamed, the user will lose the role. A warning will be displayed in this case.
Parameters
The inverse-shield command supports the default artisan parameters, as well as the following custom parameters:
--seeder: The name of the seeder file to create. Default:ShieldSeeder.--panel: The name of the filament panel to use, if you renamed it. Default:web.
License
This plugin is open-sourced software licensed under the MIT license.