Simplified usage

Author: mnapoli

src/PhpDocReader/PhpDocReader.php

@@ -3,8 +3,6 @@
 namespace PhpDocReader;
 
 use Doctrine\Common\Annotations\PhpParser;
-use ReflectionClass;
-use ReflectionMethod;
 use ReflectionParameter;
 use ReflectionProperty;
 
@@ -30,14 +28,17 @@ public function __construct()
     }
 
     /**
-     * Parse the docblock of the property to get the var annotation
-     * @param ReflectionClass    $class
+     * Parse the docblock of the property to get the var annotation.
+     *
      * @param ReflectionProperty $property
+     *
      * @throws AnnotationException
      * @return string|null Type of the property (content of var annotation)
      */
-    public function getPropertyType(ReflectionClass $class, ReflectionProperty $property)
+    public function getPropertyType(ReflectionProperty $property)
     {
+        $class = $property->getDeclaringClass();
+
         // Get the content of the @var annotation
         if (preg_match('/@var\s+([^\s]+)/', $property->getDocComment(), $matches)) {
             list(, $type) = $matches;
@@ -93,14 +94,18 @@ public function getPropertyType(ReflectionClass $class, ReflectionProperty $prop
     }
 
     /**
-     * Parse the docblock of the property to get the param annotation
-     * @param ReflectionClass  $class
-     * @param ReflectionMethod $method
+     * Parse the docblock of the property to get the param annotation.
+     *
+     * @param ReflectionParameter $parameter
      * @throws AnnotationException
+     *
      * @return string|null Type of the property (content of var annotation)
      */
-    public function getParameterType(ReflectionClass $class, ReflectionMethod $method, ReflectionParameter $parameter)
+    public function getParameterType(ReflectionParameter $parameter)
     {
+        $method = $parameter->getDeclaringFunction();
+        $class = $parameter->getDeclaringClass();
+
         // Use reflection
         $parameterClass = $parameter->getClass();
         if ($parameterClass !== null) {
@@ -121,7 +126,7 @@ public function getParameterType(ReflectionClass $class, ReflectionMethod $metho
             $loweredAlias = strtolower($alias);
 
             // Retrieve "use" statements
-            $uses = $this->phpParser->parseClass($method->getDeclaringClass());
+            $uses = $this->phpParser->parseClass($class);
 
             $found = false;
 

tests/UnitTest/PhpDocReader/PhpDocReaderTest.php

@@ -23,13 +23,13 @@ public function testGetParameterTypeUseStatementBeforeLocalNamespace()
         $target1ReflectionMethod = $target1ReflectionClass->getMethod("SomeMethod");
         $target1ReflectionParams = $target1ReflectionMethod->getParameters();
 
-        $result = $parser->getParameterType($target1ReflectionClass, $target1ReflectionMethod, $target1ReflectionParams[0]);
+        $result = $parser->getParameterType($target1ReflectionParams[0]);
 
         //Since TargetFixture1 file has a use statement to the Subspace namespace, that's the one that should be returned
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\Subspace\SomeDependencyFixture', $result);
 
 
-        $result = $parser->getParameterType($target1ReflectionClass, $target1ReflectionMethod, $target1ReflectionParams[1]);
+        $result = $parser->getParameterType($target1ReflectionParams[1]);
 
         //this parameter should be unaffected by use namespace since it has a relative type path
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\Subspace\SomeDependencyFixture2', $result);
@@ -42,13 +42,13 @@ public function testGetParameterTypeUseStatementBeforeLocalNamespace()
         $target2ReflectionMethod = $target2ReflectionClass->getMethod("SomeMethod");
         $target2ReflectionParams = $target2ReflectionMethod->getParameters();
 
-        $result = $parser->getParameterType($target2ReflectionClass, $target2ReflectionMethod, $target2ReflectionParams[0]);
+        $result = $parser->getParameterType($target2ReflectionParams[0]);
 
         //Since TargetFixture2 file has a use statement with an alias to the Subspace namespace, that's the one that should be returned
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\Subspace\SomeDependencyFixture2', $result);
 
 
-        $result = $parser->getParameterType($target2ReflectionClass, $target2ReflectionMethod, $target2ReflectionParams[1]);
+        $result = $parser->getParameterType($target2ReflectionParams[1]);
 
         //this parameter should be unaffected by use namespace since it has a relative type path
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\Subspace\SomeDependencyFixture2', $result);
@@ -61,13 +61,13 @@ public function testGetParameterTypeUseStatementBeforeLocalNamespace()
         $target3ReflectionMethod = $target3ReflectionClass->getMethod("SomeMethod");
         $target3ReflectionParams = $target3ReflectionMethod->getParameters();
 
-        $result = $parser->getParameterType($target3ReflectionClass, $target3ReflectionMethod, $target3ReflectionParams[0]);
+        $result = $parser->getParameterType($target3ReflectionParams[0]);
 
         //Since TargetFixture3 file has NO use statement, the one local to the target's namespace should be used
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\SomeDependencyFixture', $result);
 
 
-        $result = $parser->getParameterType($target3ReflectionClass, $target3ReflectionMethod, $target3ReflectionParams[1]);
+        $result = $parser->getParameterType($target3ReflectionParams[1]);
 
         //this parameter should be unaffected by use namespace since it has a relative type path
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\Subspace\SomeDependencyFixture2', $result);
@@ -87,15 +87,15 @@ public function testGetPropertyTypeUseStatementBeforeLocalNamespace()
         $target1ReflectionClass = new \ReflectionClass($target1);
         $target1ReflectionProperty1 = $target1ReflectionClass->getProperty("dependency1");
 
-        $result = $parser->getPropertyType($target1ReflectionClass, $target1ReflectionProperty1);
+        $result = $parser->getPropertyType($target1ReflectionProperty1);
 
         //Since TargetFixture1 file has a use statement to the Subspace namespace, that's the one that should be returned
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\Subspace\SomeDependencyFixture', $result);
 
 
         $target1ReflectionProperty2 = $target1ReflectionClass->getProperty("dependency2");
 
-        $result = $parser->getPropertyType($target1ReflectionClass, $target1ReflectionProperty2);
+        $result = $parser->getPropertyType($target1ReflectionProperty2);
 
         //this property should be unaffected by use namespace since it has a relative type path
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\Subspace\SomeDependencyFixture2', $result);
@@ -107,15 +107,15 @@ public function testGetPropertyTypeUseStatementBeforeLocalNamespace()
         $target2ReflectionClass = new \ReflectionClass($target2);
         $target2ReflectionProperty1 = $target2ReflectionClass->getProperty("dependency1");
 
-        $result = $parser->getPropertyType($target2ReflectionClass, $target2ReflectionProperty1);
+        $result = $parser->getPropertyType($target2ReflectionProperty1);
 
         //Since TargetFixture2 file has a use statement with an alias to the Subspace namespace, that's the one that should be returned
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\Subspace\SomeDependencyFixture2', $result);
 
 
         $target2ReflectionProperty2 = $target2ReflectionClass->getProperty("dependency2");
 
-        $result = $parser->getPropertyType($target2ReflectionClass, $target2ReflectionProperty2);
+        $result = $parser->getPropertyType($target2ReflectionProperty2);
 
         //this property should be unaffected by use namespace since it has a relative type path
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\Subspace\SomeDependencyFixture2', $result);
@@ -127,15 +127,15 @@ public function testGetPropertyTypeUseStatementBeforeLocalNamespace()
         $target3ReflectionClass = new \ReflectionClass($target3);
         $target3ReflectionProperty1 = $target3ReflectionClass->getProperty("dependency1");
 
-        $result = $parser->getPropertyType($target3ReflectionClass, $target3ReflectionProperty1);
+        $result = $parser->getPropertyType($target3ReflectionProperty1);
 
         //Since TargetFixture3 file has NO use statement, the one local to the target's namespace should be used
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\SomeDependencyFixture', $result);
 
 
         $target3ReflectionProperty2 = $target3ReflectionClass->getProperty("dependency2");
 
-        $result = $parser->getPropertyType($target3ReflectionClass, $target3ReflectionProperty2);
+        $result = $parser->getPropertyType($target3ReflectionProperty2);
 
         //this property should be unaffected by use namespace since it has a relative type path
         $this->assertEquals('UnitTest\PhpDocReader\Fixtures\Subspace\SomeDependencyFixture2', $result);