README

This is an authentication plugin for Filament Admin with Laravel-permission

Installation

1. Ensure you have already installed the Filament panel.

2. You can install the package via composer:

   composer require solution-forest/filament-access-management

3. Add the necessary trait to your User model:

   use SolutionForest\FilamentAccessManagement\Concerns\FilamentUserHelpers;
   
   class User extends Authenticatable
   {
       use FilamentUserHelpers;
   }

4. Clear your config cache:

    php artisan optimize:clear
    # or
    php artisan config:clear

5. 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());
    }

6. 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

7. Call upgrade command to upgrade data after version 2.2.0

   php artisan filament-access-management:upgrade

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 Menu:

Manage Users and their roles:

Manage Roles and their permissions:

Manage Permissions:

Routing control

In this plugin, permissions and routes are bound together, set the routes that the current permissions can access in the edit permissions page, select the method to access the routes in the HTTP method select box, and fill in the path that can be accessed in the HTTP path.

For example, if you want to add a permission, which can access the path /admin/users by GET, then HTTP method select GET, and HTTP path fill in /users.

If you want to access all the paths prefixed with /admin/users, then HTTP path fill in /users*; if you want to access the edit page, then HTTP path fill in /users/*/edit; if the method of each path in multiple paths is different, then HTTP path fill in GET:users/*'. .

If the above method is not sufficient, HTTP path also supports routing aliases, such as admin.users.show.

Super Administrator

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:

1. 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

• Carly
• All Contributors

License

The MIT License (MIT). Please see License File for more information.