How to Use Service Container Parameters in your Routes

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

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

Sometimes you may find it useful to make some parts of your routes globally configurable. For instance, if you build an internationalized site, you'll probably start with one or two locales. Surely you'll add a requirement to your routes to prevent a user from matching a locale other than the locales you support.

You could hardcode your _locale requirement in all your routes, but a better solution is to use a configurable service container parameter right inside your routing configuration:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
        // src/AppBundle/Controller/MainController.php
namespace AppBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\Routing\Annotation\Route;

class MainController extends Controller
{
    /**
     * @Route("/{_locale}/contact", name="contact", requirements={
     *     "_locale"="%app.locales%"
     * })
     */
    public function contactAction()
    {
        // ...
    }
}
    

        1
2
3
4
5
6
        # app/config/routing.yml
contact:
    path:     /{_locale}/contact
    defaults: { _controller: AppBundle:Main:contact }
    requirements:
        _locale: '%app.locales%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- app/config/routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/routing
        https://symfony.com/schema/routing/routing-1.0.xsd">

    <route id="contact" path="/{_locale}/contact">
        <default key="_controller">AppBundle:Main:contact</default>
        <requirement key="_locale">%app.locales%</requirement>
    </route>
</routes>
    

        1
2
3
4
5
6
7
8
9
10
11
12
        // app/config/routing.php
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

$routes = new RouteCollection();
$routes->add('contact', new Route('/{_locale}/contact', [
    '_controller' => 'AppBundle:Main:contact',
], [
    '_locale' => '%app.locales%',
]));

return $routes;
    

You can now control and set the app.locales parameter somewhere in your container:

        1
2
3
        # app/config/config.yml
parameters:
    app.locales: en|es
    

        1
2
3
4
5
6
7
8
9
10
11
        <!-- app/config/config.xml -->
<?xml version="1.0" charset="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <parameters>
        <parameter key="app.locales">en|es</parameter>
    </parameters>
</container>
    

        1
2
        // app/config/config.php
$container->setParameter('app.locales', 'en|es');
    

You can also use a parameter to define your route path (or part of your path):

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

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\Routing\Annotation\Route;

class MainController extends Controller
{
    /**
     * @Route("/%app.route_prefix%/contact", name="contact")
     */
    public function contactAction()
    {
        // ...
    }
}
    

        1
2
3
4
        # app/config/routing.yml
some_route:
    path:     /%app.route_prefix%/contact
    defaults: { _controller: AppBundle:Main:contact }
    

        1
2
3
4
5
6
7
8
9
10
11
        <!-- app/config/routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/routing
        https://symfony.com/schema/routing/routing-1.0.xsd">

    <route id="some_route" path="/%app.route_prefix%/contact">
        <default key="_controller">AppBundle:Main:contact</default>
    </route>
</routes>
    

        1
2
3
4
5
6
7
8
9
10
        // app/config/routing.php
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

$routes = new RouteCollection();
$routes->add('some_route', new Route('/%app.route_prefix%/contact', [
    '_controller' => 'AppBundle:Main:contact',
]));

return $routes;
    

Now make sure that the app.route_prefix parameter is set somewhere in your container:

        1
2
3
        # app/config/config.yml
parameters:
    app.route_prefix: 'foo'
    

        1
2
3
4
5
6
7
8
9
10
11
        <!-- app/config/config.xml -->
<?xml version="1.0" charset="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <parameters>
        <parameter key="app.route_prefix">foo</parameter>
    </parameters>
</container>
    

        1
2
        // app/config/config.php
$container->setParameter('app.route_prefix', 'foo');
    

Note

Just like in normal service container configuration files, if you actually need a % in your route, you can escape the percent sign by doubling it, e.g. /score-50%%, which would resolve to /score-50%.

However, as the % characters included in any URL are automatically encoded, the resulting URL of this example would be /score-50%25 (%25 is the result of encoding the % character).