How can I have optional parameters in Symfony2 route?

Question

I have this code below:

/**
 * Lists all User entities.
 *
 * @Route("/{cid}",defaults={"cid" = null},name="user")
 * @Template()
 */
public function indexAction($cid=null)
{}

Now if I type site/user/1 then it works, but if I type site/user/ it says:

No route found

How can I have it that both routes work?

score 80 · Accepted Answer · edited Mar 24 '16 at 12:28

80

Try to go to site/user (notice no backslash at the end).

Generally it should work, I have relatively similar configuration working.

But if all else fails you can always define multiple routes for same action, i.e.

/**
 * Lists all User entities.
 *
 * @Route("/", name="user_no_cid")
 * @Route("/{cid}", name="user")
 * @Template()
 */
public function indexAction($cid=null)
{

edited Mar 24 '16 at 12:28

martin

93,354
25
191
226

answered Aug 16 '12 at 07:04

Inoryy

8,365
2
39
40

Awesome, Thanks! – Azhar Khattak May 03 '18 at 14:54
2

It was only a problem for a very short amount of time, but setting a default value on the parameter (`$cid` in this case) - very important :p – DevLime May 31 '18 at 08:23

score 39 · Answer 2 · answered Aug 16 '12 at 07:01

39

Use a yml file for your routing configuration, and add a default value for id in your routing parameters like this:

user:
  pattern:   /site/user/{id}
  defaults:  { _controller: YourBundle:Default:index, id: 1 }

See documentation here

answered Aug 16 '12 at 07:01

fkoessler

6,932
11
60
92

3

The OP is obviously using route annotations in the controller – phpguru Jan 29 '16 at 01:03
8

Yet his answer helped me and a few others – Andrew Jun 08 '16 at 23:35
4

Notice for future: `pattern` key is deprecated in Symfony 3 – Jazi Sep 05 '16 at 21:03
2

... and you have to use `path` key instead (SF3) – Delphine Apr 24 '17 at 07:48
According to the best practices, should be the correct answer. – Gangai Johann Nov 10 '17 at 15:53

crmpicco · Answer 3 · 2018-04-16T07:16:11.057

7

You could also do it with a GET parameter, e.g.

/**
 * @param Request $request
 *
 * @return Response
 */
public function displayDetailAction(Request $request) : Response
{
    if ($courseId = $request->query->get('courseId')) {

edited Apr 16 '18 at 07:16

answered Jan 13 '16 at 11:40

crmpicco

16,605
26
134
210

How can I have optional parameters in Symfony2 route?

3 Answers3