minor symfony#9845 Explain how to check if a route exists (javiereguiluz)

javiereguiluz · javiereguiluz · commit 190511332b5a · 2018-05-29T08:48:22.000+02:00
This PR was merged into the 2.8 branch. Discussion ---------- Explain how to check if a route exists This fixes symfony#6710. Commits ------- 1c29700 Explain how to check if a route exists
diff --git a/components/routing.rst b/components/routing.rst
@@ -229,6 +229,28 @@ a certain route::
     of the current :class:`Symfony\\Component\\Routing\\RequestContext` does
     not match the requirement.
 
+Check if a Route Exists
+~~~~~~~~~~~~~~~~~~~~~~~
+
+In highly dynamic applications, it may be necessary to check whether a route
+exists before using it to generate a URL. In those cases, don't use the
+:method:`Symfony\\Component\\Routing\\Router::getRouteCollection` method because
+that regenerates the routing cache and slows down the application.
+
+Instead, try to generate the URL and catch the
+:class:`Symfony\\Component\\Routing\\Exception\\RouteNotFoundException` thrown
+when the route doesn't exist::
+
+    use Symfony\Component\Routing\Exception\RouteNotFoundException;
+
+    // ...
+
+    try {
+        $url = $generator->generate($dynamicRouteName, $parameters);
+    } catch (RouteNotFoundException $e) {
+        // the route is not defined...
+    }
+
 Load Routes from a File
 ~~~~~~~~~~~~~~~~~~~~~~~
 
