Changeset 11471

Timestamp:

09/12/08 12:03:49 (5 years ago)

Author:

fabien

Message:

[1.2] added a lot of REST goodness to symfony 1.2 (live from symfony camp)

Files:

• branches/1.2/UPGRADE_TO_1_2 (modified) (4 diffs)
• branches/1.2/lib/autoload/sfCoreAutoload.class.php (modified) (2 diffs)
• branches/1.2/lib/config/sfRoutingConfigHandler.class.php (modified) (2 diffs)
• branches/1.2/lib/controller/sfWebController.class.php (modified) (6 diffs)
• branches/1.2/lib/exception/sfError404Exception.class.php (modified) (1 diff)
• branches/1.2/lib/generator/sfCrudGenerator.class.php (modified) (2 diffs)
• branches/1.2/lib/helper/UrlHelper.php (modified) (4 diffs)
• branches/1.2/lib/routing/sfObjectRoute.class.php (added)
• branches/1.2/lib/routing/sfObjectRouteCollection.class.php (added)
• branches/1.2/lib/routing/sfPatternRouting.class.php (modified) (2 diffs)
• branches/1.2/lib/routing/sfRouteCollection.class.php (added)
• branches/1.2/lib/routing/sfRouting.class.php (modified) (1 diff)
• branches/1.2/lib/task/app (added)
• branches/1.2/lib/task/app/sfAppRoutesTask.class.php (added)
• branches/1.2/test/unit/helper/UrlHelperTest.php (modified) (2 diffs)

branches/1.2/UPGRADE_TO_1_2

@@ -26 +26 @@
-
-The remaining sections explain the main changes made in symfony 1.2.
-
-
-Propel
@@ -786 +785 @@
-task name is still available as an alias.
-
+The `non-atomic-actions` option of `propel:generate-module` has been removed
+and some new options have been added:
+
+  * singular:          The singular name for the actions and templates
+  * plural:            The plural name for the actions and templates
+  * route-prefix:      The route prefix to use
+  * with-propel-route: Whether the related routes are Propel aware
+
+The new `propel:generate-module-for-route` generates a module based on a route
+definition:
+
+    [php]
+    php symfony propel:generate-module-for-route frontend articles
+
+As symfony now can auto-generate routes (see below), the `app:routes` task
+displays the list of current routes for an application:
+
+    [php]
+    php symfony app:routes frontend
+
+If you want to get some details about a route, just add the route name:
+
+    [php]
+    php symfony app:routes frontend articles_update
+
-Routing
--------
@@ -899 +923 @@
-    // /articles?page=2
-
+symfony 1.2 comes with another route class that extends `sfRequestRoute`,
+`sfObjectRoute`.
+
+`sfObjectRoute` binds a route to a PHP object. A `sfObjectRoute` will
+call some methods on your PHP class to get the object, or a collection of
+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
+     options: { model: Article, object: article, method: getById }
+
+When an incoming URL matches the route, the `sfObjectRoute` will get the
+related object by calling the `Article::getById()` method and will inject
+the result into the request attributes (under the `article` key).
+
+The same goes for a collection of objects:
+
+    [yml]
+    articles:
+      url:     /articles/newest
+      class:   sfObjectRoute
+      options: { model: Article, list: articles, method: getNewest }
+
+`sfPropelRoute` extends `sfObjectRoute` to bind a route to a Propel model.
+
+Here is an example for an `Article` Propel object:
+
+    [yml]
+    article:
+      url:     /article/:id
+      param:   { module: article, action: show }
+      class:   sfPropelRoute
+      options: { model: Article, object: article }
+
+    articles:
+      url:     /articles
+      param:   { module: article, action: list }
+      class:   sfPropelRoute
+      options: { model: Article, list: articles, method: getPublishedArticleCriteria }
+
+If you don't define a method, `sfPropelRoute` will retrieve the object
+by building a Criteria object based on the available route variables.
+
+The `sfPropelRoute` has two main advantages over `sfRoute`:
+
+  * When a request comes in and the route matches the URL, `sfPropelRoute`
+    will automatically inject the related `Article` object with a name of `article`.
+    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
+    your actions.
+
+  * When you generate a link for this route, you can use the new `url_for()`
+    signature and pass the article object directly for the parameters argument:
+
+        [php]
+        <?php echo url_for('article', $article) ?>
+
+    If you have to pass extra parameters (to enforce a HTTP method for example),
+    you can use an array like this:
+
+        [php]
+        <?php echo url_for('article', array('sf_subject' => $article, 'sf_method' => 'get')) ?>
+
+    And of course, you can still use the full parameters:
+
+        [php]
+        <?php echo url_for('article', array('id' => $article->getId(), 'slug' => $article->getSlug())) ?>
+
+    Or use the internal URI:
+
+        <?php echo url_for('@article?id='.$article->getId().'&slug='.$article->getSlug()) ?>
+
+    The `sfPropelRoute` converts the article object to an array of parameters automatically.
+
+`sfPropelRoute` does not only work with the primary key. It can also work with
+any column. In the following example, let's add the `slug` column to the route
+pattern:
+
+    [yml]
+    article:
+      url:     /article/:id/:slug
+      param:   { module: article, action: show }
+      class:   sfPropelRoute
+      options: { model: Article, object: article }
+
+But sometimes, you want to put in the pattern some information that does not
+exist in the database. In this case, you can pass a `method` option:
+
+    [yml]
+    post:
+      url:     /post/:id/:year/:month/:day/:slug
+      param:   { module: article, action: show }
+      class:   sfPropelRoute
+      options: { model: Article, object: article, method: getObjectForRoute }
+
+The `getObjectForRoute()` receives an array of parameters as its first
+argument and must return an `Article` object:
+
+    [php]
+    class ArticlePeer extends BaseArticlePeer
+    {
+      static public function getObjectForRoute($parameters)
+      {
+        $criteria = new Criteria();
+        $criteria->add(self::ID, $parameters['id']);
+
+        return self::doSelectOne($criteria);
+      }
+    }
+
-URL helpers
------------
@@ -917 +1056 @@
-    // and equivalent to
-    <?php echo link_to('@some_route', array('method' => 'post')) ?>
+
+The `url_for()` and `link_to()` helpers support new signatures.
+Instead of an internal URI, they can now also take the route name and
+an array of parameters:
+
+    [php]
+    echo url_for('@article', array('id' => 1));
+    echo link_to('Link to article', '@article', array('id' => 1));
+
+The old behavior still works without changing anything to your code.

branches/1.2/lib/autoload/sfCoreAutoload.class.php

@@ -296 +296 @@
-  'sfWebResponse' => 'response',
-  'sfNoRouting' => 'routing',
+  'sfObjectRoute' => 'routing',
+  'sfObjectRouteCollection' => 'routing',
-  'sfPathInfoRouting' => 'routing',
-  'sfPatternRouting' => 'routing',
-  'sfRequestRoute' => 'routing',
-  'sfRoute' => 'routing',
+  'sfRouteCollection' => 'routing',
-  'sfRouting' => 'routing',
-  'sfDatabaseSessionStorage' => 'storage',
@@ -310 +313 @@
-  'sfSessionTestStorage' => 'storage',
-  'sfStorage' => 'storage',
+  'sfAppRoutesTask' => 'task/app',
-  'sfCacheClearTask' => 'task/cache',
-  'sfConfigureAuthorTask' => 'task/configure',

branches/1.2/lib/config/sfRoutingConfigHandler.class.php

@@ -29 +29 @@
-  public function execute($configFiles)
-  {
-
-
+
-
-    // connect routes
-    $data = array();
-config as $name => $params
+routes as $name => $route
-    {
-
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
-    }
-
@@ -52 +47 @@
-                   "// date: %s\nreturn array(\n%s\n);\n", date('Y/m/d H:i:s'), implode("\n", $data)
-    );
+  }
+
+  public function evaluate($configFiles)
+  {
+    $routeDefinitions = $this->parseConfiguration($configFiles);
+
+    $routes = array();
+    foreach ($routeDefinitions as $name => $route)
+    {
+      $arguments = array();
+      foreach ($route[1] as $argument)
+      {
+        $arguments[] = is_array($argument) ? var_export($argument, true) : sprintf("'%s'", $argument);
+      }
+
+      $r = new ReflectionClass($route[0]);
+      $routes[$name] = $r->newInstanceArgs($route[1]);
+    }
+
+    return $routes;
+  }
+
+  protected function parseConfiguration($configFiles)
+  {
+    // parse the yaml
+    $config = self::getConfiguration($configFiles);
+
+    // collect routes
+    $routes = array();
+    foreach ($config as $name => $params)
+    {
+      if (
+        (isset($params['type']) && 'collection' == $params['type'])
+        ||
+        (isset($params['class']) && false !== strpos($params['class'], 'Collection'))
+      )
+      {
+        $options = isset($params['options']) ? $params['options'] : array();
+        $options['name'] = $name;
+        $options['requirements'] = isset($params['requirements']) ? $params['requirements'] : array();
+
+        $routes[$name] = array(isset($params['class']) ? $params['class'] : 'sfRouteCollection', array($options));
+      }
+      else
+      {
+        $routes[$name] = array(isset($params['class']) ? $params['class'] : 'sfRoute', array(
+          $params['url'] ? $params['url'] : '/',
+          isset($params['params']) ? $params['params'] : (isset($params['param']) ? $params['param'] : array()),
+          isset($params['requirements']) ? $params['requirements'] : array(),
+          isset($params['options']) ? $params['options'] : array(),
+        ));
+      }
+    }
+
+    return $routes;
-  }
-

branches/1.2/lib/controller/sfWebController.class.php

@@ -87 +87 @@
-    $givenUrl = $url;
-
-      
-_s
-  
+
+S
+
-
-    // empty url?
@@ -100 +100 @@
-    if ($pos = strpos($url, '?'))
-    {
-_s
+S
-      $url = substr($url, 0, $pos);
-    }
@@ -124 +124 @@
-      list($params['module'], $params['action']) = explode('/', $url);
-    }
+    else if (!$queryString)
+    {
+      $route = $givenUrl;
+    }
-    else
-    {
@@ -130 +134 @@
-
-    // split the query string
-_s
+S
-    {
-      $matched = preg_match_all('/
@@ -139 +143 @@
-          (?=&[^&=]+=) | $  # followed by another key= or the end of the string
-        )
-_s
+S
-      foreach ($matches as $match)
-      {
@@ -148 +152 @@
-      if (!$matched)
-      {
-_s
+S
-      }
-    }

branches/1.2/lib/exception/sfError404Exception.class.php

@@ -26 +26 @@
-    $exception = is_null($this->wrappedException) ? $this : $this->wrappedException;
-
-
+ && !sfConfig::get('sf_test')
-    {
-      $response = sfContext::getInstance()->getResponse();

branches/1.2/lib/generator/sfCrudGenerator.class.php

@@ -260 +260 @@
-   * @return string PHP code
-   */
-
+, $full = false
-  {
-    $params = array();
@@ -267 +267 @@
-      $phpName   = $pk->getPhpName();
-      $fieldName = sfInflector::underscore($phpName);
-
+
+
+
+
+
+
+
+
-    }
-

branches/1.2/lib/helper/UrlHelper.php

@@ -18 +18 @@
- */
-
+function link_to2($name, $routeName, $params, $options = array())
+{
+  $params = array_merge(array('sf_route' => $routeName), is_object($params) ? array('sf_subject' => $params) : $params);
+
+  return link_to1($name, $params, $options);
+}
+
+function link_to1($name, $internal_uri, $options = array())
+{
+  $html_options = _parse_attributes($options);
+
+  $html_options = _convert_options_to_javascript($html_options);
+
+  $absolute = false;
+  if (isset($html_options['absolute_url']))
+  {
+    $html_options['absolute'] = $html_options['absolute_url'];
+    unset($html_options['absolute_url']);
+  }
+  if (isset($html_options['absolute']))
+  {
+    $absolute = (boolean) $html_options['absolute'];
+    unset($html_options['absolute']);
+  }
+
+  $html_options['href'] = url_for($internal_uri, $absolute);
+
+  if (isset($html_options['query_string']))
+  {
+    $html_options['href'] .= '?'.$html_options['query_string'];
+    unset($html_options['query_string']);
+  }
+
+  if (isset($html_options['anchor']))
+  {
+    $html_options['href'] .= '#'.$html_options['anchor'];
+    unset($html_options['anchor']);
+  }
+
+  if (is_object($name))
+  {
+    if (method_exists($name, '__toString'))
+    {
+      $name = $name->__toString();
+    }
+    else
+    {
+      throw new sfException(sprintf('Object of class "%s" cannot be converted to string (Please create a __toString() method).', get_class($name)));
+    }
+  }
+
+  if (!strlen($name))
+  {
+    $name = $html_options['href'];
+  }
+
+  return content_tag('a', $name, $html_options);
+}
+
+function url_for2($routeName, $params = array(), $absolute = false)
+{
+  $params = array_merge(array('sf_route' => $routeName), is_object($params) ? array('sf_subject' => $params) : $params);
+
+  return url_for1($params, $absolute);
+}
+
+function url_for1($internal_uri, $absolute = false)
+{
+  return sfContext::getInstance()->getController()->genUrl($internal_uri, $absolute);
+}
-
-/**
@@ -37 +107 @@
- * @return string routed URL
- */
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-}
-
@@ -81 +160 @@
- * @see    url_for
- */
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-}
-
@@ -277 +337 @@
- * @see    url_for, link_to
- */
- =''
+
-{
-  $html_options = _parse_attributes($options);

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

@@ -244 +244 @@
-    }
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-    }
-
@@ -422 +426 @@
-  }
-
+  static public function flattenRoutes($routes)
+  {
+    $flattenRoutes = array();
+    foreach ($routes as $name => $route)
+    {
+      if ($route instanceof sfRouteCollection)
+      {
+        $flattenRoutes = array_merge($flattenRoutes, self::flattenRoutes($route));
+      }
+      else
+      {
+        $flattenRoutes[$name] = $route;
+      }
+    }
+
+    return $flattenRoutes;
+  }
+
-  protected function getRouteThatMatchesUrl($url)
-  {

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

@@ -242 +242 @@
-  {
-    $context = $event->getParameters();
-    unset($context['path_info']);
-
-    $this->options['context'] = $context;

branches/1.2/test/unit/helper/UrlHelperTest.php

@@ -48 +48 @@
-// url_for()
-$t->diag('url_for()');
-
-
-
+@
+@
+@
-
-// link_to()
-$t->diag('link_to()');
-
-
-
-
-
-
+, '@homepage'
+@homepage
+@homepage
+@homepage
+@homepage
+, '@homepage'
-
-
+ 
-$t->diag('button_to()');
-
-'
-'
-'
-'
-'
-'
+, '@homepage'
+ '@homepage
+ '@homepage
+ '@homepage
+ '@homepage
+ '@homepage
+ '@homepage
-
-class testObject
-{
-}
+
-try
-{
-  $o1 = new testObject();
-
+, '@homepage'
-  $t->fail('link_to() can take an object as its first argument if __toString() method is defined');
-}
@@ -93 +94 @@
-}
-$o2 = new testObjectWithToString();
-
+, '@homepage'
-
-// link_to_if()
-$t->diag('link_to_if()');
-
-
-
-
-
-
+@homepage
+@homepage
+@homepage
+@homepage
+@homepage
+@homepage
-
-// link_to_unless()
-$t->diag('link_to_unless()');
-
-
+@homepage
+@homepage
-
-// public_path()