[Routing] added new schemes and methods options to the annotation loader

fabpot · fabpot · commit 65eca8a3d9e7 · 2013-01-15T17:22:41.000+01:00
diff --git a/src/Symfony/Component/Routing/Annotation/Route.php b/src/Symfony/Component/Routing/Annotation/Route.php
@@ -26,6 +26,8 @@ class Route
     private $options;
     private $defaults;
     private $hostname;
+    private $methods;
+    private $schemes;
 
     /**
      * Constructor.
@@ -37,6 +39,8 @@ 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['path'] = $data['value'];
@@ -127,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/Loader/AnnotationClassLoader.php b/src/Symfony/Component/Routing/Loader/AnnotationClassLoader.php
@@ -29,8 +29,9 @@
  * and on each method.
  *
  * The @Route annotation main value is the route path. 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:
+ * 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")
@@ -112,6 +113,8 @@ public function load($class, $type = null)
             'requirements' => array(),
             'options'      => array(),
             'defaults'     => array(),
+            'schemes'      => array(),
+            'methods'      => array(),
             'hostname'     => '',
         );
 
@@ -140,6 +143,14 @@ public function load($class, $type = null)
                 $globals['defaults'] = $annot->getDefaults();
             }
 
+            if (null !== $annot->getSchemes()) {
+                $globals['schemes'] = $annot->getSchemes();
+            }
+
+            if (null !== $annot->getMethods()) {
+                $globals['methods'] = $annot->getMethods();
+            }
+
             if (null !== $annot->getHostname()) {
                 $globals['hostname'] = $annot->getHostname();
             }
@@ -175,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());
 
         $hostname = $annot->getHostname();
         if (null === $hostname) {
             $hostname = $globals['hostname'];
         }
 
-        $route = new Route($globals['path'].$annot->getPath(), $defaults, $requirements, $options, $hostname);
+        $route = new Route($globals['path'].$annot->getPath(), $defaults, $requirements, $options, $hostname, $schemes, $methods);
 
         $this->configureRoute($route, $class, $method, $annot);
 
diff --git a/src/Symfony/Component/Routing/Tests/Annotation/RouteTest.php b/src/Symfony/Component/Routing/Tests/Annotation/RouteTest.php
@@ -41,6 +41,8 @@ public function getValidParameters()
            array('options', array('compiler_class' => 'RouteCompiler'), 'getOptions'),
            array('name', 'blog_index', 'getName'),
            array('defaults', array('_controller' => 'MyBlogBundle:Blog:index'), 'getDefaults'),
+           array('schemes', array('https'), 'getSchemes'),
+           array('methods', array('GET', 'POST'), 'getMethods'),
            array('hostname', array('{locale}.example.com'), 'getHostname')
         );
     }
diff --git a/src/Symfony/Component/Routing/Tests/Loader/AnnotationClassLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/AnnotationClassLoaderTest.php
@@ -93,6 +93,8 @@ public function testLoad($className, $routeDatas = array(), $methodArgs = array(
             'requirements' => array(),
             'options'      => array(),
             'defaults'     => array(),
+            'schemes'      => array(),
+            'methods'      => array(),
         ), $routeDatas);
 
         $this->reader

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,8 @@ public function getValidParameters()`
`41`	`41`	`array('options', array('compiler_class' => 'RouteCompiler'), 'getOptions'),`
`42`	`42`	`array('name', 'blog_index', 'getName'),`
`43`	`43`	`array('defaults', array('_controller' => 'MyBlogBundle:Blog:index'), 'getDefaults'),`
	`44`	`+ array('schemes', array('https'), 'getSchemes'),`
	`45`	`+ array('methods', array('GET', 'POST'), 'getMethods'),`
`44`	`46`	`array('hostname', array('{locale}.example.com'), 'getHostname')`
`45`	`47`	`);`
`46`	`48`	`}`