Support for enumType in Column mapping

Author: ondrejmirtes

composer.json

@@ -23,7 +23,7 @@
 		"doctrine/dbal": "^2.13.7",
 		"doctrine/lexer": "^1.2.1",
 		"doctrine/mongodb-odm": "^1.3 || ^2.1",
-		"doctrine/orm": "^2.9.1",
+		"doctrine/orm": "^2.11.0",
 		"doctrine/persistence": "^1.1 || ^2.0",
 		"nesbot/carbon": "^2.49",
 		"nikic/php-parser": "^4.13.2",

phpcs.xml

@@ -65,4 +65,5 @@
 	</rule>
 	<exclude-pattern>tests/tmp</exclude-pattern>
 	<exclude-pattern>tests/*/data</exclude-pattern>
+	<exclude-pattern>tests/*/data-attributes</exclude-pattern>
 </ruleset>

phpstan.neon

@@ -9,7 +9,9 @@ includes:
 parameters:
 	excludePaths:
 		- tests/*/data/*
+		- tests/*/data-attributes/*
 		- tests/*/data-php-*/*
+		- tests/Rules/Doctrine/ORM/entity-manager.php
 
 	ignoreErrors:
 		-

src/Rules/Doctrine/ORM/EntityColumnRule.php

@@ -13,6 +13,7 @@
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\NeverType;
+use PHPStan\Type\ObjectType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\TypeTraverser;
@@ -101,7 +102,7 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		/** @var array{type: string, fieldName: string, columnName?: string, inherited?: class-string, nullable?: bool} $fieldMapping */
+		/** @var array{type: string, fieldName: string, columnName?: string, inherited?: class-string, nullable?: bool, enumType?: ?string} $fieldMapping */
 		$fieldMapping = $metadata->fieldMappings[$propertyName];
 
 		$errors = [];
@@ -116,6 +117,16 @@ public function processNode(Node $node, Scope $scope): array
 			)] : [];
 		}
 
+		$writableToPropertyType = $descriptor->getWritableToPropertyType();
+		$writableToDatabaseType = $descriptor->getWritableToDatabaseType();
+
+		$enumTypeString = $fieldMapping['enumType'] ?? null;
+		if ($enumTypeString !== null) {
+			$enumType = new ObjectType($enumTypeString);
+			$writableToPropertyType = $enumType;
+			$writableToDatabaseType = $enumType;
+		}
+
 		$identifiers = [];
 		if ($metadata->generatorType !== 5) { // ClassMetadataInfo::GENERATOR_TYPE_NONE
 			try {
@@ -128,8 +139,6 @@ public function processNode(Node $node, Scope $scope): array
 			}
 		}
 
-		$writableToPropertyType = $descriptor->getWritableToPropertyType();
-		$writableToDatabaseType = $descriptor->getWritableToDatabaseType();
 		$nullable = isset($fieldMapping['nullable']) ? $fieldMapping['nullable'] === true : false;
 		if ($nullable) {
 			$writableToPropertyType = TypeCombinator::addNull($writableToPropertyType);

tests/Rules/Doctrine/ORM/EntityColumnRuleTest.php

@@ -23,6 +23,7 @@
 use PHPStan\Type\Doctrine\Descriptors\StringType;
 use PHPStan\Type\Doctrine\ObjectMetadataResolver;
 use Ramsey\Uuid\Doctrine\UuidType;
+use const PHP_VERSION_ID;
 
 /**
  * @extends RuleTestCase<EntityColumnRule>
@@ -274,4 +275,23 @@ public function testUnknownType(): void
 		]);
 	}
 
+	public function testEnumType(): void
+	{
+		if (PHP_VERSION_ID < 80100) {
+			self::markTestSkipped('Test requires PHP 8.1.');
+		}
+
+		$this->allowNullablePropertyForRequiredField = false;
+		$this->analyse([__DIR__ . '/data-attributes/enum-type.php'], [
+			[
+				'Property PHPStan\Rules\Doctrine\ORMAttributes\Foo::$type2 type mapping mismatch: database can contain PHPStan\Rules\Doctrine\ORMAttributes\FooEnum but property expects PHPStan\Rules\Doctrine\ORMAttributes\BarEnum.',
+				35,
+			],
+			[
+				'Property PHPStan\Rules\Doctrine\ORMAttributes\Foo::$type2 type mapping mismatch: property can contain PHPStan\Rules\Doctrine\ORMAttributes\BarEnum but database expects PHPStan\Rules\Doctrine\ORMAttributes\FooEnum.',
+				35,
+			],
+		]);
+	}
+
 }

tests/Rules/Doctrine/ORM/data-attributes/enum-type.php

@@ -0,0 +1,37 @@
+<?php // lint >= 8.1
+
+namespace PHPStan\Rules\Doctrine\ORMAttributes;
+
+use Doctrine\ORM\Mapping as ORM;
+
+enum FooEnum: string {
+
+	case ONE = 'one';
+	case TWO = 'two';
+
+}
+
+enum BarEnum: string {
+
+	case ONE = 'one';
+	case TWO = 'two';
+
+}
+
+#[ORM\Entity]
+class Foo
+{
+
+
+	#[ORM\Column(nullable: false)]
+	#[ORM\Id]
+	#[ORM\GeneratedValue]
+	private ?int $id = null;
+
+	#[ORM\Column(type: "string", enumType: FooEnum::class)]
+	public FooEnum $type1;
+
+	#[ORM\Column(type: "string", enumType: FooEnum::class)]
+	public BarEnum $type2;
+
+}

tests/Rules/Doctrine/ORM/entity-manager.php

@@ -4,6 +4,8 @@
 use Doctrine\ORM\Configuration;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
+use Doctrine\ORM\Mapping\Driver\AttributeDriver;
+use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Cache\DoctrineProvider;
 
@@ -12,12 +14,20 @@
 $config->setProxyNamespace('PHPstan\Doctrine\OrmProxies');
 $config->setMetadataCacheImpl(new DoctrineProvider(new ArrayAdapter()));
 
-$config->setMetadataDriverImpl(
-	new AnnotationDriver(
-		new AnnotationReader(),
-		[__DIR__ . '/data']
-	)
-);
+$metadataDriver = new MappingDriverChain();
+$metadataDriver->addDriver(new AnnotationDriver(
+	new AnnotationReader(),
+	[__DIR__ . '/data']
+), 'PHPStan\\Rules\\Doctrine\\ORM\\');
+
+if (PHP_VERSION_ID >= 80100) {
+	$metadataDriver->addDriver(
+		new AttributeDriver([__DIR__ . '/data-attributes']),
+		'PHPStan\\Rules\\Doctrine\\ORMAttributes\\'
+	);
+}
+
+$config->setMetadataDriverImpl($metadataDriver);
 
 \Doctrine\DBAL\Types\Type::overrideType(
 	'date',