Merge branch 'hotfix/25'

Close #25
webimpress · May 18, 2019 · 194193c · 194193c
2 parents 5c8d28d + 67b76cd
commit 194193c
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -52,6 +52,8 @@ All notable changes to this project will be documented in this file, in reverse
     - `PHP\CorrectClassNameCase`
     - `PHP\DisallowFqn`
 
+- [#25](https://github.com/webimpress/coding-standard/pull/25) fixes type suggestions, allows `self` and `parent` to be used as specification for complex types (like `object` or class/interface)
+
 ## 1.0.2 - 2019-05-12
 
 ### Added

diff --git a/src/WebimpressCodingStandard/Helper/MethodsTrait.php b/src/WebimpressCodingStandard/Helper/MethodsTrait.php
@@ -81,25 +81,6 @@ trait MethodsTrait
      */
     private $implementedInterfaceNames = [];
 
-    /**
-     * Allowed simple type hints for method params.
-     *
-     * @var string[]
-     */
-    private $simpleTypeHints = [
-        'array',
-        'bool',
-        'callable',
-        'float',
-        'iterable',
-        'int',
-        'object',
-        'parent',
-        'resource',
-        'self',
-        'string',
-    ];
-
     /**
      * @var string[]
      */
@@ -118,12 +99,8 @@ trait MethodsTrait
         '?int',
         'object',
         '?object',
-        'parent',
-        '?parent',
         'resource',
         '?resource',
-        'self',
-        '?self',
         'string',
         '?string',
         'void',
@@ -218,7 +195,10 @@ private function getSuggestedType(string $class) : string
         $suffix = strstr($class, '[');
         $clear = strtolower(strtr($class, ['?' => '', '[' => '', ']' => '']));
 
-        if (in_array($clear, $this->simpleReturnTypes + ['static' => 'static'], true)) {
+        $typeMap = $this->simpleReturnTypes
+            + ['parent' => 'parent', 'self' => 'self', 'static' => 'static'];
+
+        if (in_array($clear, $typeMap, true)) {
             return $prefix . $clear . $suffix;
         }
 

diff --git a/test/Sniffs/Functions/ParamUnitTest.1.inc b/test/Sniffs/Functions/ParamUnitTest.1.inc
@@ -174,4 +174,26 @@ class FunctionParam
         ?\Generator $d,
         ?object $e
     ) {}
+
+    /**
+     * @param self $self
+     * @param static $static
+     * @param parent $parent
+     */
+    abstract public function canBeUsedAsClassTypeSpecification(
+        MyClass $self,
+        MyClass $static,
+        MyClass $parent
+    ) : void;
+
+    /**
+     * @param self $self
+     * @param static $static
+     * @param parent $parent
+     */
+    abstract public function canBeUsedAsObjectTypeSpecification(
+        object $self,
+        object $static,
+        object $parent
+    ) : void;
 }
diff --git a/test/Sniffs/Functions/ReturnTypeUnitTest.inc b/test/Sniffs/Functions/ReturnTypeUnitTest.inc
@@ -328,4 +328,34 @@ abstract class FunctionCommentReturn
     {
         return $a[0] * $b <=> $c ? ['a'] : 0.1;
     }
+
+    /**
+     * @return self
+     */
+    abstract public function selfCanBeUsedAsClassTypeSpecification() : MyClass;
+
+    /**
+     * @return static
+     */
+    abstract public function staticCanBeUsedAsClassTypeSpecification() : MyClass;
+
+    /**
+     * @return parent
+     */
+    abstract public function parentCanBeUsedAsClassTypeSpecification() : MyClass;
+
+    /**
+     * @return self
+     */
+    abstract public function selfCanBeUsedAsObjectTypeSpecification() : object;
+
+    /**
+     * @return static
+     */
+    abstract public function staticCanBeUsedAsObjectTypeSpecification() : object;
+
+    /**
+     * @return parent
+     */
+    abstract public function parentCanBeUsedAsObjectTypeSpecification() : object;
 }