How to Use Service Container Parameters in your Routes

Version: 3.1
Edit this page

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

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

How to Use Service Container Parameters in your Routes

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:

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

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

  • YAML
  • XML
  • PHP
1
2
3
# app/config/config.yml
parameters:
    app.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
4
# app/config/routing.yml
some_route:
    path:     /%app.route_prefix%/contact
    defaults: { _controller: AppBundle:Main:contact }

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

See also

For parameter handling within a Dependency Injection Class see Using Parameters within a Dependency Injection Class.

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