Stars: 135
Forks: 16
Pull Requests: 21
Issues: 12
Watchers: 4
Last Updated: 2023-09-04 19:33:20
Admin user, role and permission management for Laravel Filament
License: MIT License
Languages: PHP, Blade, Just
Opinionated setup for managing admin users, roles and permissions within Laravel Filament
composer require chiiya/filament-access-control
config/filament.php
file to use the package's guard and Login
page:'auth' => [
'guard' => env('FILAMENT_AUTH_GUARD', 'filament'),
'pages' => [
'login' => \Chiiya\FilamentAccessControl\Http\Livewire\Login::class,
],
],
php artisan vendor:publish --tag="filament-access-control-migrations"
php artisan vendor:publish --tag="filament-access-control-config"
php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider"
php artisan migrate
To seed the necessary base data (role & permissions), run php artisan filament-access-control:install
or call the Chiiya\FilamentAccessControl\Database\Seeders\FilamentAccessControlSeeder
seeder in your database seeder.
Create an admin user using php artisan filament-access-control:user
. If you create users programmatically
(e.g. in your database seeder), make sure to assign them the super-admin
role if you want them to be able to
access the role and user management.
Optionally, you can publish the translations with:
php artisan vendor:publish --tag="filament-access-control-translations"
Optionally, you can publish the views with:
php artisan vendor:publish --tag="filament-access-control-views"
To authorize access to resources, use policies as described in the Filament documentation.
class ProductPolicy
{
public function viewAny(FilamentUser $user): bool
{
return $user->can('products.view');
}
// ...
}
This package comes with a simple trait that you can use to authorize access to custom pages based on a permission.
use Chiiya\FilamentAccessControl\Traits\AuthorizesPageAccess;
class MyPage extends Page
{
use AuthorizesPageAccess;
public static string $permission = 'my-page.view';
public function mount(): void
{
static::authorizePageAccess();
}
}
One way to authorize actions is to use the visible()
method:
ButtonAction::make('exports')
->visible(fn () => Filament::auth()->user()->can('exports.view'))
Roles and permissions should have names that make them easy to use in code (e.g. admin-users.update
).
For the admin you may however wish to localize them or make them more readable. You can do so by simply
adding a JSON translation entry for the given role or permission name (e.g. lang/en.json
):
{
"admin-users.update": "Admin Users → Edit"
}
With the optional account expiry feature, all accounts require an expiration date. When accounts are expired, they can no longer log in. To enable the account expiry feature, enable the feature flag in the config file:
'features' => [
\Chiiya\FilamentAccessControl\Enumerators\Feature::ACCOUNT_EXPIRY,
],
You will also need to add the EnsureAccountIsNotExpired
middleware to your filament auth middleware config:
use Chiiya\FilamentAccessControl\Http\Middleware\EnsureAccountIsNotExpired;
'middleware' => [
'auth' => [
Authenticate::class,
EnsureAccountIsNotExpired::class,
],
]
With the optional two-factor authentication feature, users must enter a verification code sent via email upon login. To enable the two-factor authentication feature, enable the feature flag in the config file:
'features' => [
\Chiiya\FilamentAccessControl\Enumerators\Feature::TWO_FACTOR,
],
To use your own custom user model for the admin (instead of Chiiya\FilamentAccessControl\Models\FilamentUser
),
point the value of user_model
in the filament-access-control
config file to your own model.
'user_model' => CustomFilamentUser::class,
Please make sure that your model either extends the FilamentUser
base case or implements the
Chiiya\FilamentAccessControl\Contracts\AccessControlUser
interface.
use Chiiya\FilamentAccessControl\Models\FilamentUser;
use Chiiya\FilamentAccessControl\Contracts\AccessControlUser;
use Filament\Models\Contracts\FilamentUser as FilamentUserInterface;
use Filament\Models\Contracts\HasName;
use Illuminate\Foundation\Auth\User as Authenticatable;
class CustomFilamentUser extends FilamentUser
{
// ...
}
// Or alternatively
class CustomFilamentUser extends Authenticatable implements AccessControlUser, FilamentUserInterface, HasName
{
// ...
}
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
The MIT License (MIT). Please see License File for more information.