How to use Service Container Parameters in your Routes

WARNING: You are browsing the documentation for Symfony 2.1 which is not maintained anymore. Consider upgrading your projects to Symfony 3.3.
2.1 version
Unmaintained

How to use Service Container Parameters in your Routes

New in version 2.1: The ability to use parameters in your routes was added in Symfony 2.1.

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 your 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:

  • YAML
    1
    2
    3
    4
    5
    contact:
        pattern:  /{_locale}/contact
        defaults: { _controller: AcmeDemoBundle:Main:contact }
        requirements:
            _locale: %acme_demo.locales%
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    <?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 http://symfony.com/schema/routing/routing-1.0.xsd">
    
        <route id="contact" pattern="/{_locale}/contact">
            <default key="_controller">AcmeDemoBundle:Main:contact</default>
            <requirement key="_locale">%acme_demo.locales%</requirement>
        </route>
    </routes>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    use Symfony\Component\Routing\RouteCollection;
    use Symfony\Component\Routing\Route;
    
    $collection = new RouteCollection();
    $collection->add('contact', new Route('/{_locale}/contact', array(
        '_controller' => 'AcmeDemoBundle:Main:contact',
    ), array(
        '_locale' => '%acme_demo.locales%',
    )));
    
    return $collection;
    

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

  • YAML
    1
    2
    3
    # app/config/config.yml
    parameters:
        acme_demo.locales: en|es
    
  • XML
    1
    2
    3
    4
    <!-- app/config/config.xml -->
    <parameters>
        <parameter key="acme_demo.locales">en|es</parameter>
    </parameters>
    
  • PHP
    1
    2
    # app/config/config.php
    $container->setParameter('acme_demo.locales', 'en|es');
    

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

  • YAML
    1
    2
    3
    some_route:
        pattern:  /%acme_demo.route_prefix%/contact
        defaults: { _controller: AcmeDemoBundle:Main:contact }
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    <?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 http://symfony.com/schema/routing/routing-1.0.xsd">
    
        <route id="some_route" pattern="/%acme_demo.route_prefix%/contact">
            <default key="_controller">AcmeDemoBundle:Main:contact</default>
        </route>
    </routes>
    
  • PHP
    1
    2
    3
    4
    5
    6
    7
    8
    9
    use Symfony\Component\Routing\RouteCollection;
    use Symfony\Component\Routing\Route;
    
    $collection = new RouteCollection();
    $collection->add('some_route', new Route('/%acme_demo.route_prefix%/contact', array(
        '_controller' => 'AcmeDemoBundle:Main:contact',
    )));
    
    return $collection;
    

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%.

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