Routing in Symfony2

Question

How to setup default routing in Symfony2?

In Symfony1 it looked something like this:

homepage:
  url:   /
  param: { module: default, action: index }

default_symfony:
  url:   /symfony/:action/...
  param: { module: default }

default_index:
  url:   /:module
  param: { action: index }

default:
  url:   /:module/:action/...

score 28 · Answer 1 · edited Jul 16 '14 at 18:14

28

I was looking through the cookbook for an answer to this, and think I've found it here. By default, all route parameters have a hidden requirement that they match any character except the / character ([^/]+), but this behaviour can be overridden with the requirements keyword, by forcing it to match any character.

The following should create a default route that catches all others - and as such, should come last in your routing config, as any following routes will never match. To ensure it matches "/" as well, a default value for the url parameter is included.

default_route:
    pattern: /{url}
    defaults: { _controller: AcmeBundle:Default:index, url: "index" }
    requirements:
        url: ".+"

edited Jul 16 '14 at 18:14

Slava Fomin II

26,865
29
124
202

answered Oct 25 '11 at 15:50

Longsight

706
7
5

Worked, cheers but just to enhance: "Default" is the classname of your controller (first letter capitalized without the "Controller" part). – domguinard Jun 03 '13 at 17:04
There is a problem with the code presented in this answer, it needs a route name. Currently `pattern:` is assumed to be the route name and `pattern:`, `defaults:` and `requirements:` need to indented at the same level. – Luke Jan 14 '14 at 22:19
Thanks, that was probably a rush copy/paste job from my routes file! – Longsight May 11 '16 at 10:31

score 8 · Answer 2 · answered Feb 25 '11 at 10:47

8

I don't think it's possible with the standard routing component. Take a look to this bundle, it might help : https://github.com/hidenorigoto/DefaultRouteBundle

answered Feb 25 '11 at 10:47

dxb

931
5
7

1

Another way is to do it with annotations http://bundles.symfony-reloaded.org/frameworkextrabundle/#annotations-for-controllers Still no default route. – umpirsky Mar 08 '11 at 12:27
No, it's possible. See the answer below. – Denis Gorbachev Apr 25 '11 at 09:38

score 8 · Answer 3 · answered Apr 09 '11 at 16:10

8

// Symfony2 PR10

in routing.yml:

default:
    pattern:  /{_controller}

It enables you to use this kind of urls: http://localhost/MySuperBundle:MyController:myview

answered Apr 09 '11 at 16:10

Denis Gorbachev

507
4
12

mevdschee · Answer 4 · 2013-01-27T23:44:08.580

Symfony2 standard routing component does not support it, but this bundle fills the gap Symfony1 left:

https://github.com/LeaseWeb/LswDefaultRoutingBundle

It does what you expect. You can default route a bundle using this syntax:

FosUserBundle:
  resource: "@FosUserBundle"
  prefix:   /
  type:     default

It scans your bundle and automatically adds routes to your router table that you can debug by executing:

app/console router:debug

Example of automatically added default routes:

[router] Current routes
Name                          Method Pattern
fos_user.user.login_check     ANY    /user/login_check.{_format}
fos_user.user.logout          ANY    /user/logout.{_format}
fos_user.user.login           ANY    /user/login.{_format}
...

You see that it also supports the automatic "format" selection by using a file extension (html, json or xml).

score 3 · Answer 5 · edited Dec 14 '12 at 17:08

3

Here is an example: http://docs.symfony-reloaded.org/master/quick_tour/the_big_picture.html#routing

A route definition has only one mandatory parameter pattern and three optionals parameters defaults, requirements and options.

Here's a route from my own project:

video:
    pattern:  /watch/{id}/{slug}
    defaults: { _controller: SiteBundle:Video:watch }
    requirements: { id: "\d+", slug: "[\w-]+"

edited Dec 14 '12 at 17:08

Jon Winstanley

23,010
22
73
116

answered Feb 09 '11 at 13:57

Crozin

43,890
13
88
135

1

I know how to add parameters to my route. But I want to match controller and action to have routes like /controller/action/params... – umpirsky Feb 09 '11 at 14:02

score 2 · Answer 6 · answered Jul 10 '11 at 19:00

2

Alternatively, you can use @Route annotation directly in a controller file. see https://github.com/sensio/SensioFrameworkExtraBundle/blob/master/Resources/doc/annotations/routing.rst

As for the default routes, I think Symfony2 encourages explicit route mapping.

answered Jul 10 '11 at 19:00

ken

4,886
4
30
26

I think what's odd, is that if you generate your bundle using the console tools, it creates a default controller with routing defined via annotations. But the official book makes no mention of routing via annotations - there's no mention in the book. If this is the default setup, I would think it should be pointed out and documentation (or links to it) provided. – Eno Dec 01 '11 at 23:32

score 2 · Answer 7 · answered Dec 19 '11 at 14:57

2

Create a default route is not a good way of programming. Why? Because for this reason was implemented Exception. Symfony2 is built just to do right things in the right way.

If you want to redirect all "not found" routes you should use exception, like NotFound404 or something similar. You can even customise this page at your own.

One route is for one purpose. Always. Other think is bad.

answered Dec 19 '11 at 14:57

Marc Morera Merino

159
2
2

2

BASTA''s comment: "@Marc Morera Merino: consider this use case - a blog with default view, single post view, guestbook, guestbook entry form etc. For the default view, I don't want the URL to be of the form `http://example.com/blog/slug`, but simply `http://example.com/slug`. This will be the default view of the site, and certainly nothing that can be conceived as 'exception'". – Peter O. Feb 15 '12 at 04:56
Also, it is completely reasonable to want to have your JS handle the routing and dynamically load the application view, in this case all routes would serve a base layout and your JS router would determine the URL and render the view. This calls for a catch all route – JamesHalsall Sep 18 '13 at 07:52
Marc, I guess you haven't heard about SEO, changing routes is sometimes necessary when restructuring a site and a catch-all may be needed to be able to give a correct redirect (301 Status) – h00ligan Nov 08 '14 at 11:32

score 1 · Answer 8 · answered Jan 10 '13 at 00:29

If you want to create a "catch all", your best bet would be to hook on the KernelEvents::EXCEPTION event. This event gets triggered whenever an Exception falls through to the HttpKernel, this includes the NotFoundHttpException thrown when the router cannot resolve a route to a Controller.

The effect would be similar to Symfony's stylized 404 page that gets rendered when you send the request through app_dev.php. Instead of returning a 404, you perform whatever logic you're looking to.

score 1 · Answer 9 · answered Sep 27 '11 at 21:04

You could create your own bundle that handled all requests and used URL parameters to construct a string to pass to the controller's forward method. But that's pretty crappy, I'd go with well defined routes, it keeps your URLs cleaner, and decouples the URL and controller names. If you rename a bundle or something, do you then have to refactor your URLs?

score 0 · Answer 10 · answered Apr 05 '18 at 07:07

It depends... Some of mine look like this:

api_email:
resource: "@MApiBundle/Resources/config/routing_email.yml"
prefix: /

and some look like

api_images:
path:     /images/{listingId}/{width}/{fileName}
defaults: { _controller: ApiBundle:Image:view, listingId: null, width: null, fileName: null }
methods:  [GET]
requirements:
    fileName: .+

Routing in Symfony2

10 Answers10

Linked