EntityColumnRule - do not complain about array type columns even with narrower property type

Author: ondrejmirtes

src/Rules/Doctrine/ORM/EntityColumnRule.php

@@ -6,13 +6,16 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\MissingPropertyFromReflectionException;
 use PHPStan\Rules\Rule;
+use PHPStan\Type\ArrayType;
 use PHPStan\Type\Doctrine\DescriptorNotRegisteredException;
 use PHPStan\Type\Doctrine\DescriptorRegistry;
 use PHPStan\Type\Doctrine\ObjectMetadataResolver;
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\NeverType;
+use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
+use PHPStan\Type\TypeTraverser;
 use PHPStan\Type\VerbosityLevel;
 use Throwable;
 use function sprintf;
@@ -125,6 +128,16 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
+		$transformArrays = function (Type $type, callable $traverse): Type {
+			if ($type instanceof ArrayType) {
+				return new ArrayType(new MixedType(), new MixedType());
+			}
+
+			return $traverse($type);
+		};
+
+		$propertyWritableType = TypeTraverser::map($propertyWritableType, $transformArrays);
+
 		if (!$propertyWritableType->isSuperTypeOf($writableToPropertyType)->yes()) {
 			$errors[] = sprintf(
 				'Property %s::$%s type mapping mismatch: database can contain %s but property expects %s.',
@@ -134,7 +147,7 @@ public function processNode(Node $node, Scope $scope): array
 				$property->getWritableType()->describe(VerbosityLevel::typeOnly())
 			);
 		}
-		$propertyReadableType = $property->getReadableType();
+		$propertyReadableType = TypeTraverser::map($property->getReadableType(), $transformArrays);
 		if (!$writableToDatabaseType->isSuperTypeOf($identifier === $propertyName && !$nullable ? TypeCombinator::removeNull($propertyReadableType) : $propertyReadableType)->yes()) {
 			$errors[] = sprintf(
 				'Property %s::$%s type mapping mismatch: property can contain %s but database expects %s.',

tests/Rules/Doctrine/ORM/EntityColumnRuleTest.php

@@ -7,6 +7,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 use PHPStan\Type\Doctrine\DescriptorRegistry;
+use PHPStan\Type\Doctrine\Descriptors\ArrayType;
 use PHPStan\Type\Doctrine\Descriptors\BigIntType;
 use PHPStan\Type\Doctrine\Descriptors\BinaryType;
 use PHPStan\Type\Doctrine\Descriptors\DateTimeImmutableType;
@@ -46,6 +47,7 @@ protected function getRule(): Rule
 				new ReflectionDescriptor(CustomType::class, $this->createBroker()),
 				new DateType(),
 				new UuidTypeDescriptor(UuidType::class),
+				new ArrayType(),
 			]),
 			true
 		);
@@ -86,6 +88,14 @@ public function testRule(): void
 				'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$uuidInvalidType type mapping mismatch: property can contain int but database expects Ramsey\Uuid\UuidInterface|string.',
 				72,
 			],
+			[
+				'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$arrayOrNull type mapping mismatch: property can contain array|null but database expects array.',
+				96,
+			],
+			[
+				'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$arrayOfIntegersOrNull type mapping mismatch: property can contain array|null but database expects array.',
+				102,
+			],
 		]);
 	}
 

tests/Rules/Doctrine/ORM/data/MyBrokenEntity.php

@@ -71,4 +71,34 @@ class MyBrokenEntity extends MyBrokenSuperclass
 	 */
 	private $uuidInvalidType;
 
+	/**
+	 * @ORM\Column(type="array")
+	 * @var int[]
+	 */
+	private $arrayOfIntegers;
+
+	/**
+	 * @ORM\Column(type="array")
+	 * @var mixed[][]
+	 */
+	private $arrayOfArrays;
+
+	/**
+	 * @ORM\Column(type="array")
+	 * @var mixed[]
+	 */
+	private $mixeds;
+
+	/**
+	 * @ORM\Column(type="array")
+	 * @var array|null
+	 */
+	private $arrayOrNull;
+
+	/**
+	 * @ORM\Column(type="array")
+	 * @var int[]|null
+	 */
+	private $arrayOfIntegersOrNull;
+
 }