Inheritance support

Author: dunglas

.gitignore

@@ -1 +1 @@
-/vendor/
+/vendor/

README.md

@@ -1,6 +1,9 @@
 # PHPDoc to Type Hint
 
-Add automatically scalar type hint and return types to all functions and methods of a PHP project using existing
+[![Build Status](https://travis-ci.org/dunglas/phpdoc-to-typehint.svg?branch=master)](https://travis-ci.org/dunglas/phpdoc-to-typehint)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/dunglas/phpdoc-to-typehint/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/dunglas/phpdoc-to-typehint/?branch=master)
+
+Add automatically scalar type hints and return types to all functions and methods of a PHP project using existing
 PHPDoc annotations.
 
 **Warning**: this project is an early stage and is experimental. It **can** damage your code.

src/Converter.php

@@ -13,7 +13,10 @@
 
 use phpDocumentor\Reflection\DocBlock;
 use phpDocumentor\Reflection\DocBlock\Tag;
+use phpDocumentor\Reflection\Fqsen;
+use phpDocumentor\Reflection\Php\Class_;
 use phpDocumentor\Reflection\Php\File;
+use phpDocumentor\Reflection\Php\Interface_;
 use phpDocumentor\Reflection\Php\Project;
 use phpDocumentor\Reflection\Types\Compound;
 use phpDocumentor\Reflection\Types\Null_;
@@ -252,17 +255,102 @@ private function getDocBlock(Project $project, int $objectType, string $namespac
         }
 
         $fqsen = $namespace.'\\'.$object;
-        $function = sprintf('%s::%s()', $fqsen, $function);
+        $fqfunction = sprintf('%s::%s()', $fqsen, $function);
 
         foreach ($project->getFiles() as $file) {
             foreach ($file->$method() as $obj) {
                 if ($obj->getFqsen()->__toString() === $fqsen) {
-                    return $this->getDocBlockForFunction($obj->getMethods(), $function);
+                    $docBlock = $this->getDocBlockForFunction($obj->getMethods(), $fqfunction);
+
+                    if (
+                        self::OBJECT_TRAIT === $objectType ||
+                        (null !== $docBlock && 0 !== strcasecmp('{@inheritdoc}', trim($docBlock->getSummary())))
+                    ) {
+                        return $docBlock;
+                    }
+
+                    if ($obj instanceof Class_) {
+                        if ($docBlock = $this->getDocBlockForInterfaces($project, $obj->getInterfaces(), $function)) {
+                            return $docBlock;
+                        }
+
+                        $parentFqsen = $obj->getParent();
+                        if (!$parent = $this->getObject($project, $parentFqsen, self::OBJECT_CLASS)) {
+                            return;
+                        }
+
+                        return $this->getDocBlock($project, self::OBJECT_CLASS, $this->getNamespace($parentFqsen), $parent->getName(), $function);
+                    }
+
+                    if ($obj instanceof Interface_ && $docBlock = $this->getDocBlockForInterfaces($project, $obj->getParents(), $function)) {
+                        return $docBlock;
+                    }
                 }
             }
         }
     }
 
+    /**
+     * Extracts a namespace from a FQSEN.
+     *
+     * @param Fqsen $fqsen
+     *
+     * @return string
+     */
+    private function getNamespace(Fqsen $fqsen): string
+    {
+        $value = $fqsen->__toString();
+        return substr($value, 0, strrpos($value, '\\'));
+    }
+
+    /**
+     * Finds a Class_ or an Interface_ instance using its FQSEN.
+     *
+     * @param Project $project
+     * @param Fqsen   $fqsen
+     * @param int     $objectType
+     *
+     * @return Class_|Interface_|null
+     */
+    private function getObject(Project $project, Fqsen $fqsen, int $objectType)
+    {
+        $method = self::OBJECT_CLASS === $objectType ? 'getClasses' : 'getInterfaces';
+
+        foreach ($project->getFiles() as $file) {
+            foreach ($file->$method() as $object) {
+                if ($object->getFqsen()->__toString() === $fqsen->__toString()) {
+                    return $object;
+                }
+            }
+        }
+    }
+
+    /**
+     * Gets a DocBlock from an array of interfaces FQSEN instances.
+     *
+     * @param Project $project
+     * @param Fqsen[] $fqsens
+     * @param string  $function
+     *
+     * @return DocBlock|null
+     */
+    private function getDocBlockForInterfaces(Project $project, array $fqsens, string $function)
+    {
+        foreach ($fqsens as $fqsen) {
+            $object = $this->getObject($project, $fqsen, self::OBJECT_INTERFACE);
+
+            if (!$object) {
+                continue;
+            }
+
+            $docBlock = $this->getDocBlock($project, self::OBJECT_INTERFACE, $this->getNamespace($fqsen), $object->getName(), $function);
+
+            if ($docBlock) {
+                return $docBlock;
+            }
+        }
+    }
+
     /**
      * Gets the DocBlock of a function.
      *
@@ -278,17 +366,7 @@ private function getDocBlockForFunction(array $functions, string $function)
                 continue;
             }
 
-            // TODO: handle inheritance
-
-            if (!$docBlock = $reflectionFunction->getDocblock()) {
-                return;
-            }
-
-            // TODO: handle {@inheritdoc}
-
-            // TODO: cache this for performance
-
-            return $docBlock;
+            return $reflectionFunction->getDocblock();
         }
     }
 

tests/Fixtures/BazTrait.php

@@ -2,7 +2,7 @@
 
 namespace bar;
 
-class BazTrait
+trait BazTrait
 {
     /**
      * @param int $a

tests/test.php

@@ -155,7 +155,7 @@ public function baz(array $a, int $b): float;
 
 namespace bar;
 
-class BazTrait
+trait BazTrait
 {
     /**
      * @param int $a
@@ -171,4 +171,37 @@ protected function inTrait(int $a): \DateTime
     , $converter->convert($project, $file));
 }
 
+$projectFactory = ProjectFactory::createInstance();
+$childPath = __DIR__.'/Fixtures/Child.php';
+$project = $projectFactory->create('inheritance', [$childPath, __DIR__.'/Fixtures/Foo.php', __DIR__.'/Fixtures/BarInterface.php']);
+
+foreach ($project->getFiles() as $path => $file) {
+    if ($childPath === $path) {
+        same(<<<'PHP'
+<?php
+
+namespace bar;
+
+class Child extends Foo implements BarInterface
+{
+    use BazTrait;
+
+    public function test(float $a)
+    {
+        parent::test($a);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function baz(array $a, int $b): float
+    {
+    }
+}
+
+PHP
+        , $converter->convert($project, $file));
+    }
+}
+
 echo 'Good job! Everything is fine.'.PHP_EOL;