skip trimming of union object types in ClassMethodArrayDocblockParamFromLocalCallsRector

Author: TomasVotruba

rules-tests/TypeDeclarationDocblocks/Rector/Class_/ClassMethodArrayDocblockParamFromLocalCallsRector/Fixture/union_objects.php.inc

@@ -0,0 +1,60 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Source\AnotherReturnedObject;
+use Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Source\SomeReturnedObject;
+
+final class UnionObjects
+{
+    public function go()
+    {
+        $this->run($this->getUnion());
+    }
+
+    private function run(array $items)
+    {
+    }
+
+    /**
+     * @return SomeReturnedObject[]|AnotherReturnedObject[]
+     */
+    private function getUnion(): array
+    {
+        return [];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;
+
+use Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Source\AnotherReturnedObject;
+use Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Source\SomeReturnedObject;
+
+final class UnionObjects
+{
+    public function go()
+    {
+        $this->run($this->getUnion());
+    }
+
+    /**
+     * @param \Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Source\AnotherReturnedObject[]|\Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Source\SomeReturnedObject[] $items
+     */
+    private function run(array $items)
+    {
+    }
+
+    /**
+     * @return SomeReturnedObject[]|AnotherReturnedObject[]
+     */
+    private function getUnion(): array
+    {
+        return [];
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/Class_/ClassMethodArrayDocblockParamFromLocalCallsRector/Source/AnotherReturnedObject.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Source;
+
+final class AnotherReturnedObject
+{
+
+}

rules/Privatization/TypeManipulator/TypeNormalizer.php

@@ -101,13 +101,14 @@ public function generalizeConstantTypes(Type $type): Type
 
                 if (count($uniqueGeneralizedUnionTypes) > 1) {
                     $generalizedUnionType = new UnionType($uniqueGeneralizedUnionTypes);
+
                     // avoid too huge print in docblock
                     $unionedDocType = $this->staticTypeMapper->mapPHPStanTypeToPHPStanPhpDocTypeNode(
                         $generalizedUnionType
                     );
 
                     // too long
-                    if (strlen((string) $unionedDocType) > self::MAX_PRINTED_UNION_DOC_LENGHT) {
+                    if (strlen((string) $unionedDocType) > self::MAX_PRINTED_UNION_DOC_LENGHT && $this->avoidPrintedDocblockTrimming($generalizedUnionType) === false) {
                         $alwaysKnownArrayType = $this->narrowToAlwaysKnownArrayType($generalizedUnionType);
                         if ($alwaysKnownArrayType instanceof ArrayType) {
                             return $alwaysKnownArrayType;
@@ -164,4 +165,20 @@ private function narrowToAlwaysKnownArrayType(UnionType $unionType): ?ArrayType
         );
         return new ArrayType($arrayUniqueKeyType, new MixedType());
     }
+
+    /**
+     * Is object only? avoid trimming, as auto import handles it better
+     */
+    private function avoidPrintedDocblockTrimming(UnionType $unionType): bool
+    {
+        if ($unionType->getConstantScalarTypes() !== []) {
+            return false;
+        }
+
+        if ($unionType->getConstantArrays() !== []) {
+            return false;
+        }
+
+        return $unionType->getReferencedClasses() !== [];
+    }
 }

rules/TypeDeclarationDocblocks/Rector/Class_/ClassMethodArrayDocblockParamFromLocalCallsRector.php

@@ -7,6 +7,7 @@
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
 use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
+use PHPStan\Type\ArrayType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
@@ -93,11 +94,7 @@ public function refactor(Node $node): ?Node
             $classMethodParameterTypes = $this->callTypesResolver->resolveTypesFromCalls($methodCalls);
 
             foreach ($classMethod->getParams() as $parameterPosition => $param) {
-                if ($param->type === null) {
-                    continue;
-                }
-
-                if (! $this->isName($param->type, 'array')) {
+                if (! $this->hasParamArrayType($param)) {
                     continue;
                 }
 
@@ -114,7 +111,7 @@ public function refactor(Node $node): ?Node
                     continue;
                 }
 
-                if ($resolvedParameterType instanceof MixedType) {
+                if ($resolvedParameterType instanceof MixedType || ($resolvedParameterType instanceof ArrayType && $resolvedParameterType->getItemType() instanceof MixedType && $resolvedParameterType->getKeyType() instanceof MixedType)) {
                     continue;
                 }
 
@@ -140,4 +137,17 @@ public function refactor(Node $node): ?Node
 
         return $node;
     }
+
+    private function hasParamArrayType(mixed $param): bool
+    {
+        if ($param->type === null) {
+            return false;
+        }
+
+        if (!$this->isName($param->type, 'array')) {
+            return false;
+        }
+
+        return true;
+    }
 }