Changeset 8806

Timestamp:

05/06/08 15:52:58 (5 months ago)

Author:

FabianLange

Message:

split sfPatternRouting::parse into two methods to allow side-effect free retrieval of route that might match a url. Useful for link rewriting that might want to check if a link will match an internal route, without actually "switching" there. Added PHPdoc for the new sfPatternRouting::findRoute().
Updated PHPdoc on sfRouting::parse, mentioning that this does modify internal state.
Added unit tests to show issue of #3423. no separate tests for findRoute() needed as its implicitly tested by parse() tests. Added test to ensure that it is side effect free. Closes #3423, #3424

Files:

• branches/1.1/lib/routing/sfPatternRouting.class.php (modified) (4 diffs)
• branches/1.1/lib/routing/sfRouting.class.php (modified) (1 diff)
• branches/1.1/test/unit/routing/sfPatternRoutingTest.php (modified) (2 diffs)

branches/1.1/lib/routing/sfPatternRouting.class.php

@@ -595 +595 @@
-  public function parse($url)
-  {
+    if (null !== $routeInfo = $this->findRoute($url))
+    {
+      // store the route name
+      $this->currentRouteName = $routeInfo['name'];
+      $this->currentRouteParameters = $routeInfo['parameters'];
+      $this->currentInternalUri = array();
+
+      if ($this->options['logging'])
+      {
+        $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Match route [%s] for "%s"', $routeInfo['name'], $routeInfo['route']))));
+      }
+    }
+    else
+    {
+      throw new sfError404Exception(sprintf('No matching route found for "%s"', $url));
+    }
+
+    return $this->currentRouteParameters;
+  }
+  
+  
+  /**
+  * Finds a matching route for given URL.
+  * Returned array contains:
+  *  - name       : name or alias of the route that matched
+  *  - route      : the actual matching route
+  *  - parameters : array containing key value pairs of the request parameters including defaults
+  *
+  * @param  string URL to be parsed
+  *
+  * @return array  An array with routing information or null if no route matched
+  */
+  public function findRoute($url)
+  {
-    // an URL should start with a '/', mod_rewrite doesn't respect that, but no-mod_rewrite version does.
-    if ('/' != $url[0])
@@ -619 +653 @@
-    }
-
-found = false
+routeInfo = null
-    foreach ($this->routes as $routeName => $route)
-    {
@@ -629 +663 @@
-
-      $defaults = array_merge($defaults, $this->defaultParameters);
-      $found    = true;
-      $out      = array();
-
@@ -651 +684 @@
-      }
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-      break;
-    }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-  }
-

branches/1.1/lib/routing/sfRouting.class.php

@@ -148 +148 @@
-
- /**
-
+ and sets internal state
-  *
-  * Throws a sfError404Exception if no route match the URL.

branches/1.1/test/unit/routing/sfPatternRoutingTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-29
+35
-
-class sfPatternRoutingTest extends sfPatternRouting
@@ -453 +453 @@
-$t->is($r->getCurrentInternalUri(false), 'foo/bar?id=2', '->getCurrentInternalUri() returns the internal URI for last parsed URL');
-
+// regression for ticket #3423  occuring when cache is used. (for the test its enough to have it non null)
+$rCached = new sfPatternRoutingTest(new sfEventDispatcher(),new sfNoCache());
+$rCached->connect('test',  '/:module', array('action' => 'index'));
+$rCached->connect('test2', '/', array());
+$rCached->parse('/');
+$t->is($rCached->getCurrentInternalUri(), 'default/index', '->getCurrentInternalUri() returns the internal URI for last parsed URL using cache');
+$rCached->parse('/test');
+$t->is($rCached->getCurrentInternalUri(), 'test/index', '->getCurrentInternalUri() returns the internal URI for last parsed URL using cache');
+$rCached->parse('/');
+$t->is($rCached->getCurrentInternalUri(), 'default/index', '->getCurrentInternalUri() returns the internal URI for last parsed URL using cache');
+// findRoute was added to be the side effectless version to check an uri
+$t->is($rCached->findRoute('/test'),
+       array('name' => 'test', 'route' => '/:module', 'parameters' => array('action' => 'index', 'module' => 'test')),
+       '->findRoute() returns information about matching route');
+$t->is($rCached->getCurrentInternalUri(), 'default/index', '->findRoute() does not change the internal URI of sfPatternRouting');
+$t->is($rCached->findRoute('/no/match/found'), null, '->findRoute() returns null on non-matching route');
+
-// defaults
-$t->diag('defaults');