Skip to content

Showed an example of using container parameters in route requirements #6505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
javiereguiluz wants to merge 2 commits into from
Closed

Showed an example of using container parameters in route requirements #6505

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
342284c
Showed an example of using container parameters in route requirements
javiereguiluz Apr 21, 2016
1b337e9
Rewords
javiereguiluz Apr 21, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions book/routing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -808,6 +808,101 @@ Path Parameters
``/es`` *won't match this route*
======= ========================

.. tip::

The route requirements can also be defined as container parameters, which
comes in handy when the regular expression is very complex and used time and
again in your application:
Copy link
Member

@xabbuh xabbuh Apr 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would end this paragraph with a dot.

Copy link
Member Author

@javiereguiluz javiereguiluz Apr 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Thanks.


First, define the regular expression as a parameter:

.. configuration-block::

.. code-block:: yaml

# app/config/config.yml
parameters:
uuid_regex: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'

.. code-block:: xml

<!-- app/config/config.xml -->
<?xml version="1.0" encoding="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
http://symfony.com/schema/dic/services/services-1.0.xsd">

<parameters>
<parameter key="uuid_regex">[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</parameter>
</parameters>
</container>

.. code-block:: php

// app/config/config.php
$container->setParameter('uuid_regex', '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}');

Then, use this ``uuid_regex`` parameter in the route requirements:

.. configuration-block::

.. code-block:: php-annotations

// src/AppBundle/Controller/MainController.php

// ...
class MainController extends Controller
{
/**
* @Route("/show/{uuid}", requirements={
* "uuid": "%uuid_regex%"
* })
*/
public function showAction($uuid)
{
}
}

.. code-block:: yaml

# app/config/routing.yml
show:
path: /show/{uuid}
defaults: { _controller: AppBundle:Main:show }
requirements:
uuid: '%uuid_regex%'

.. code-block:: xml

<!-- 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
http://symfony.com/schema/routing/routing-1.0.xsd">

<route id="show" path="/show/{uuid}">
<default key="_controller">AppBundle:Main:show</default>
<requirement key="uuid">%uuid_regex%</requirement>
</route>
</routes>

.. code-block:: php

// app/config/routing.php
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;

$collection = new RouteCollection();
$collection->add('show', new Route('/show/{uuid}', array(
'_controller' => 'AppBundle:Main:show',
), array(
'uuid' => '%uuid_regex%',
)));

return $collection;

.. index::
single: Routing; Method requirement

Expand Down