add object support to DocblockReturnArrayFromDirectArrayInstanceRector (#7795)

Author: TomasVotruba

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockReturnArrayFromDirectArrayInstanceRector/Fixture/covert-object-return.php.inc

@@ -0,0 +1,40 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockReturnArrayFromDirectArrayInstanceRector\Fixture;
+
+final class CoverObjectReturn
+{
+    private ?\Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockReturnArrayFromDirectArrayInstanceRector\Sourde\SomeObjectInDirectArray $item = null;
+
+    public function toArray(): array
+    {
+        return [
+            'key1' => 100,
+            'key2' => $this->item
+        ];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockReturnArrayFromDirectArrayInstanceRector\Fixture;
+
+final class CoverObjectReturn
+{
+    private ?\Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockReturnArrayFromDirectArrayInstanceRector\Sourde\SomeObjectInDirectArray $item = null;
+
+    /**
+     * @return array<string, \Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockReturnArrayFromDirectArrayInstanceRector\Sourde\SomeObjectInDirectArray|int|null>
+     */
+    public function toArray(): array
+    {
+        return [
+            'key1' => 100,
+            'key2' => $this->item
+        ];
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockReturnArrayFromDirectArrayInstanceRector/Sourde/SomeObjectInDirectArray.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockReturnArrayFromDirectArrayInstanceRector\Sourde;
+
+final class SomeObjectInDirectArray
+{
+}

rules/Privatization/TypeManipulator/TypeNormalizer.php

@@ -4,6 +4,7 @@
 
 namespace Rector\Privatization\TypeManipulator;
 
+use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\Type\Accessory\AccessoryLiteralStringType;
 use PHPStan\Type\Accessory\AccessoryNonEmptyStringType;
 use PHPStan\Type\Accessory\AccessoryNonFalsyStringType;
@@ -18,13 +19,15 @@
 use PHPStan\Type\IntegerType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\NeverType;
+use PHPStan\Type\ObjectType;
 use PHPStan\Type\StringType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeTraverser;
 use PHPStan\Type\UnionType;
 use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
 use Rector\NodeTypeResolver\PHPStan\TypeHasher;
 use Rector\StaticTypeMapper\StaticTypeMapper;
+use Rector\StaticTypeMapper\ValueObject\Type\ShortenedObjectType;
 
 final readonly class TypeNormalizer
 {
@@ -138,14 +141,10 @@ 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
-                    );
+                    $shortUnionedDocType = $this->resolveNameShortDocTypeNode($generalizedUnionType);
 
-                    // too long
                     if (strlen(
-                        (string) $unionedDocType
+                        (string) $shortUnionedDocType
                     ) > self::MAX_PRINTED_UNION_DOC_LENGTH && $this->avoidPrintedDocblockTrimming(
                         $generalizedUnionType
                     ) === false) {
@@ -221,4 +220,24 @@ private function avoidPrintedDocblockTrimming(UnionType $unionType): bool
 
         return $unionType->getObjectClassNames() !== [];
     }
+
+    private function resolveNameShortDocTypeNode(UnionType $unionType): TypeNode
+    {
+        // we have to converet name to short here, to make sure the not FQN, but short name is counted to the full length
+        $objectShortGeneralizedUnionType = TypeTraverser::map($unionType, function (
+            Type $type,
+            callable $traverseCallback
+        ): Type {
+            if ($type instanceof ObjectType && str_contains($type->getClassName(), '\\')) {
+                // after last "\\"
+                $shortClassName = substr($type->getClassName(), strrpos($type->getClassName(), '\\') + 1);
+
+                return new ShortenedObjectType($shortClassName, $type->getClassName());
+            }
+
+            return $traverseCallback($type, $traverseCallback);
+        });
+
+        return $this->staticTypeMapper->mapPHPStanTypeToPHPStanPhpDocTypeNode($objectShortGeneralizedUnionType);
+    }
 }

rules/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockReturnArrayFromDirectArrayInstanceRector.php

@@ -113,8 +113,10 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        if ($returnedType->getReferencedClasses() !== []) {
-            // better handled by shared-interface/class rule, to avoid turning objects to mixed
+        // better handled by shared-interface/class rule, to avoid turning objects to mixed
+        if ($returnedType->getReferencedClasses() !== [] && count($returnedType->getReferencedClasses()) === count(
+            $returnedType->getValueTypes()
+        )) {
             return null;
         }