symfony · fabpot · Jan 15, 2013 · Nov 13, 2012 · Nov 15, 2012 · Nov 15, 2012
diff --git a/UPGRADE-3.0.md b/UPGRADE-3.0.md
@@ -0,0 +1,47 @@
+UPGRADE FROM 2.x to 3.0
+=======================
+
+### Routing
+
+ * Some route settings have been renamed:
+
+    * The `pattern` setting for a route has been deprecated in favor of `path`
+    * The `_scheme` and `_method` requirements have been moved to the `schemes` and `methods` settings
+
+   Before:
+
+   ```
+   article_edit:
+       pattern: /article/{id}
+       requirements: { '_method': 'POST|PUT', '_scheme': 'https', 'id': '\d+' }
+
+   <route id="article_edit" pattern="/article/{id}">
+       <requirement key="_method">POST|PUT</requirement>
+       <requirement key="_scheme">https</requirement>
+       <requirement key="id">\d+</requirement>
+   </route>
+
+   $route = new Route();
+   $route->setPattern('/article/{id}');
+   $route->setRequirement('_method', 'POST|PUT');
+   $route->setRequirement('_scheme', 'https');
+   ```
+
+   After:
+
+   ```
+   article_edit:
+       path: /article/{id}
+       methods: [POST, PUT]
+       schemes: https
+       requirements: { 'id': '\d+' }
+
+   <route id="article_edit" pattern="/article/{id}" methods="POST PUT" schemes="https">
+       <requirement key="id">\d+</requirement>
+   </route>
+
+   $route = new Route();
+   $route->setPath('/article/{id}');
+   $route->setMethods(array('POST', 'PUT'));
+   $route->setSchemes('https');
+   ```
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php
@@ -92,7 +92,7 @@ protected function outputRoutes(OutputInterface $output, $routes = null)
                     ? implode(', ', $requirements['_method']) : $requirements['_method']
                 )
                 : 'ANY';
-            $hostname = '' !== $route->getHostnamePattern() ? $route->getHostnamePattern() : 'ANY';
+            $hostname = '' !== $route->getHostname() ? $route->getHostname() : 'ANY';
             $maxName = max($maxName, strlen($name));
             $maxMethod = max($maxMethod, strlen($method));
             $maxHostname = max($maxHostname, strlen($hostname));
@@ -109,7 +109,7 @@ protected function outputRoutes(OutputInterface $output, $routes = null)
                     ? implode(', ', $requirements['_method']) : $requirements['_method']
                 )
                 : 'ANY';
-            $hostname = '' !== $route->getHostnamePattern() ? $route->getHostnamePattern() : 'ANY';
+            $hostname = '' !== $route->getHostname() ? $route->getHostname() : 'ANY';
             $output->writeln(sprintf($format, $name, $method, $hostname, $route->getPattern()));
         }
     }
@@ -124,14 +124,14 @@ protected function outputRoute(OutputInterface $output, $name)
             throw new \InvalidArgumentException(sprintf('The route "%s" does not exist.', $name));
         }
 
-        $hostname = '' !== $route->getHostnamePattern() ? $route->getHostnamePattern() : 'ANY';
+        $hostname = '' !== $route->getHostname() ? $route->getHostname() : 'ANY';
 
         $output->writeln($this->getHelper('formatter')->formatSection('router', sprintf('Route "%s"', $name)));
 
-        $output->writeln(sprintf('<comment>Name</comment>         %s', $name));
-        $output->writeln(sprintf('<comment>Pattern</comment>      %s', $route->getPattern()));
-        $output->writeln(sprintf('<comment>HostnamePattern</comment>  %s', $hostname));
-        $output->writeln(sprintf('<comment>Class</comment>        %s', get_class($route)));
+        $output->writeln(sprintf('<comment>Name</comment>      %s', $name));
+        $output->writeln(sprintf('<comment>Pattern</comment>   %s', $route->getPattern()));
+        $output->writeln(sprintf('<comment>Hostname</comment>  %s', $hostname));
+        $output->writeln(sprintf('<comment>Class</comment>     %s', get_class($route)));
 
         $defaults = '';
         $d = $route->getDefaults();

diff --git a/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php b/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php
@@ -78,7 +78,7 @@ public function warmUp($cacheDir)
      * - the route defaults,
      * - the route requirements,
      * - the route pattern.
-     * - the route hostnamePattern.
+     * - the route hostname.
      *
      * @param RouteCollection $collection
      */
@@ -94,7 +94,7 @@ private function resolveParameters(RouteCollection $collection)
             }
 
             $route->setPattern($this->resolve($route->getPattern()));
-            $route->setHostnamePattern($this->resolve($route->getHostnamePattern()));
+            $route->setHostname($this->resolve($route->getHostname()));
         }
     }
 

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Routing/RouterTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Routing/RouterTest.php
@@ -117,12 +117,12 @@ public function testPatternPlaceholders()
         );
     }
 
-    public function testHostnamePatternPlaceholders()
+    public function testHostnamePlaceholders()
     {
         $routes = new RouteCollection();
 
         $route = new Route('foo');
-        $route->setHostnamePattern('/before/%parameter.foo%/after/%%unescaped%%');
+        $route->setHostname('/before/%parameter.foo%/after/%%unescaped%%');
 
         $routes->add('foo', $route);
 
@@ -136,7 +136,7 @@ public function testHostnamePatternPlaceholders()
 
         $this->assertEquals(
             '/before/foo/after/%unescaped%',
-            $route->getHostnamePattern()
+            $route->getHostname()
         );
     }
 

diff --git a/src/Symfony/Component/Routing/Annotation/Route.php b/src/Symfony/Component/Routing/Annotation/Route.php
@@ -20,12 +20,14 @@
  */
 class Route
 {
-    private $pattern;
+    private $path;
     private $name;
     private $requirements;
     private $options;
     private $defaults;
-    private $hostnamePattern;
+    private $hostname;
+    private $methods;
+    private $schemes;
 
     /**
      * Constructor.
@@ -37,9 +39,11 @@ public function __construct(array $data)
         $this->requirements = array();
         $this->options = array();
         $this->defaults = array();
+        $this->methods = array();
+        $this->schemes = array();
 
         if (isset($data['value'])) {
-            $data['pattern'] = $data['value'];
+            $data['path'] = $data['value'];
             unset($data['value']);
         }
 
@@ -52,24 +56,40 @@ public function __construct(array $data)
         }
     }
 
+    /**
+     * @deprecated Deprecated in 2.2, to be removed in 3.0. Use setPath instead.
+     */
     public function setPattern($pattern)
     {
-        $this->pattern = $pattern;
+        $this->path = $pattern;
     }
 
+    /**
+     * @deprecated Deprecated in 2.2, to be removed in 3.0. Use getPath instead.
+     */
     public function getPattern()
     {
-        return $this->pattern;
+        return $this->path;
     }
 
-    public function setHostnamePattern($pattern)
+    public function setPath($path)
     {
-        $this->hostnamePattern = $pattern;
+        $this->path = $path;
     }
 
-    public function getHostnamePattern()
+    public function getPath()
     {
-        return $this->hostnamePattern;
+        return $this->path;
+    }
+
+    public function setHostname($pattern)
+    {
+        $this->hostname = $pattern;
+    }
+
+    public function getHostname()
+    {
+        return $this->hostname;
     }
 
     public function setName($name)
@@ -111,4 +131,24 @@ public function getDefaults()
     {
         return $this->defaults;
     }
+
+    public function setSchemes($schemes)
+    {
+        $this->schemes = is_array($schemes) ? $schemes : array($schemes);
+    }
+
+    public function getSchemes()
+    {
+        return $this->schemes;
+    }
+
+    public function setMethods($methods)
+    {
+        $this->methods = is_array($methods) ? $methods : array($methods);
+    }
+
+    public function getMethods()
+    {
+        return $this->methods;
+    }
 }
diff --git a/src/Symfony/Component/Routing/CHANGELOG.md b/src/Symfony/Component/Routing/CHANGELOG.md
@@ -4,6 +4,49 @@ CHANGELOG
 2.2.0
 -----
 
+ * [DEPRECATION] Several route settings have been renamed (the old ones will be removed in 3.0):
+
+    * The `pattern` setting for a route has been deprecated in favor of `path`
+    * The `_scheme` and `_method` requirements have been moved to the `schemes` and `methods` settings
+
+   Before:
+
+   ```
+   article_edit:
+       pattern: /article/{id}
+       requirements: { '_method': 'POST|PUT', '_scheme': 'https', 'id': '\d+' }
+
+   <route id="article_edit" pattern="/article/{id}">
+       <requirement key="_method">POST|PUT</requirement>
+       <requirement key="_scheme">https</requirement>
+       <requirement key="id">\d+</requirement>
+   </route>
+
+   $route = new Route();
+   $route->setPattern('/article/{id}');
+   $route->setRequirement('_method', 'POST|PUT');
+   $route->setRequirement('_scheme', 'https');
+   ```
+
+   After:
+
+   ```
+   article_edit:
+       path: /article/{id}
+       methods: [POST, PUT]
+       schemes: https
+       requirements: { 'id': '\d+' }
+
+   <route id="article_edit" pattern="/article/{id}" methods="POST PUT" schemes="https">
+       <requirement key="id">\d+</requirement>
+   </route>
+
+   $route = new Route();
+   $route->setPath('/article/{id}');
+   $route->setMethods(array('POST', 'PUT'));
+   $route->setSchemes('https');
+   ```
+
  * [BC BREAK] RouteCollection does not behave like a tree structure anymore but as
    a flat array of Routes. So when using PHP to build the RouteCollection, you must
    make sure to add routes to the sub-collection before adding it to the parent

diff --git a/src/Symfony/Component/Routing/Loader/AnnotationClassLoader.php b/src/Symfony/Component/Routing/Loader/AnnotationClassLoader.php
@@ -28,9 +28,10 @@
  * The @Route annotation can be set on the class (for global parameters),
  * and on each method.
  *
- * The @Route annotation main value is the route pattern. The annotation also
- * recognizes three parameters: requirements, options, and name. The name parameter
- * is mandatory. Here is an example of how you should be able to use it:
+ * The @Route annotation main value is the route path. The annotation also
+ * recognizes several parameters: requirements, options, defaults, schemes,
+ * methods, hostname, and name. The name parameter is mandatory.
+ * Here is an example of how you should be able to use it:
  *
  *     /**
  *      * @Route("/Blog")
@@ -108,11 +109,13 @@ public function load($class, $type = null)
         }
 
         $globals = array(
-            'pattern'          => '',
-            'requirements'     => array(),
-            'options'          => array(),
-            'defaults'         => array(),
-            'hostname_pattern' => '',
+            'path'         => '',
+            'requirements' => array(),
+            'options'      => array(),
+            'defaults'     => array(),
+            'schemes'      => array(),
+            'methods'      => array(),
+            'hostname'     => '',
         );
 
         $class = new \ReflectionClass($class);
@@ -121,8 +124,11 @@ public function load($class, $type = null)
         }
 
         if ($annot = $this->reader->getClassAnnotation($class, $this->routeAnnotationClass)) {
-            if (null !== $annot->getPattern()) {
-                $globals['pattern'] = $annot->getPattern();
+            // for BC reasons
+            if (null !== $annot->getPath()) {
+                $globals['path'] = $annot->getPath();
+            } elseif (null !== $annot->getPattern()) {
+                $globals['path'] = $annot->getPattern();
             }
 
             if (null !== $annot->getRequirements()) {
@@ -137,8 +143,16 @@ public function load($class, $type = null)
                 $globals['defaults'] = $annot->getDefaults();
             }
 
-            if (null !== $annot->getHostnamePattern()) {
-                $globals['hostname_pattern'] = $annot->getHostnamePattern();
+            if (null !== $annot->getSchemes()) {
+                $globals['schemes'] = $annot->getSchemes();
+            }
+
+            if (null !== $annot->getMethods()) {
+                $globals['methods'] = $annot->getMethods();
+            }
+
+            if (null !== $annot->getHostname()) {
+                $globals['hostname'] = $annot->getHostname();
             }
         }
 
@@ -172,13 +186,15 @@ protected function addRoute(RouteCollection $collection, $annot, $globals, \Refl
         }
         $requirements = array_replace($globals['requirements'], $annot->getRequirements());
         $options = array_replace($globals['options'], $annot->getOptions());
+        $schemes = array_replace($globals['schemes'], $annot->getSchemes());
+        $methods = array_replace($globals['methods'], $annot->getMethods());
 
-        $hostnamePattern = $annot->getHostnamePattern();
-        if (null === $hostnamePattern) {
-            $hostnamePattern = $globals['hostname_pattern'];
+        $hostname = $annot->getHostname();
+        if (null === $hostname) {
+            $hostname = $globals['hostname'];
         }
 
-        $route = new Route($globals['pattern'].$annot->getPattern(), $defaults, $requirements, $options, $hostnamePattern);
+        $route = new Route($globals['path'].$annot->getPath(), $defaults, $requirements, $options, $hostname, $schemes, $methods);
 
         $this->configureRoute($route, $class, $method, $annot);