Changeset 12969

Timestamp:

11/13/08 12:29:35 (8 months ago)

Author:

fabien

Message:

[1.2] fixed URL generation when custom tokens have been defined

Files:

• branches/1.2/lib/routing/sfRoute.class.php (modified) (12 diffs)
• branches/1.2/test/unit/routing/sfRouteTest.php (modified) (2 diffs)

branches/1.2/lib/routing/sfRoute.class.php

@@ -32 +32 @@
-    $defaults          = array(),
-    $requirements      = array(),
-
+
+
-
-  /**
@@ -211 +212 @@
-    }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-    }
-    else
@@ -278 +243 @@
-
-  /**
+   * Generates a URL for the given parameters by using the route tokens.
+   *
+   * @param array $parameters An array of parameters
+   */
+  protected function generateWithTokens($parameters)
+  {
+    $url = array();
+    $optional = $this->options['generate_shortest_url'];
+    $first = true;
+    $tokens = array_reverse($this->tokens);
+    foreach ($tokens as $token)
+    {
+      switch ($token[0])
+      {
+        case 'variable':
+          if (!$optional || !isset($this->defaults[$token[3]]) || $parameters[$token[3]] != $this->defaults[$token[3]])
+          {
+            $url[] = urlencode($parameters[$token[3]]);
+            $optional = false;
+          }
+          break;
+        case 'text':
+          $url[] = $token[2];
+          $optional = false;
+          break;
+        case 'separator':
+          if (false === $optional || $first)
+          {
+            $url[] = $token[2];
+          }
+          break;
+        default:
+          // handle custom tokens
+          if ($segment = call_user_func_array(array($this, 'generateFor'.ucfirst(array_shift($token))), array_merge(array($optional, $parameters), $token)))
+          {
+            $url[] = $segment;
+            $optional = false;
+          }
+          break;
+      }
+
+      $first = false;
+    }
+
+    $url = implode('', array_reverse($url));
+    if (!$url)
+    {
+      $url = '/';
+    }
+
+    return $url;
+  }
+
+  /**
-   * Returns the compiled pattern.
-   *
@@ -423 +442 @@
-  }
-
+  /**
+   * Pre-compiles a route.
+   */
-  protected function preCompile()
-  {
@@ -432 +454 @@
-  }
-
+  /**
+   * Post-compiles a route.
+   */
-  protected function postCompile()
-  {
@@ -443 +468 @@
-  }
-
+  /**
+   * Tokenizes the route.
+   */
-  protected function tokenize()
-  {
@@ -455 +483 @@
-      if (false !== $this->tokenizeBufferBefore($buffer, $tokens, $afterASeparator, $currentSeparator))
-      {
+        // a custom token
+        $this->customToken = true;
-      }
-      else if ($afterASeparator && preg_match('#^'.$this->options['variable_prefix_regex'].'('.$this->options['variable_regex'].')#', $buffer, $match))
@@ -485 +515 @@
-      else if (false !== $this->tokenizeBufferAfter($buffer, $tokens, $afterASeparator, $currentSeparator))
-      {
+        // a custom token
+        $this->customToken = true;
-      }
-      else
@@ -494 +526 @@
-  }
-
+  /**
+   * Tokenizes the buffer before default logic is applied.
+   *
+   * This method must return false if the buffer has not been parsed.
+   *
+   * @param string   $buffer           The current route buffer
+   * @param array    $tokens           An array of current tokens
+   * @param Boolean  $afterASeparator  Whether the buffer is just after a separator
+   * @param string   $currentSeparator The last matched separator
+   *
+   * @return Boolean true if a token has been generated, false otherwise
+   */
-  protected function tokenizeBufferBefore(&$buffer, &$tokens, &$afterASeparator, &$currentSeparator)
-  {
@@ -499 +543 @@
-  }
-
+  /**
+   * Tokenizes the buffer after default logic is applied.
+   *
+   * This method must return false if the buffer has not been parsed.
+   *
+   * @param string   $buffer           The current route buffer
+   * @param array    $tokens           An array of current tokens
+   * @param Boolean  $afterASeparator  Whether the buffer is just after a separator
+   * @param string   $currentSeparator The last matched separator
+   *
+   * @return Boolean true if a token has been generated, false otherwise
+   */
-  protected function tokenizeBufferAfter(&$buffer, &$tokens, &$afterASeparator, &$currentSeparator)
-  {
@@ -598 +654 @@
-  }
-
-tparam
+parameter
-  {
-    if (false === strpos($this->regex, '<_star>'))
@@ -606 +662 @@
-
-    $tmp = array();
-tparam
+parameter
-    {
-      if (is_array($value))

branches/1.2/test/unit/routing/sfRouteTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-1
+3
-
-// ->matchesUrl()
@@ -148 +148 @@
-$route = new sfRoute('/foo/:foo/*');
-$t->is($route->generate(array('foo' => 'bar', 'bar' => 'foo')), '/foo/bar/bar/foo', '->generateStarParameter() replaces * with all the key/pair values that are not variables');
+
+// custom token
+$t->diag('custom token');
+
+class MyRoute extends sfRoute
+{
+  protected function tokenizeBufferBefore(&$buffer, &$tokens, &$afterASeparator, &$currentSeparator)
+  {
+    if ($afterASeparator && preg_match('#^=('.$this->options['variable_regex'].')#', $buffer, $match))
+    {
+      // a labelled variable
+      $this->tokens[] = array('label', $currentSeparator, $match[0], $match[1]);
+
+      $currentSeparator = '';
+      $buffer = substr($buffer, strlen($match[0]));
+      $afterASeparator = false;
+    }
+    else
+    {
+      return false;
+    }
+  }
+
+  protected function compileForLabel($separator, $name, $variable)
+  {
+    if (!isset($this->requirements[$variable]))
+    {
+      $this->requirements[$variable] = $this->options['variable_content_regex'];
+    }
+
+    $this->segments[] = preg_quote($separator, '#').$variable.$separator.'(?P<'.$variable.'>'.$this->requirements[$variable].')';
+    $this->variables[$variable] = $name;
+
+    if (!isset($this->defaults[$variable]))
+    {
+      $this->firstOptional = count($this->segments);
+    }
+  }
+
+  protected function generateForLabel($optional, $tparams, $separator, $name, $variable)
+  {
+    if (!empty($tparams[$variable]) && (!$optional || !isset($this->defaults[$variable]) || $tparams[$variable] != $this->defaults[$variable]))
+    {
+      return $variable . '/' . urlencode($tparams[$variable]);
+    }
+  }
+}
+
+$route = new MyRoute('/=foo');
+$t->is($route->matchesUrl('/foo/bar'), array('foo' => 'bar'), '->tokenizeBufferBefore() allows to add a custom token');
+$t->is($route->generate(array('foo' => 'bar')), '/foo/bar', '->compileForLabel() adds logic to generate a route for a custom token');