Route names starting with underscore in Symfony2

Question

I'm working on a Symfony2 project and in the file routing.yml I have the following lines:

_front: resource: routing_front.yml _admin: resource: routing_admin.yml prefix: /admin

So this actually allows defining the routes for the front-end and the back-end in separate dedicated files.

What about the names though ? Is it simply a naming convention to start with an underscore - which will tell at first sight that the actual routes are in a different file - or has this an influence on how the framework handle those ?

Med · Accepted Answer · 2015-06-08 12:51:23Z

1

It's only a naming convention.

But the Framework will handle the routes by matching the first route defined with the matching url requested, then the second one and so on...

So in your case, even if you requested http://www.mysyte.com/admin/whatever, it will match this url with all the routes in routing_front.yml before matching them with routing_admin.yml

answered Jun 8, 2015 at 12:51

Med

2,06322 silver badges32 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

nbro Over a year ago

Ok, it's a naming convention, but why not simply use front instead of _front? Why was this convention introduced? Maybe you should clarify that what the OP assumed is why the convention was introduced. It's not clear from this answer.

Med Nov 29, 2024 at 14:09

Choosing between "front" or "_front' ? That's what convention are for. Someone chose "_front". No reasons, just a need to name something. You can still use "front", if you prefer.

d0ug7a5 · Accepted Answer · 2015-06-08 13:11:54Z

These names become particularly useful when you are creating links in twig templates - rather than hardcoding the URLs, you can generate absolute URLs based on the route names, e.g. :

<a href="{{ url('_welcome') }}">Welcome page</a>

The underscores make it more obviously a route, if you're a developer particularly far into Symfony-land (it is a convention), but they're definitely not required per se.

this is definitely not a recommended practice to prefix route names with underscores in general! As the accepted answer suggests, prefixed route names are a convention to mark "private" routes like the profiler which are not meant for "actual" use in userland.
@AdrianFöder Can you point to the documentation that states that?

Collectives™ on Stack Overflow

Route names starting with underscore in Symfony2

2 Answers 2

2 Comments

2 Comments

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

2 Comments

Related