Changeset 11794

Timestamp:

09/26/08 11:05:48 (5 years ago)

Author:

fabien

Message:

[1.2] changed the way routes work, objects are not injected automatically anymore in the request attributes (closes #4395)

Files:

• branches/1.2/UPGRADE_TO_1_2 (modified) (7 diffs)
• branches/1.2/lib/action/sfAction.class.php (modified) (1 diff)
• branches/1.2/lib/request/sfWebRequest.class.php (modified) (2 diffs)
• branches/1.2/lib/routing/sfObjectRoute.class.php (modified) (4 diffs)
• branches/1.2/lib/routing/sfObjectRouteCollection.class.php (modified) (8 diffs)
• branches/1.2/lib/routing/sfPatternRouting.class.php (modified) (4 diffs)
• branches/1.2/lib/routing/sfRequestRoute.class.php (modified) (1 diff)
• branches/1.2/lib/routing/sfRoute.class.php (modified) (4 diffs)
• branches/1.2/lib/routing/sfRouting.class.php (modified) (1 diff)
• branches/1.2/lib/view/sfViewCacheManager.class.php (modified) (1 diff)
• branches/1.2/test/unit/routing/sfPatternRoutingTest.php (modified) (2 diffs)
• branches/1.2/test/unit/routing/sfRouteTest.php (modified) (3 diffs)

branches/1.2/UPGRADE_TO_1_2

@@ -945 +945 @@
-    $routing->connect('foo_bar', $route);
-
+When a request comes in, the matching route object is stored as an attribute of the
+request and you can get it from an action via the `getRoute()` method:
+
+    [php]
+    public function executeIndex()
+    {
+      $route = $this->getRoute();
+    }
+
-The `sfRoute` constructor takes an array of options as its last argument to
-allow the customization of each route. In the `routing.yml` configuration file,
@@ -1038 +1047 @@
-objects, related to the route.
-
-The object or the collection of objects will be available in your actions
-via a request attribute:
-
-    [yml]
-    article:
-      url:     /article/:id
-      class:   sfObjectRoute
-object: article
-
-` will get the
-
-the result into the request attributes (under the `article` key)
+type: object
+
+::getObject()`
+
+method
-
-The same goes for a collection of objects:
@@ -1057 +1063 @@
-      url:     /articles/newest
-      class:   sfObjectRoute
-list: articles
+type: list
-
-`sfPropelRoute` extends `sfObjectRoute` to bind a route to a Propel model.
+
+In your actions, you can retrieve the related object or collection of objects
+by using the `sfObjectRoute::getObject()` and `sfObjectRoute::getObjects()`
+methods:
+
+    [php]
+    public function executeList($request)
+    {
+      $this->articles = $this->getRoute()->getObjects();
+    }
+
+    public function executeShow($request)
+    {
+      $this->article = $this->getRoute()->getObject();
+    }
-
-Here is an example for an `Article` Propel object:
@@ -1068 +1089 @@
-      param:   { module: article, action: show }
-      class:   sfPropelRoute
-object: article
+type: object
-
-    articles:
@@ -1074 +1095 @@
-      param:   { module: article, action: list }
-      class:   sfPropelRoute
-list: articles
+type: list
-
-If you don't define a method, `sfPropelRoute` will retrieve the object
-Criteria
+`Criteria`
-
-The `sfPropelRoute` has two main advantages over `sfRoute`:
-
-
-
+
+
+
-    Moreover, if the object does not exist in the database, it will automatically
-    redirect the user to a 404 error page. This means less boiler-plate code in
@@ -1120 +1142 @@
-      param:   { module: article, action: show }
-      class:   sfPropelRoute
-object: article
+type: object
-
-But sometimes, you want to put in the pattern some information that does not
@@ -1130 +1152 @@
-      param:   { module: article, action: show }
-      class:   sfPropelRoute
-object: article
+type: object
-
-The `getObjectForRoute()` receives an array of parameters as its first

branches/1.2/lib/action/sfAction.class.php

@@ -536 +536 @@
-  }
-
+  public function getRoute()
+  {
+    return $this->getRequest()->getAttribute('sf_route');
+  }
+
-  /**
-   * Returns a formatted message for a 404 error.

branches/1.2/lib/request/sfWebRequest.class.php

@@ -830 +830 @@
-  protected function fixParameters()
-  {
-    // arguments that come from the routing
-    if ($this->getParameter('_arguments'))
-    {
-      $this->getAttributeHolder()->add($this->getParameter('_arguments'));
-      $this->getParameterHolder()->remove('_arguments');
-    }
-
-    // move symfony parameters to attributes (parameters prefixed with _sf_)
-    foreach ($this->parameterHolder->getAll() as $key => $value)
@@ -843 +836 @@
-      {
-        $this->parameterHolder->remove($key);
-$key
+substr($key, 1)
-      }
-    }

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

@@ -35 +35 @@
-    if (!isset($options['model']))
-    {
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-    parent::__construct($pattern, $defaults, $requirements, $options);
@@ -47 +52 @@
-
-  /**
-   * Returns true if the URL matches this route, false otherwise.
-   *
-   * @param  string  $url     The URL
-   * @param  array   $context The context
-   *
-   * @return array   An array composed of an array of parameters and an array of extra parameters
-   */
-  public function matchesUrl($url, $context = array())
-  {
-    if (false === $parameters = parent::matchesUrl($url, $context))
-    {
-      return false;
-    }
-
-    if (isset($this->options['object']))
-    {
-      // check the related object
-      if (is_null($object = $this->getObjectForParameters($parameters[0])) && (!isset($this->options['allow_empty']) || !$this->options['allow_empty']))
-      {
-        throw new sfError404Exception(sprintf('Unable to find the %s object with the following parameters "%s").', $this->options['model'], str_replace("\n", '', var_export($this->filterParameters($parameters[0]), true))));
-      }
-
-      return array($parameters[0], array_merge($parameters[1], array($this->options['object'] => false === $object ? null : $object)));
-    }
-    else
-    {
-      // object list
-      $objects = $this->getObjectsForParameters($parameters[0]);
-
-      if (is_array($objects) && !count($objects) && isset($this->options['allow_empty']) && !$this->options['allow_empty'])
-      {
-        throw new sfError404Exception(sprintf('No %s object found for the following parameters "%s").', $this->options['model'], str_replace("\n", '', var_export($this->filterParameters($parameters[0]), true))));
-      }
-
-      return array($parameters[0], array_merge($parameters[1], array($this->options['list'] => false === $objects ? array() : $objects)));
-    }
-  }
-
-  /**
-   * Returns true if the parameters matches this route, false otherwise.
-   *
-
+ 
-   * @param  array  $context The context
-   *
@@ -95 +61 @@
-  public function matchesParameters($params, $context = array())
-  {
-isset($this->options['object'])
+'object' == $this->options['type']
-  }
-
@@ -109 +75 @@
-  public function generate($params, $context = array(), $absolute = false)
-  {
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-

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

@@ -37 +37 @@
-
-    $this->options = array_merge(array(
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-    ), $this->options);
-
@@ -80 +78 @@
-      array('module' => $this->options['module'], 'action' => $this->getActionMethod('list'), 'sf_format' => 'html'),
-      array_merge($this->options['requirements'], array('sf_method' => 'get')),
-list' => $this->options['plural']
+type' => 'list'
-    );
-  }
@@ -90 +88 @@
-      array('module' => $this->options['module'], 'action' => $this->getActionMethod('new'), 'sf_format' => 'html'),
-      array_merge($this->options['requirements'], array('sf_method' => 'get')),
-object' => $this->options['singular']
+type' => 'object'
-    );
-  }
@@ -100 +98 @@
-      array('module' => $this->options['module'], 'action' => $this->getActionMethod('create'), 'sf_format' => 'html'),
-      array_merge($this->options['requirements'], array('sf_method' => 'post')),
-object' => $this->options['singular']
+type' => 'object'
-    );
-  }
@@ -110 +108 @@
-      array('module' => $this->options['module'], 'action' => $this->getActionMethod('show'), 'sf_format' => 'html'),
-      array_merge($this->options['requirements'], array('sf_method' => 'get')),
-object' => $this->options['singular']
+type' => 'object'
-    );
-  }
@@ -120 +118 @@
-      array('module' => $this->options['module'], 'action' => $this->getActionMethod('edit'), 'sf_format' => 'html'),
-      array_merge($this->options['requirements'], array('sf_method' => 'get')),
-object' => $this->options['singular']
+type' => 'object'
-    );
-  }
@@ -130 +128 @@
-      array('module' => $this->options['module'], 'action' => $this->getActionMethod('update'), 'sf_format' => 'html'),
-      array_merge($this->options['requirements'], array('sf_method' => 'put')),
-object' => $this->options['singular']
+type' => 'object'
-    );
-  }
@@ -140 +138 @@
-      array('module' => $this->options['module'], 'action' => $this->getActionMethod('delete'), 'sf_format' => 'html'),
-      array('sf_method' => 'delete'),
-object' => $this->options['singular']
+type' => 'object'
-    );
-  }

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

@@ -350 +350 @@
-    }
-
+    if ($this->options['logging'])
+    {
+      $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Match route "%s" (%s) for %s with parameters %s', $info['name'], $info['pattern'], $url, str_replace("\n", '', var_export($info['parameters'], true))))));
+    }
+
+    // store the current internal URI
+    $this->updateCurrentInternalUri($info['name'], $info['parameters']);
+
+    $route = $this->routes[$info['name']];
+    $route->bind($this->options['context'], $info['parameters']);
+    $info['parameters']['_sf_route'] = $route;
+
+    return $info['parameters'];
+  }
+
+  protected function updateCurrentInternalUri($name, array $parameters)
+  {
-    // store the route name
-
-
-
-
-
-
-
-
-
-
+
+
-    $internalUri = array('@'.$this->currentRouteName, $parameters['module'].'/'.$parameters['action']);
-    unset($parameters['module'], $parameters['action']);
@@ -376 +385 @@
-
-    $this->currentInternalUri = array($internalUri[0].$params, $internalUri[1].$params);
-
-    if ($info['extra_parameters'])
-    {
-      return array_merge($info['parameters'], array('_arguments' => $info['extra_parameters']));
-    }
-    else
-    {
-      return $info['parameters'];
-    }
-  }
-
@@ -418 +418 @@
-    $info = $this->getRouteThatMatchesUrl($url);
-
- only if there is no extra parameters
- && !count($info['extra_parameters'])
+
+
-    {
-      $this->cacheChanged = true;
@@ -455 +455 @@
-      }
-
-[0], 'extra_parameters' => $parameters[1]
+
-    }
-

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

@@ -27 +27 @@
-   * @param  array   $context The context
-   *
-composed of an array of parameters and an array of extra
+of
-   */
-  public function matchesUrl($url, $context = array())

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

@@ -20 +20 @@
-{
-  protected
+    $isBound           = false,
+    $context           = null,
+    $parameters        = null,
-    $defaultParameters = array(),
-    $defaultOptions    = array(),
@@ -56 +59 @@
-
-  /**
+   * Binds the current route for a given context and parameters.
+   *
+   * @param array $context    The context
+   * @param array $parameters The parameters
+   */
+  public function bind($context, $parameters)
+  {
+    $this->isBound    = true;
+    $this->context    = $context;
+    $this->parameters = $parameters;
+  }
+
+  /**
+   * Returns true if the form is bound to input values.
+   *
+   * @return Boolean true if the form is bound to input values, false otherwise
+   */
+  public function isBound()
+  {
+    return $this->isBound;
+  }
+
+  /**
-   * Returns true if the URL matches this route, false otherwise.
-   *
@@ -61 +87 @@
-   * @param  array   $context The context
-   *
-composed of an array of parameters and an array of extra
+of
-   */
-  public function matchesUrl($url, $context = array())
@@ -97 +123 @@
-    }
-
-array($parameters, array())
+$parameters
-  }
-

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

@@ -243 +243 @@
-   * Listens to the request.filter_parameters event.
-   *
-
- @param array   $parameters  An array of parameters for the event
-
+ 
+
+ @return array   $parameters  An array of parameters for the event
-   */
-  public function filterParametersEvent(sfEvent $event, $parameters)

branches/1.2/lib/view/sfViewCacheManager.class.php

@@ -435 +435 @@
-  {
-    // ignore cache parameter? (only available in debug mode)
-_
+
-    {
-      if (sfConfig::get('sf_logging_enabled'))

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

@@ -15 +15 @@
-class sfPatternRoutingTest extends sfPatternRouting
-{
+  public function parse($url)
+  {
+    $parameters = parent::parse($url);
+    unset($parameters['_sf_route']);
+
+    return $parameters;
+  }
+
-  public function getCurrentRouteName()
-  {
@@ -472 +480 @@
-$parameters = $rCached->findRoute('/test');
-$t->is($parameters,
-, 'extra_parameters' => array()
+
-       '->findRoute() returns information about matching route');
-$t->is($rCached->getCurrentInternalUri(), 'default/index', '->findRoute() does not change the internal URI of sfPatternRouting');

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

@@ -16 +16 @@
-$t->diag('->matchesUrl()');
-$route = new sfRoute('/');
-array(), array()
+
-$t->is($route->matchesUrl('/foo'), false, '->matchesUrl() returns false if the route does not match');
-
-$route = new sfRoute('/', array('foo' => 'bar'));
-array('foo' => 'bar'), array()
+'foo' => 'bar'
-
-$route = new sfRoute('/:bar', array('foo' => 'bar'));
-array('foo' => 'bar', 'bar' => 'foobar'), array()
+'foo' => 'bar', 'bar' => 'foobar'
-
-$route = new sfRoute('/:foo', array('foo' => 'bar'));
-array('foo' => 'foobar'), array()
+'foo' => 'foobar'
-
-$route = new sfRoute('/:foo', array('foo' => 'bar'));
-array('foo' => 'bar'), array()
+'foo' => 'bar'
-
-$route = new sfRoute('/foo/:foo/bar/:bar', array('foo' => 'bar', 'bar' => 'foo'));
-array('foo' => 'bar', 'bar' => 'foo'), array()
+'foo' => 'bar', 'bar' => 'foo'
-
-$route = new sfRoute('/:foo/:bar', array('foo' => 'bar', 'bar' => 'foo'));
-array('foo' => 'bar', 'bar' => 'foo'), array()
+'foo' => 'bar', 'bar' => 'foo'
-
-$route = new sfRoute('/', array());
-$route->setDefaultParameters(array('foo' => 'bar'));
-array('foo' => 'bar'), array()
+'foo' => 'bar'
-
-$route = new sfRoute('/', array('foo' => 'foobar'));
-$route->setDefaultParameters(array('foo' => 'bar'));
-array('foo' => 'foobar'), array()
+'foo' => 'foobar'
-
-$route = new sfRoute('/:foo', array('foo' => 'foobar'));
-$route->setDefaultParameters(array('foo' => 'bar'));
-array('foo' => 'barfoo'), array()
+'foo' => 'barfoo'
-
-$route = new sfRoute('/:foo', array(), array('foo' => '\d+'));
@@ -53 +53 @@
-
-$route = new sfRoute('/:foo', array(), array('foo' => '\w+'));
-array('foo' => 'bar'), array()
+'foo' => 'bar'
-
-// ->matchesParameters()
@@ -130 +130 @@
-$t->diag('->parseStarParameter()');
-$route = new sfRoute('/foo/*');
-array('foo' => 'bar', 'bar' => 'foo'), array()
-array('foo' => 'foo.bar'), array()
-array(), array()
+'foo' => 'bar', 'bar' => 'foo'
+'foo' => 'foo.bar'
+
-
-$route = new sfRoute('/foo/*', array('module' => 'foo'));
-array('foo' => 'bar', 'module' => 'foo'), array()
+'foo' => 'bar', 'module' => 'foo'
-
-$route = new sfRoute('/:foo/*');
-array('foo' => 'bar'), array()
+'foo' => 'bar'
-
-$route = new sfRoute('/foo/*/bar');
-array('foo' => 'bar'), array()
-array(), array()
+'foo' => 'bar'
+
-
-// ->generateStarParameter()