Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

Commit 7235d86

Browse files
committed
document the route_collection_limit configuration
1 parent 04d8a80 commit 7235d86

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

bundles/routing/dynamic.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,17 @@ For the implementation details, please refer to the
480480
:ref:`component-routing-generator` section in the the cmf routing component
481481
documentation.
482482

483+
.. sidebar:: Dumping Routes
484+
485+
The ``RouterInterface`` defines the method ``getRouteCollection`` to get
486+
all routes available in a router. The ``DynamicRouter`` is able to provide
487+
such a collection, however this feature is disabled by default to avoid
488+
dumping large numbers of routes. You can set
489+
``cmf_routing.dynamic.route_collection_limit`` to a value bigger than 0
490+
to have the router return routes up to the limit, or ``null`` to disable
491+
limits and return all routes. Then you can for example see the dynamic
492+
routes in the ``router:debug`` command.
493+
483494
Handling RedirectRoutes
484495
-----------------------
485496

reference/configuration/routing.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,16 @@ setting is set as controller.
286286
),
287287
));
288288
289+
route_collection_limit
290+
......................
291+
292+
**type**: ``scalar``, **default**: ``0``
293+
294+
If this value is set to a number bigger than 0, the routes from the database
295+
are returned in the getRouteCollection. The limit serves to prevent huge route
296+
lists if you have a large database. Setting the limit to ``null`` disables the
297+
limit entirely.
298+
289299
persistence
290300
...........
291301

0 commit comments

Comments
 (0)