Document available routing types #4973
Comments
|
Please add accepted configuration parameters for Routing component. (section You like to know full list of configuration options) |
|
What more do you expect to be documented? |
|
I just dont know if there are more config options available for Routing. Im new to symfony, but im curious. Thanks |
|
You can only configure routes or import resources. Both are explained in detail in the Routing book article, the type details were the only things missing. There are some global configuration settings for the routing component which are documented in the FrameworkBundle configuration reference. |
|
You mean this? http://symfony.com/doc/current/reference/configuration/framework.html Yes the global config are the ones I didnt find. |
|
Ah, in that case: They'll be added to that article very soon. We've rewritten the complete FrameworkBundle config reference to document every available config option: #4736 |
|
What's the status of this issue? |
|
We could document this ... but let's do it very briefly. I don't think there's much to say because Symfony's behaviour here is simple, right? |
|
But you can find all information about formats in the doc: |
|
During the EU-FOSSA hackathon, we did look into this and turns out indeed everything is covered well in the documentation (as indicated by @osavchenko). So we can close this! 🎉 |
We seem to have no documentation on the available routing loader types that you configure when loading a resource in
app/config/routing.yml. Nor do we document how Symfony determines the loader when no type is used and what the benefit of the type setting is. I've seem a couple of people asking for such docs the last weeks.I think this can be added to
book/routingdirectly in the "Including External Routing Resources" section.Available loaders: yaml, php, xml, annotation (if SensioFrameworkExtraBundle is registered)
How loaders are choosen
When no type is configured, it's based on the extension. The first matching loader will be used. When a type is configured, both extension and type are taken into account. For instance, a file
custom_routing.ymlwith typeyamlwill be loaded by the yaml loader, while acustom_routing.phpwith typeyamlwill not be loaded, as no loader matches both the.phpextension and theyamltype.The benefit of the type setting
Types allow you to use different loaders for the same extension, for instance a
.phpextension can be loaded by both the PHP and the annotation loader. Using the typeannotationwill make sure it's loaded by the annotation loader./refs symfony/symfony#13623
The text was updated successfully, but these errors were encountered: