Merge pull request #453 from symfony-cmf/routing-dump-d

document the route_collection_limit configuration

Author: wouterj

bundles/routing/dynamic.rst

@@ -480,6 +480,19 @@ For the implementation details, please refer to the
 :ref:`component-routing-generator` section in the the cmf routing component
 documentation.
 
+.. sidebar:: Dumping Routes
+
+    The ``RouterInterface`` defines the method ``getRouteCollection`` to get
+    all routes available in a router. The ``DynamicRouter`` is able to provide
+    such a collection, however this feature is disabled by default to avoid
+    dumping large numbers of routes. You can set
+    ``cmf_routing.dynamic.route_collection_limit`` to a value bigger than 0
+    to have the router return routes up to the limit or ``false`` to disable
+    limits and return all routes.
+
+    With this option activated, tools like the ``router:debug`` command or the
+    `FOSJsRoutingBundle`_ will also show the routes coming from the database.
+
 Handling RedirectRoutes
 -----------------------
 
@@ -579,3 +592,4 @@ Read on in the chapter :doc:`customizing the dynamic router <dynamic_customize>`
 .. _`URL generating capabilities of Symfony2`: http://symfony.com/doc/current/book/routing.html#generating-urls
 .. _SonataDoctrinePHPCRAdminBundle: http://sonata-project.org/bundles/doctrine-phpcr-admin/master/doc/index.html
 .. _`configuring sonata admin`: http://sonata-project.org/bundles/doctrine-phpcr-admin/master/doc/reference/configuration.html
+.. _`FOSJsRoutingBundle`: https://github.com/FriendsOfSymfony/FOSJsRoutingBundle

reference/configuration/routing.rst

@@ -286,6 +286,16 @@ setting is set as controller.
             ),
         ));
 
+route_collection_limit
+......................
+
+**type**: ``scalar``, **default**: ``0``
+
+If this value is set to a number bigger than 0, the routes from the database
+are returned in the ``getRouteCollection``. The limit serves to prevent huge
+route lists if you have a large database. Setting the limit to ``false``
+disables the limit entirely.
+
 persistence
 ...........