Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. BackedEnumValueResolver.php

class BackedEnumValueResolver

Attempt to resolve backed enum cases from request attributes, for a route path parameter, leading to a 404 Not Found if the attribute value isn't a valid backing value for the enum type.

@author Maxime Steinhausser <maxime.steinhausser@gmail.com>

Hierarchy

  • class \Symfony\Component\HttpKernel\Controller\ArgumentResolver\BackedEnumValueResolver implements \Symfony\Component\HttpKernel\Controller\ValueResolverInterface

Expanded class hierarchy of BackedEnumValueResolver

File

vendor/symfony/http-kernel/Controller/ArgumentResolver/BackedEnumValueResolver.php, line 25

Namespace

Symfony\Component\HttpKernel\Controller\ArgumentResolver
View source
final class BackedEnumValueResolver implements ValueResolverInterface {
    public function resolve(Request $request, ArgumentMetadata $argument) : iterable {
        if (!is_subclass_of($argument->getType(), \BackedEnum::class)) {
            return [];
        }
        if ($argument->isVariadic()) {
            // only target route path parameters, which cannot be variadic.
            return [];
        }
        // do not support if no value can be resolved at all
        // letting the \Symfony\Component\HttpKernel\Controller\ArgumentResolver\DefaultValueResolver be used
        // or \Symfony\Component\HttpKernel\Controller\ArgumentResolver fail with a meaningful error.
        if (!$request->attributes
            ->has($argument->getName())) {
            return [];
        }
        $value = $request->attributes
            ->get($argument->getName());
        if (null === $value) {
            return [
                null,
            ];
        }
        if ($value instanceof \BackedEnum) {
            return [
                $value,
            ];
        }
        if (!\is_int($value) && !\is_string($value)) {
            throw new \LogicException(\sprintf('Could not resolve the "%s $%s" controller argument: expecting an int or string, got "%s".', $argument->getType(), $argument->getName(), get_debug_type($value)));
        }
        
        /** @var class-string<\BackedEnum> $enumType */
        $enumType = $argument->getType();
        try {
            return [
                $enumType::from($value),
            ];
        } catch (\ValueError|\TypeError $e) {
            throw new NotFoundHttpException(\sprintf('Could not resolve the "%s $%s" controller argument: ', $argument->getType(), $argument->getName()) . $e->getMessage(), $e);
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
BackedEnumValueResolver::resolve public function Returns the possible value(s). Overrides ValueResolverInterface::resolve

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal