solution-forest / filament-access-management
filament-access-management
Requires
- php: ^8.1
- filament/filament: ^3.0
- guava/filament-icon-picker: ^2.0
- solution-forest/filament-tree: ^2.0.0
- spatie/laravel-package-tools: ^1.15.0
- spatie/laravel-permission: ^5.5|^6.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.9
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^8.0
- pestphp/pest: ^2.0
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- spatie/laravel-ray: ^1.26
This package is not auto-updated.
Last update: 2024-04-25 10:16:29 UTC
README
This is an authentication plugin for Filament Admin with Laravel-permission
Installation
-
You can install the package via composer:
composer require solution-forest/filament-access-management
-
Add the necessary trait to your User model:
use SolutionForest\FilamentAccessManagement\Concerns\FilamentUserHelpers; class User extends Authenticatable { use FilamentUserHelpers; }
-
Clear your config cache:
php artisan optimize:clear # or php artisan config:clear
-
Then execute the following commands:
php artisan filament-access-management:install
If you don't already have a user named
admin
, this command creates a Super Admin User with the following credentials:- Name: admin
- E-mail address: admin@("slug" pattern from config("app.name")).com
- Password: admin
You can also create the super admin user with:
php artisan make:super-admin-user
-
Register the plugin in your Panel provider:
Important: Register the plugin in your Panel provider after version 2.x
use SolutionForest\FilamentAccessManagement\FilamentAccessManagementPanel; public function panel(Panel $panel): Panel { return $panel ->plugin(FilamentAccessManagementPanel::make()); }
Publish Configs, Views, Translations and Migrations
You can publish the configs, views, translations and migrations with:
php artisan vendor:publish --tag="filament-access-management-config" php artisan vendor:publish --tag="filament-access-management-views" php artisan vendor:publish --tag="filament-access-management-translations" php artisan vendor:publish --tag="filament-access-management-migrations"
Migration
php artisan migrate
Usage
Upon installation, "Menu", "Users", "Roles" and "Permissions" pages will be created. Each user have roles and each role have permissions.
Manage Roles and their permissions:
Create super admin user:
php artisan make:super-admin-user
Check permission:
# Check by permission's name \SolutionForest\FilamentAccessManagement\Http\Auth\Permission::check($name) # Check by http_path \SolutionForest\FilamentAccessManagement\Http\Auth\Permission::checkPermission($path)
Get current user:
\SolutionForest\FilamentAccessManagement\Facades\FilamentAuthenticate::user();
Advance Usage
In default, the menu created will co-exist with the original menu of filament. To override the original menu with the menu from this package, modify /config/filament-access-management.php
as following:
- Set
filament.navigation.enabled => true
'filament' => [ ... 'navigation' => [ /** * Using db based filament navigation if true. */ 'enabled' => true, /** * Table name db based filament navigation. */ 'table_name' => 'filament_menu', /** * Filament Menu Model. */ 'model' => Models\Menu::class, ] ... ]
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.