Bleeding edge - report entity mapping exception

Author: ondrejmirtes

rules.neon

@@ -22,6 +22,10 @@ rules:
 	- PHPStan\Rules\Doctrine\ORM\RepositoryMethodCallRule
 	- PHPStan\Rules\Doctrine\ORM\EntityNotFinalRule
 
+conditionalTags:
+	PHPStan\Rules\Doctrine\ORM\EntityMappingExceptionRule:
+		phpstan.rules.rule: %featureToggles.bleedingEdge%
+
 services:
 	-
 		class: PHPStan\Rules\Doctrine\ORM\QueryBuilderDqlRule
@@ -36,6 +40,8 @@ services:
 			allowNullablePropertyForRequiredField: %doctrine.allowNullablePropertyForRequiredField%
 		tags:
 			- phpstan.rules.rule
+	-
+		class: PHPStan\Rules\Doctrine\ORM\EntityMappingExceptionRule
 	-
 		class: PHPStan\Rules\Doctrine\ORM\EntityNotFinalRule
 	-

src/Rules/Doctrine/ORM/EntityMappingExceptionRule.php

@@ -0,0 +1,62 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Doctrine\ORM;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InClassNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Type\Doctrine\ObjectMetadataResolver;
+
+/**
+ * @implements Rule<InClassNode>
+ */
+class EntityMappingExceptionRule implements Rule
+{
+
+	/** @var \PHPStan\Type\Doctrine\ObjectMetadataResolver */
+	private $objectMetadataResolver;
+
+	public function __construct(
+		ObjectMetadataResolver $objectMetadataResolver
+	)
+	{
+		$this->objectMetadataResolver = $objectMetadataResolver;
+	}
+
+	public function getNodeType(): string
+	{
+		return InClassNode::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$class = $scope->getClassReflection();
+		if ($class === null) {
+			return [];
+		}
+
+		$objectManager = $this->objectMetadataResolver->getObjectManager();
+		if ($objectManager === null) {
+			return [];
+		}
+
+		$className = $class->getName();
+		try {
+			if ($objectManager->getMetadataFactory()->isTransient($className)) {
+				return [];
+			}
+		} catch (\ReflectionException $e) {
+			return [];
+		}
+
+		try {
+			$objectManager->getClassMetadata($className);
+		} catch (\Doctrine\ORM\Mapping\MappingException $e) {
+			return [$e->getMessage()];
+		}
+
+		return [];
+	}
+
+}

tests/Rules/Doctrine/ORM/EntityMappingExceptionRuleTest.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Doctrine\ORM;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPStan\Type\Doctrine\ObjectMetadataResolver;
+
+/**
+ * @extends RuleTestCase<EntityMappingExceptionRule>
+ */
+class EntityMappingExceptionRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new EntityMappingExceptionRule(
+			new ObjectMetadataResolver($this->createReflectionProvider(), __DIR__ . '/entity-manager.php', null)
+		);
+	}
+
+	public function testValidEntity(): void
+	{
+		$this->analyse([__DIR__ . '/data-attributes/enum-type.php'], []);
+	}
+
+	public function testInvalidEntity(): void
+	{
+		$this->analyse([__DIR__ . '/data-attributes/enum-type-without-pk.php'], [
+			[
+				'No identifier/primary key specified for Entity "PHPStan\Rules\Doctrine\ORMAttributes\FooWithoutPK". Every Entity must have an identifier/primary key.',
+				7,
+			],
+		]);
+	}
+
+}

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

@@ -0,0 +1,14 @@
+<?php // lint >= 8.1
+
+namespace PHPStan\Rules\Doctrine\ORMAttributes;
+
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+class FooWithoutPK
+{
+
+	#[ORM\Column(type: "string", enumType: FooEnum::class)]
+	public FooEnum $type;
+
+}