How to use Service Container Parameters in your Routes
Edit this pageWarning: You are browsing the documentation for Symfony 2.2, which is no longer maintained.
Read the updated version of this page for Symfony 6.2 (the current stable version).
How to use Service Container Parameters in your Routes
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
- XML
- PHP
1 2 3 4 5
contact:
path: /{_locale}/contact
defaults: { _controller: AcmeDemoBundle:Main:contact }
requirements:
_locale: %acme_demo.locales%
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" path="/{_locale}/contact">
<default key="_controller">AcmeDemoBundle:Main:contact</default>
<requirement key="_locale">%acme_demo.locales%</requirement>
</route>
</routes>
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
- XML
- PHP
1 2 3
# app/config/config.yml
parameters:
acme_demo.locales: en|es
1 2 3 4
<!-- app/config/config.xml -->
<parameters>
<parameter key="acme_demo.locales">en|es</parameter>
</parameters>
1 2
// app/config/config.php
$container->setParameter('acme_demo.locales', 'en|es');
You can also use a parameter to define your route path (or part of your path):
- YAML
- XML
- PHP
1 2 3
some_route:
path: /%acme_demo.route_prefix%/contact
defaults: { _controller: AcmeDemoBundle:Main:contact }
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" path="/%acme_demo.route_prefix%/contact">
<default key="_controller">AcmeDemoBundle:Main:contact</default>
</route>
</routes>
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%
.
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).