Extending Action Argument Resolving

Warning: You are browsing the documentation for Symfony 6.1, which is no longer maintained.

Read the updated version of this page for Symfony 7.2 (the current stable version).

Extending Action Argument Resolving

In the controller guide, you've learned that you can get the Request object via an argument in your controller. This argument has to be type-hinted by the Request class in order to be recognized. This is done via the ArgumentResolver. By creating and registering custom argument value resolvers, you can extend this functionality.

Built-In Value Resolvers

Symfony ships with the following value resolvers in the HttpKernel component:

BackedEnumValueResolver

Attempts to resolve a backed enum case from a route path parameter that matches the name of the argument. Leads to a 404 Not Found response if the value isn't a valid backing value for the enum type.

For example, if your backed enum is:

1
2
3
4
5
6
7
8
9
namespace App\Model;

enum Suit: string
{
    case Hearts = 'H';
    case Diamonds = 'D';
    case Clubs = 'C';
    case Spades = 'S';
}

And your controller contains the following:

1
2
3
4
5
6
7
8
9
10
class CardController
{
    #[Route('/cards/{suit}')]
    public function list(Suit $suit): Response
    {
        // ...
    }

    // ...
}

When requesting the /cards/H URL, the $suit variable will store the Suit::Hearts case.

Furthermore, you can limit route parameter's allowed values to only one (or more) with EnumRequirement:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
use Symfony\Component\Routing\Requirement\EnumRequirement;

// ...

class CardController
{
    #[Route('/cards/{suit}', requirements: [
        // this allows all values defined in the Enum
        'suit' => new EnumRequirement(Suit::class),
        // this restricts the possible values to the Enum values listed here
        'suit' => new EnumRequirement([Suit::Diamonds, Suit::Spades]),
    ])]
    public function list(Suit $suit): Response
    {
        // ...
    }

    // ...
}

The example above allows requesting only /cards/D and /cards/S URLs and leads to 404 Not Found response in two other cases.

6.1

The BackedEnumValueResolver and EnumRequirement were introduced in Symfony 6.1.

RequestAttributeValueResolver
Attempts to find a request attribute that matches the name of the argument.
DateTimeValueResolver

Attempts to find a request attribute that matches the name of the argument and injects a DateTimeInterface object if type-hinted with a class extending DateTimeInterface.

By default any input that can be parsed as a date string by PHP is accepted. You can restrict how the input can be formatted with the MapDateTime attribute.

6.1

The DateTimeValueResolver was introduced in Symfony 6.1.

RequestValueResolver
Injects the current Request if type-hinted with Request or a class extending Request.
ServiceValueResolver
Injects a service if type-hinted with a valid service class or interface. This works like autowiring.
SessionValueResolver
Injects the configured session class implementing SessionInterface if type-hinted with SessionInterface or a class implementing SessionInterface.
DefaultValueResolver
Will set the default value of the argument if present and the argument is optional.
UidValueResolver

Attempts to convert any UID values from a route path parameter into UID objects. Leads to a 404 Not Found response if the value isn't a valid UID.

For example, the following will convert the token parameter into a UuidV4 object:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// src/Controller/DefaultController.php
namespace App\Controller;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Uid\UuidV4;

class DefaultController
{
    #[Route('/share/{token}')]
    public function share(UuidV4 $token): Response
    {
        // ...
    }
}

6.1

The UidValueResolver was introduced in Symfony 6.1.

VariadicValueResolver
Verifies if the request data is an array and will add all of them to the argument list. When the action is called, the last (variadic) argument will contain all the values of this array.

In addition, some components and official bundles provide other value resolvers:

UserValueResolver

Injects the object that represents the current logged in user if type-hinted with UserInterface. You can also type-hint your own User class but you must then add the #[CurrentUser] attribute to the argument. Default value can be set to null in case the controller can be accessed by anonymous users. It requires installing the SecurityBundle.

If the argument is not nullable and there is no logged in user or the logged in user has a user class not matching the type-hinted class, an AccessDeniedException is thrown by the resolver to prevent access to the controller.

PSR-7 Objects Resolver:
Injects a Symfony HttpFoundation Request object created from a PSR-7 object of type ServerRequestInterface, RequestInterface or MessageInterface. It requires installing the PSR-7 Bridge component.

Adding a Custom Value Resolver

In the next example, you'll create a value resolver to inject the object that represents the current user whenever a controller method type-hints an argument with the User class:

1
2
3
4
5
6
7
8
9
10
11
12
13
// src/Controller/UserController.php
namespace App\Controller;

use App\Entity\User;
use Symfony\Component\HttpFoundation\Response;

class UserController
{
    public function index(User $user)
    {
        return new Response('Hello '.$user->getUserIdentifier().'!');
    }
}

Beware that this feature is already provided by the #[ParamConverter] attribute from the SensioFrameworkExtraBundle. If you have that bundle installed in your project, add this config to disable the auto-conversion of type-hinted method arguments:

1
2
3
4
5
# config/packages/sensio_framework_extra.yaml
sensio_framework_extra:
    request:
        converters: true
        auto_convert: false

Adding a new value resolver requires creating a class that implements ArgumentValueResolverInterface and defining a service for it. The interface defines two methods:

supports()
This method is used to check whether the value resolver supports the given argument. resolve() will only be called when this returns true.
resolve()
This method will resolve the actual value for the argument. Once the value is resolved, you must yield the value to the ArgumentResolver.

Both methods get the Request object, which is the current request, and an ArgumentMetadata instance. This object contains all information retrieved from the method signature for the current argument.

Now that you know what to do, you can implement this interface. To get the current User, you need the current security token. This token can be retrieved from the token storage:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// src/ArgumentResolver/UserValueResolver.php
namespace App\ArgumentResolver;

use App\Entity\User;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
use Symfony\Component\Security\Core\Security;

class UserValueResolver implements ArgumentValueResolverInterface
{
    private $security;

    public function __construct(Security $security)
    {
        $this->security = $security;
    }

    public function supports(Request $request, ArgumentMetadata $argument): bool
    {
        if (User::class !== $argument->getType()) {
            return false;
        }

        return $this->security->getUser() instanceof User;
    }

    public function resolve(Request $request, ArgumentMetadata $argument): iterable
    {
        yield $this->security->getUser();
    }
}

In order to get the actual User object in your argument, the given value must fulfill the following requirements:

  • An argument must be type-hinted as User in your action method signature;
  • The value must be an instance of the User class.

When all those requirements are met and true is returned, the ArgumentResolver calls resolve() with the same values as it called supports().

That's it! Now all you have to do is add the configuration for the service container. This can be done by tagging the service with controller.argument_value_resolver and adding a priority.

1
2
3
4
5
6
7
8
9
10
# config/services.yaml
services:
    _defaults:
        # ... be sure autowiring is enabled
        autowire: true
    # ...

    App\ArgumentResolver\UserValueResolver:
        tags:
            - { name: controller.argument_value_resolver, priority: 50 }

While adding a priority is optional, it's recommended to add one to make sure the expected value is injected. The built-in RequestAttributeValueResolver, which fetches attributes from the Request, has a priority of 100. If your resolver also fetches Request attributes, set a priority of 100 or more. Otherwise, set a priority lower than 100 to make sure the argument resolver is not triggered when the Request attribute is present (for example, when passing the user along sub-requests).

To ensure your resolvers are added in the right position you can run the following command to see which argument resolvers are present and in which order they run.

1
$ php bin/console debug:container debug.argument_resolver.inner --show-arguments

Tip

As you can see in the UserValueResolver::supports() method, the user may not be available (e.g. when the controller is not behind a firewall). In these cases, the resolver will not be executed. If no argument value is resolved, an exception will be thrown.

To prevent this, you can add a default value in the controller (e.g. User $user = null). The DefaultValueResolver is executed as the last resolver and will use the default value if no value was already resolved.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version