Merge pull request #640 from therealmikz/annotations-widening

Annotations widening

Author: lsmith77

Controller/Annotations/NoRoute.php

@@ -14,7 +14,7 @@
 /**
  * No Route annotation class
  * @Annotation
- * @Target("METHOD")
+ * @Target({"METHOD","CLASS"})
  */
 class NoRoute extends Route
 {

Controller/Annotations/QueryParam.php

@@ -15,7 +15,7 @@
  * Represents a parameter that must be present in GET data.
  *
  * @Annotation
- * @Target("METHOD")
+ * @Target({"CLASS", "METHOD"})
  * @author Alexander <[email protected]>
  */
 class QueryParam extends Param

Request/ParamReader.php

@@ -44,16 +44,19 @@ public function read(\ReflectionClass $reflection, $method)
             throw new \InvalidArgumentException(sprintf("Class '%s' has no method '%s' method.", $reflection->getName(), $method));
         }
 
-        return $this->getParamsFromMethod($reflection->getMethod($method));
+        $methodParams = $this->getParamsFromMethod($reflection->getMethod($method));
+        $classParams = $this->getParamsFromClass($reflection);
+        return array_merge($methodParams, $classParams);
     }
-
+    
     /**
-     * {@inheritDoc}
+     * Fetches parameters from provided annotation array (fetched from annotationReader)
+     * 
+     * @param array $annotations
+     * @return \FOS\RestBundle\Controller\Annotations\Param
      */
-    public function getParamsFromMethod(\ReflectionMethod $method)
+    private function getParamsFromAnnotationArray(array $annotations)
     {
-        $annotations = $this->annotationReader->getMethodAnnotations($method);
-
         $params = array();
         foreach ($annotations as $annotation) {
             if ($annotation instanceof Param) {
@@ -63,4 +66,25 @@ public function getParamsFromMethod(\ReflectionMethod $method)
 
         return $params;
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getParamsFromMethod(\ReflectionMethod $method)
+    {
+        $annotations = $this->annotationReader->getMethodAnnotations($method);
+
+        return $this->getParamsFromAnnotationArray($annotations);
+    }
+    
+    /**
+     * 
+     * {@inheritDoc}
+     */
+    public function getParamsFromClass(\ReflectionClass $class)
+    {
+        $annotations = $this->annotationReader->getClassAnnotations($class);
+        
+        return $this->getParamsFromAnnotationArray($annotations);
+    }
 }

Request/ParamReaderInterface.php

@@ -37,4 +37,12 @@ public function read(\ReflectionClass $reflection, $method);
      * @return array Param annotation objects of the method. Indexed by parameter name.
      */
     public function getParamsFromMethod(\ReflectionMethod $method);
+    
+    /**
+     * 
+     * @param \ReflectionClass $class
+     * 
+     * @return array Param annotation objects of the class. Indexed by parameter name.
+     */
+    public function getParamsFromClass(\ReflectionClass $class);
 }

Routing/Loader/Reader/RestActionReader.php

@@ -235,9 +235,16 @@ private function isMethodReadable(\ReflectionMethod $method)
         if ('_' === substr($method->getName(), 0, 1)) {
             return false;
         }
-
-        // if method has NoRoute annotation - skip
-        if ($this->readMethodAnnotation($method, 'NoRoute')) {
+        
+        $hasNoRouteMethod = (bool) $this->readMethodAnnotation($method, 'NoRoute');
+        $hasNoRouteClass = (bool) $this->readClassAnnotation($method->getDeclaringClass(), 'NoRoute');
+        
+        $hasNoRoute = $hasNoRoute = $hasNoRouteMethod || $hasNoRouteClass;
+        // since NoRoute extends Route we need to exclude all the method NoRoute annotations
+        $hasRoute = (bool) $this->readMethodAnnotation($method, 'Route') && !$hasNoRouteMethod;
+        
+        // if method has NoRoute annotation and does not have Route annotation - skip
+        if ($hasNoRoute && !$hasRoute) {
             return false;
         }
 
@@ -426,6 +433,23 @@ private function readRouteAnnotation(\ReflectionMethod $reflection)
         }
     }
 
+    /**
+     * Reads class annotations.
+     *
+     * @param ReflectionClass $reflection     controller class
+     * @param string          $annotationName annotation name
+     *
+     * @return Annotation|null
+     */
+    private function readClassAnnotation(\ReflectionClass $reflection, $annotationName)
+    {
+        $annotationClass = "FOS\\RestBundle\\Controller\\Annotations\\$annotationName";
+
+        if ($annotation = $this->annotationReader->getClassAnnotation($reflection, $annotationClass)) {
+            return $annotation;
+        }
+    }
+
     /**
      * Reads method annotations.
      *

Routing/Loader/Reader/RestControllerReader.php

@@ -100,7 +100,7 @@ public function read(\ReflectionClass $reflection)
     }
 
     /**
-     * Reads
+     * Reads class annotations.
      *
      * @param ReflectionClass $reflection     controller class
      * @param string          $annotationName annotation name

Tests/Request/ParamReaderTest.php

@@ -31,26 +31,48 @@ public function setup()
     {
         $annotationReader = $this->getMock('Doctrine\Common\Annotations\Reader');
 
-        $annotations = array();
+        $methodAnnotations = array();
         $foo = new QueryParam;
         $foo->name = 'foo';
         $foo->requirements = '\d+';
         $foo->description = 'The foo';
-        $annotations[] = $foo;
+        $methodAnnotations[] = $foo;
 
         $bar = new QueryParam;
         $bar->name = 'bar';
         $bar->requirements = '\d+';
         $bar->description = 'The bar';
-        $annotations[] = $bar;
+        $methodAnnotations[] = $bar;
 
-        $annotations[] = new NamePrefix(array());
+        $methodAnnotations[] = new NamePrefix(array());
 
         $annotationReader
             ->expects($this->any())
             ->method('getMethodAnnotations')
-            ->will($this->returnValue($annotations));
+            ->will($this->returnValue($methodAnnotations));
 
+        $classAnnotations = array();
+        
+        $baz = new QueryParam;
+        $baz->name = 'baz';
+        $baz->requirements = '\d+';
+        $baz->description = 'The baz';
+        $classAnnotations[] = $baz;
+        
+        $mikz = new QueryParam;
+        $mikz->name = 'mikz';
+        $mikz->requirements = '\d+';
+        $mikz->description = 'The real mikz';
+        $classAnnotations[] = $mikz;
+        
+        $not = new NamePrefix(array());
+        $classAnnotations[] = $not;
+        
+        $annotationReader
+                ->expects($this->any())
+                ->method('getClassAnnotations')
+                ->will($this->returnValue($classAnnotations));
+        
         $this->paramReader = new ParamReader($annotationReader);
     }
 
@@ -61,7 +83,7 @@ public function testReadsOnlyParamAnnotations()
     {
         $annotations = $this->paramReader->read(new \ReflectionClass(__CLASS__), 'setup');
 
-        $this->assertCount(2, $annotations);
+        $this->assertCount(4, $annotations);
 
         foreach ($annotations as $name => $annotation) {
             $this->assertThat($annotation, $this->isInstanceOf('FOS\RestBundle\Controller\Annotations\Param'));