Symfony
sponsored by SensioLabs
Menu
  • About
  • Documentation
  • Screencasts
  • Cloud
  • Certification
  • Community
  • Businesses
  • News
  • Download
  1. Home
  2. Documentation
  3. Cookbook
  4. Routing
  5. How to use Service Container Parameters in your Routes
  • Documentation
  • Book
  • Reference
  • Bundles
  • Cloud
Search by Algolia

How to use Service Container Parameters in your Routes

Edit this page

Warning: 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).

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
We stand with Ukraine.
Version:
Online Symfony certification, take it now!

Online Symfony certification, take it now!

Code consumes server resources. Blackfire tells you how

Code consumes server resources. Blackfire tells you how

↓ Our footer now uses the colors of the Ukrainian flag because Symfony stands with the people of Ukraine.

Avatar of Dariusz Czech, a Symfony contributor

Thanks Dariusz Czech for being a Symfony contributor

1 commit • 2 lines changed

View all contributors that help us make Symfony

Become a Symfony contributor

Be an active part of the community and contribute ideas, code and bug fixes. Both experts and newcomers are welcome.

Learn how to contribute

Symfony™ is a trademark of Symfony SAS. All rights reserved.

  • What is Symfony?
    • Symfony at a Glance
    • Symfony Components
    • Case Studies
    • Symfony Releases
    • Security Policy
    • Logo & Screenshots
    • Trademark & Licenses
    • symfony1 Legacy
  • Learn Symfony
    • Symfony Docs
    • Symfony Book
    • Reference
    • Bundles
    • Best Practices
    • Training
    • eLearning Platform
    • Certification
  • Screencasts
    • Learn Symfony
    • Learn PHP
    • Learn JavaScript
    • Learn Drupal
    • Learn RESTful APIs
  • Community
    • SymfonyConnect
    • Support
    • How to be Involved
    • Code of Conduct
    • Events & Meetups
    • Projects using Symfony
    • Downloads Stats
    • Contributors
    • Backers
  • Blog
    • Events & Meetups
    • A week of symfony
    • Case studies
    • Cloud
    • Community
    • Conferences
    • Diversity
    • Documentation
    • Living on the edge
    • Releases
    • Security Advisories
    • SymfonyInsight
    • Twig
    • SensioLabs
  • Services
    • SensioLabs services
    • Train developers
    • Manage your project quality
    • Improve your project performance
    • Host Symfony projects
    Deployed on
Follow Symfony
Search by Algolia