Loading Policy class for multi Authenticatable

[oanhnn]

Sorry, my English not good. Please update this post if you understand my problem.

Problem

Currently, Laravel support multi auth (multi Authenticatable) like:

// app/Models/User.php
namespace App\Models;

// ...

class User extends Authenticatable
{
    // ...
}

// app/Models/Staff.php
namespace App\Models;

// ...

class Staff extends Authenticatable
{
    // ...
}

// config/auth.php
return [
    'defaults' => [
        'guard' => 'web',
        'passwords' => 'users',
    ],
    'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
        'staff' => [
            'driver' => 'session',
            'provider' => 'staffs',
        ],
    ],
    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\Models\User::class,
        ],
        'staffs' => [
            'driver' => 'eloquent',
            'model' => App\Models\Staff::class,
        ],
    ],
    // ...
];

And Laravel support generate Policy class for special user model with option --grard.

$ php artisan make:policy User/OrderPolicy --model Order --guard web
$ php artisan make:policy Staff/OrderPolicy --model Order --guard staff

But only one Policy class can load by default.

// app/Providers/AuthServiceProvider.php
namespace App\Providers;

// ...

class AuthServiceProvider extends ServiceProvider
{
    protected $policies = [
        \App\Models\Order::class => \App\Policies\User\OrderPolicy::class,
    ];

Current solution

I have two solutions

Solution 1:

Using Gate::guessPolicyNamesUsing() method

// app/Providers/AuthServiceProvider.php
namespace App\Providers;

// ...

class AuthServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->registerPolicies();

        Gate::guessPolicyNamesUsing(function (string $class) {
            $user = request()->user();
            $folder = $user instanceof \App\Models\User ? 'User' : 'Staff';

            return Str::replace('App\\Models', 'App\\Policies\\' . $folder, $class) . 'Policy';
        });
    }

Solution 2:

Using magic method and forward to special Policy class

Create classes

// app/Policies/Policy.php
namespace App\Policies;

abstract class Policy
{
    public function __call($name, $arguments)
    {
        if (isset($arguments[0]) && $arguments[0] instanceof Authenticatable) {
            $user = $arguments[0];
            $folder = $user instanceof \App\Models\User ? 'User' : 'Staff';

            $policyClass = Str::replace(__NAMESPACE__, __NAMESPACE__ . '\\' . $folder, __CLASS__);
            if (class_exists($policyClass) && method_exists($policyClass, $name)) {
                return app()->make($policyClass)->{$name}(...$arguments);
            }
        }
    }
}

// app/Policies/OrderPolicy.php
namespace App\Policies;

class OrderPolicy extends Policy {}

And Laravel will load Policy classes automatic.

Suggestion for Laravel

Add $user parameter to Gate::getPolicyFor(), Gate::guessPolicyName() method and guessPolicyNamesUsingCallback callback.

https://github.com/laravel/framework/blob/9.x/src/Illuminate/Auth/Access/Gate.php#L613
https://github.com/laravel/framework/blob/9.x/src/Illuminate/Auth/Access/Gate.php#L642
https://github.com/laravel/framework/blob/9.x/src/Illuminate/Auth/Access/Gate.php#L675
https://github.com/laravel/framework/blob/9.x/src/Illuminate/Auth/Access/Gate.php#L678

When that, simple solution like solution 1.

// app/Providers/AuthServiceProvider.php
namespace App\Providers;

// ...

class AuthServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->registerPolicies();

        Gate::guessPolicyNamesUsing(function (string $class, Authenticatable $user) {
            $folder = $user instanceof \App\Models\User ? 'User' : 'Staff';

            return Str::replace('App\\Models', 'App\\Policies\\' . $folder, $class) . 'Policy';
        });
    }