support enums in role names

[ceejayoz]

We have a PHP 8.1 BackedEnum listing our application's roles.

This permits us to do the following:

Spatie\Permission\Models\Role::create(['name' => App\Enums\Role::ADMINISTRATOR]);

However, this does not work with assignRole():

$user->assignRole(App\Enums\Role::ADMINISTRATOR)

and we are instead required to do:

$user->assignRole(App\Enums\Role::ADMINISTRATOR->value)

This appears to be due to HasRoles::getStoredRole accepting a string, numeric, or Role as argument.

I'd suggest this function have an additional check along the lines of:

    if (is_object($role) && $role instanceof \BackedEnum) {
        return $roleClass->findByName($role->value, $this->getDefaultGuardName());
    }

so enums can be used as role names.

[erikn69]

Did you try overriding getStoredRole on your User model implementation?

    use \Spatie\Permission\Traits\HasRoles {
        getStoredRole as getStoredRoleTrait;
    }
    protected function getStoredRole($role): Role
    {
        if (is_object($role) && $role instanceof \BackedEnum) {
              $roleClass = $this->getRoleClass();
              return $roleClass->findByName($role->value, $this->getDefaultGuardName());
        }

        return $this->getStoredRoleTrait($role);
    }

[edalzell]

To make it work w/ hasRole you also need to completely override hasRole and add:

if ($roles instanceof BackedEnum) {
            return $guard
                ? $this->roles->where('guard_name', $guard)->contains('name', $roles->value)
                : $this->roles->contains('name', $roles->value);
        }

[edalzell]

This is worth a PR, I think

[drbyte]

See #2391

[boumanb]

Just wanted to let you know I had the same idea and solved it like this:

<?php

namespace App\Policies;

use  App\Models\Role as RoleModel;

enum Role: string
{
    case LEAD_ADMIN = 'lead_admin';
    case GLOBAL_USER = 'global_user';
    case ADMINISTRATOR = 'administrator';
    case DEVELOPER = 'developer';
    case PUBLISHER = 'publisher';
    case AUTHOR = 'author';

    public function id(): int
    {
        return RoleModel::whereName($this->value)->select('id')->first()->id;
    }
}

<?php

namespace App\Concerns;

use App\Policies\Role;

trait HasRoles
{
    use \Spatie\Permission\Traits\HasRoles {
        assignRole as protected spatieAssignRole;
    }

    public function assignRole(Role $role)
    {
        $this->spatieAssignRole($role->value);

        return $this;
    }
}

And in the App\Models\User:

<?php

namespace App\Models;

use App\Concerns\HasRoles;

class User extends Authenticatable
{
    use HasRoles;
    .....
}

[drbyte]

Feedback welcome: #2391

[silnex]

I use a way with fewer breakpoints.

<?php

namespace App\Models\Trait;

trait HasRoles
{
    use \Spatie\Permission\Traits\HasRoles {
        assignRole as protected spatieAssignRole;
    }

    public function assignRole(...$roles)
    {
        $roles = collect($roles)->map(function ($role) {
            if ($role instanceof \BackedEnum) {
                return $role->value;
            }

            return $role;
        });

        $this->spatieAssignRole(...$roles);

        return $this;
    }
}

[drbyte]

@silnex thanks for your note.
I realized that I missed a few things in the initial implementation in #2391; it's been updated in 299fe4b

[JacobHonore]

Is it a mistake that the Enums-feature is currently shown in the v5 documentation? It seems to be a v6 feature
https://spatie.be/docs/laravel-permission/v5/basic-usage/enums

[drbyte]

Is it a mistake that the Enums-feature is currently shown in the v5 documentation? It seems to be a v6 feature
https://spatie.be/docs/laravel-permission/v5/basic-usage/enums

Fixed.

[localusercamp]

Will there be support for this feature?

This is very ugly =D

[erikn69]

Already on v6:

• [v6] Add BackedEnum support #2391