How to use HTTP Methods beyond GET and POST in 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 HTTP Methods beyond GET and POST in Routes
The HTTP method of a request is one of the requirements that can be checked when seeing if it matches a route. This is introduced in the routing chapter of the book "Routing" with examples using GET and POST. You can also use other HTTP verbs in this way. For example, if you have a blog post entry then you could use the same URL path to show it, make changes to it and delete it by matching on GET, PUT and DELETE.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
blog_show:
path: /blog/{slug}
defaults: { _controller: AcmeDemoBundle:Blog:show }
methods: [GET]
blog_update:
path: /blog/{slug}
defaults: { _controller: AcmeDemoBundle:Blog:update }
methods: [PUT]
blog_delete:
path: /blog/{slug}
defaults: { _controller: AcmeDemoBundle:Blog:delete }
methods: [DELETE]
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<?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="blog_show" path="/blog/{slug}" methods="GET">
<default key="_controller">AcmeDemoBundle:Blog:show</default>
</route>
<route id="blog_update" path="/blog/{slug}" methods="PUT">
<default key="_controller">AcmeDemoBundle:Blog:update</default>
</route>
<route id="blog_delete" path="/blog/{slug}" methods="DELETE">
<default key="_controller">AcmeDemoBundle:Blog:delete</default>
</route>
</routes>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;
$collection = new RouteCollection();
$collection->add('blog_show', new Route('/blog/{slug}', array(
'_controller' => 'AcmeDemoBundle:Blog:show',
), array(), array(), '', array(), array('GET')));
$collection->add('blog_update', new Route('/blog/{slug}', array(
'_controller' => 'AcmeDemoBundle:Blog:update',
), array(), array(), '', array(), array('PUT')));
$collection->add('blog_delete', new Route('/blog/{slug}', array(
'_controller' => 'AcmeDemoBundle:Blog:delete',
), array(), array(), '', array('DELETE')));
return $collection;
Faking the Method with _method
Note
The _method
functionality shown here is disabled by default in Symfony 2.2.
To enable it, you must call Request::enableHttpMethodParameterOverride
before you handle the request (e.g. in your front controller).
Unfortunately, life isn't quite this simple, since most browsers do not
support sending PUT and DELETE requests. Fortunately Symfony2 provides you
with a simple way of working around this limitation. By including a _method
parameter in the query string or parameters of an HTTP request, Symfony2 will
use this as the method when matching routes. This can be done easily in forms
with a hidden field. Suppose you have a form for editing a blog post:
1 2 3 4 5
<form action="{{ path('blog_update', {'slug': blog.slug}) }}" method="post">
<input type="hidden" name="_method" value="PUT" />
{{ form_widget(form) }}
<input type="submit" value="Update" />
</form>
The submitted request will now match the blog_update
route and the updateAction
will be used to process the form.
Likewise the delete form could be changed to look like this:
1 2 3 4 5
<form action="{{ path('blog_delete', {'slug': blog.slug}) }}" method="post">
<input type="hidden" name="_method" value="DELETE" />
{{ form_widget(delete_form) }}
<input type="submit" value="Delete" />
</form>
It will then match the blog_delete
route.