Symfony News

New in Symfony 6.1: Services in Route Conditions

Contributed by
Renan de Lima
in #44405.

Routing in Symfony applications is usually simple and consists of mapping some controller method to some URL path. However, sometimes you need to evaluate complex conditions to decide if some incoming URL should match a given controller. That's why Symfony allows using expressions to match routes.

In Symfony 6.1 we've improved routing conditions so you can also call services inside those expressions. To do that, use the new service() function and pass the name of the service to call:

// src/Controller/DefaultController.php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class DefaultController extends AbstractController
{
    #[Route(
        '/some-path',
        name: 'some_name',
        condition: "service('some_service').someMethod()",
    )]
    public function someControllerMethod(): Response
    {
        // ...
    }
}

By default, and for performance reasons, you cannot call any of the services defined in your application. Instead, you must add the routing.condition_service tag or the #[AsRoutingConditionService] attribute to those services that will be available in route conditions:

use Symfony\Bundle\FrameworkBundle\Routing\Attribute\AsRoutingConditionService;
// ...

#[AsRoutingConditionService(alias: 'some_service')]
class SomeService
{
    public function someMethod(): bool
    {
        // ...
    }
}

The alias option defines how this service will be referred to inside the expression, so you don't have to use the full service name (which is usually too long).