documenting the limit on candidates

Author: dbu

bundles/routing/dynamic_customize.rst

@@ -24,7 +24,9 @@ You can add your own :ref:`RouteEnhancerInterface <bundles-routing-dynamic_route
 implementations if you have a case not handled by the
 :ref:`provided enhancers <component-routing-enhancers>`. Simply define services
 for your enhancers and tag them with ``dynamic_router_route_enhancer`` to have
-them added to the routing.
+them added to the routing. You can specify an optional ``priority`` parameter
+on the tag to control the order in which enhancers are executed. The higher the
+priority, the earlier the enhancer is executed.
 
 .. index:: Route Provider
 .. _bundle-routing-custom_provider:

bundles/simple_cms/multilang.rst

@@ -4,7 +4,7 @@
 Multi-Language Support
 ----------------------
 
-Setting ``addLocalePattern`` to ``true`` in a
+Setting the option ``add_locale_pattern`` to ``true`` in a
 ``Symfony\Cmf\Bundle\SimpleCmsBundle\Doctrine\Phpcr\Page`` document will
 result in prefixing the associated route with ``/{_locale}``. Using the native
 translation capabilities of PHPCR ODM it is now possible to create different
@@ -42,7 +42,7 @@ For example::
     will have the same node name for all languages. So a url
     ``http://foo.com/en/hello-world`` for english content will look like
     ``http://foo.com/de/hello-world`` for german content.
-    
+
     At times it might be most feasible to use integers as the node names and
     simple append the title of the node in the given locale as an anchor. So
     for example ``http://foo.com/de/1#my title`` and

components/routing/nested_matcher.rst

@@ -37,6 +37,12 @@ do any elaborate matching operations yet - this will be done in the later steps.
     implementations for everything needed to get this component running with
     Doctrine PHPCR-ODM as well as with the Doctrine ORM.
 
+.. tip::
+
+    This component provides the ``Candidates`` implementation for the very
+    first step of splitting the URL on the ``/`` to allow matching with
+    variable patterns.
+
 To create and register your own Route Provider, create a class implementing
 ``Symfony\Cmf\Component\Routing\RouteProviderInterface`` which will have the
 following methods::

reference/configuration/routing.rst

@@ -367,15 +367,15 @@ manager_name
 .. include:: partials/persistence_phpcr_manager_name.rst.inc
 
 route_basepaths
-**************
+***************
 
 **type**: ``array`` **default**: ``array('/cms/routes')``
 
 The basepaths where to look for routes in the PHPCR tree.
 
 If the :doc:`CoreBundle <../../bundles/core/index>` is registered, this will
 default to ``%cmf_core.persistence.phpcr.basepath%/routes``. If the
-:doc:`SimpleCmsBundle <../../bundles/simplecms/index>` is registered as well,
+:doc:`SimpleCmsBundle <../../bundles/simple_cms/index>` is registered as well,
 this will additionally default to ``%cmf_core.persistence.phpcr.basepath%/simple``.
 
 content_basepath
@@ -516,8 +516,22 @@ locales
 
 To enable multilanguage, set the valid locales in this option.
 
-If the :doc:`CoreBundle <../../bundles/core/index>` is registered, this will default to the value
-of ``cmf_core.locales``.
+If the :doc:`CoreBundle <../../bundles/core/index>` is registered, this will
+default to the value of ``cmf_core.locales``.
+
+limit_candidates
+~~~~~~~~~~~~~~~~
+
+**type**: ``integer`` **default**: ``20``
+
+With this flag you can tune the routing behaviour when using the dynamic
+pattern part of routes stored in the database. If you do never use the variable
+pattern field of the Route model, you can set this to 1 as a small performance
+optimization.
+
+If you have very complex URLs with patterns, you might need to increase the
+limit, but this will expose your site to load attacks with URLs with lots of
+slashes in them.
 
 match_implicit_locale
 ~~~~~~~~~~~~~~~~~~~~~