Skip to content

Middleware: support enums in role/permission middleware #2813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Feb 28, 2025
Merged
33 changes: 23 additions & 10 deletions src/Middleware/PermissionMiddleware.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ public function handle($request, Closure $next, $permission, $guard = null)
throw UnauthorizedException::missingTraitHasRoles($user);
}

$permissions = is_array($permission)
? $permission
: explode('|', $permission);
$permissions = explode('|', self::parsePermissionsToString($permission));

if (! $user->canAny($permissions)) {
throw UnauthorizedException::forPermissions($permissions);
Expand All @@ -53,16 +51,31 @@ public static function using($permission, $guard = null)
$permission = $permission->value;
}

// Convert array of permissions (including Enum values) to a string
if (is_array($permission)) {
$permission = array_map(fn ($p) => $p instanceof \BackedEnum ? $p->value : $p, $permission);
$permissionString = implode('|', $permission);
} else {
$permissionString = (string) $permission;
}
$permissionString = self::parsePermissionsToString($permission);

$args = is_null($guard) ? $permissionString : "$permissionString,$guard";

return static::class.':'.$args;
}

/**
* Convert array or string of permissions to string representation.
*
* @return string
*/
protected static function parsePermissionsToString(array|string|\BackedEnum $permission)
{
// Convert Enum to its value if an Enum is passed
if ($permission instanceof \BackedEnum) {
$permission = $permission->value;
}

if (is_array($permission)) {
$permission = array_map(fn ($r) => $r instanceof \BackedEnum ? $r->value : $r, $permission);

return implode('|', $permission);
}

return (string) $permission;
}
}
27 changes: 18 additions & 9 deletions src/Middleware/RoleMiddleware.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ public function handle($request, Closure $next, $role, $guard = null)
throw UnauthorizedException::missingTraitHasRoles($user);
}

$roles = is_array($role)
? $role
: explode('|', $role);
$roles = explode('|', self::parseRolesToString($role));

if (! $user->hasAnyRole($roles)) {
throw UnauthorizedException::forRoles($roles);
Expand All @@ -47,6 +45,20 @@ public function handle($request, Closure $next, $role, $guard = null)
* @return string
*/
public static function using($role, $guard = null)
{
$roleString = self::parseRolesToString($role);

$args = is_null($guard) ? $roleString : "$roleString,$guard";

return static::class.':'.$args;
}

/**
* Convert array or string of roles to string representation.
*
* @return string
*/
protected static function parseRolesToString(array|string|\BackedEnum $role)
{
// Convert Enum to its value if an Enum is passed
if ($role instanceof \BackedEnum) {
Expand All @@ -55,13 +67,10 @@ public static function using($role, $guard = null)

if (is_array($role)) {
$role = array_map(fn ($r) => $r instanceof \BackedEnum ? $r->value : $r, $role);
$roleString = implode('|', $role);
} else {
$roleString = (string) $role;

return implode('|', $role);
}

$args = is_null($guard) ? $roleString : "$roleString,$guard";

return static::class.':'.$args;
return (string) $role;
}
}
3 changes: 3 additions & 0 deletions tests/PermissionMiddlewareTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,9 @@ public function the_middleware_can_handle_enum_based_permissions_with_static_usi
#[Test]
public function the_middleware_can_handle_enum_based_permissions_with_handle_method()
{
app(Permission::class)->create(['name' => TestModels\TestRolePermissionsEnum::VIEWARTICLES]);
app(Permission::class)->create(['name' => TestModels\TestRolePermissionsEnum::EDITARTICLES]);

Auth::login($this->testUser);
$this->testUser->givePermissionTo(TestModels\TestRolePermissionsEnum::VIEWARTICLES);

Expand Down
Loading