Adds support for return types on methods

In php7 return types are added to the syntax of php. This
change adds the detection of return types to the method factory.

Author: jaapio

src/phpDocumentor/Reflection/Php/Factory/Method.php

@@ -12,14 +12,14 @@
 
 namespace phpDocumentor\Reflection\Php\Factory;
 
-use InvalidArgumentException;
 use phpDocumentor\Reflection\Location;
 use phpDocumentor\Reflection\Php\Method as MethodDescriptor;
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
 use phpDocumentor\Reflection\Php\StrategyContainer;
 use phpDocumentor\Reflection\Php\Visibility;
+use phpDocumentor\Reflection\TypeResolver;
 use phpDocumentor\Reflection\Types\Context;
-use PhpParser\Comment\Doc;
+use phpDocumentor\Reflection\Types\Mixed_;
 use PhpParser\Node\Stmt\ClassMethod;
 
 /**
@@ -50,14 +50,21 @@ protected function doCreate($object, StrategyContainer $strategies, Context $con
     {
         $docBlock = $this->createDocBlock($strategies, $object->getDocComment(), $context);
 
+        $returnType = null;
+        if ($object->returnType !== null) {
+            $typeResolver = new TypeResolver();
+            $returnType = $typeResolver->resolve($object->returnType, $context);
+        }
+
         $method = new MethodDescriptor(
             $object->fqsen,
             $this->buildVisibility($object),
             $docBlock,
             $object->isAbstract(),
             $object->isStatic(),
             $object->isFinal(),
-            new Location($object->getLine())
+            new Location($object->getLine()),
+            $returnType
         );
 
         foreach ($object->params as $param) {

src/phpDocumentor/Reflection/Php/Method.php

@@ -17,6 +17,8 @@
 use phpDocumentor\Reflection\Element;
 use phpDocumentor\Reflection\Location;
 use phpDocumentor\Reflection\Php\Visibility;
+use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\Mixed_;
 
 /**
  * Descriptor representing a Method in a Class, Interface or Trait.
@@ -52,6 +54,10 @@ final class Method implements Element
      * @var Location
      */
     private $location;
+    /**
+     * @var Type
+     */
+    private $returnType;
 
     /**
      * Initializes the all properties.
@@ -63,6 +69,7 @@ final class Method implements Element
      * @param bool $static
      * @param bool $final
      * @param Location|null $location
+     * @param Type $returnType
      */
     public function __construct(
         Fqsen $fqsen,
@@ -71,7 +78,8 @@ public function __construct(
         $abstract = false,
         $static = false,
         $final = false,
-        Location $location = null
+        Location $location = null,
+        Type $returnType = null
     ) {
         $this->fqsen = $fqsen;
         $this->visibility = $visibility;
@@ -85,10 +93,15 @@ public function __construct(
             $location = new Location(-1);
         }
 
+        if ($returnType ===  null) {
+            $returnType = new Mixed_();
+        }
+
         $this->abstract = $abstract;
         $this->static = $static;
         $this->final = $final;
         $this->location = $location;
+        $this->returnType = $returnType;
     }
 
     /**
@@ -190,4 +203,18 @@ public function getLocation()
     {
         return $this->location;
     }
+
+    /**
+     * Returns the in code defined return type.
+     *
+     * Return types are introduced in php 7.0 when your could doesn't have a
+     * return type defined this method will return Mixed_ by default. The return value of this
+     * method is not affected by the return tag in your docblock.
+     *
+     * @return Type
+     */
+    public function getReturnType()
+    {
+        return $this->returnType;
+    }
 }

tests/component/ProjectCreationTest.php

@@ -15,8 +15,10 @@
 use Mockery as m;
 use phpDocumentor\Reflection\DocBlock\Tags\Param;
 use phpDocumentor\Reflection\File\LocalFile;
+use phpDocumentor\Reflection\Php\Interface_;
 use phpDocumentor\Reflection\Php\ProjectFactory;
 use phpDocumentor\Reflection\Types\Object_;
+use phpDocumentor\Reflection\Types\String_;
 
 /**
  * Intergration tests to check the correct working of processing a file into a project.
@@ -173,4 +175,17 @@ public function testInterfaceExtends()
         $this->assertEquals(['\\Packing' => new Fqsen('\\Packing')], $interface->getParents());
 
     }
+
+    public function testMethodReturnType()
+    {
+        $fileName = __DIR__ . '/project/Packing.php';
+        $project = $this->fixture->create('MyProject', [
+            new LocalFile($fileName)
+        ]);
+
+        $this->assertArrayHasKey('\\Packing', $project->getFiles()[$fileName]->getInterfaces());
+        $interface = current($project->getFiles()[$fileName]->getInterfaces());
+
+        $this->assertEquals(new String_(),  $interface->getMethods()['\Packing::getName()']->getReturnType());
+    }
 }

tests/component/project/Packing.php

@@ -12,5 +12,5 @@
 
 interface Packing
 {
-    public function getName();
-}
+    public function getName() : string;
+}

tests/unit/phpDocumentor/Reflection/Php/MethodTest.php

@@ -15,6 +15,8 @@
 use \Mockery as m;
 use phpDocumentor\Reflection\DocBlock;
 use phpDocumentor\Reflection\Fqsen;
+use phpDocumentor\Reflection\Types\Mixed_;
+use phpDocumentor\Reflection\Types\String_;
 
 /**
  * Tests the functionality for the Method class.
@@ -135,4 +137,35 @@ public function testGetDefaultVisibility()
         $method = new Method($this->fqsen);
         $this->assertEquals(new Visibility('public'), $method->getVisibility());
     }
+
+    /**
+     * @covers ::getReturnType
+     * @covers ::__construct
+     */
+    public function testGetDefaultReturnType()
+    {
+        $method = new Method($this->fqsen);
+        $this->assertEquals(new Mixed_(), $method->getReturnType());
+    }
+
+    /**
+     * @covers ::getReturnType
+     * @covers ::__construct
+     */
+    public function testGetReturnTypeFromConstructor()
+    {
+        $returnType = new String_();
+        $method = new Method(
+            $this->fqsen,
+            new Visibility('public'),
+            null,
+            false,
+            false,
+            false,
+            null,
+            $returnType
+        );
+
+        $this->assertSame($returnType, $method->getReturnType());
+    }
 }