EntityColumnRule, EntityRelationRule - check promoted properties

Author: ondrejmirtes

src/Rules/Doctrine/ORM/EntityColumnRule.php

@@ -4,6 +4,7 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\Node\ClassPropertyNode;
 use PHPStan\Reflection\MissingPropertyFromReflectionException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
@@ -25,7 +26,7 @@
 use function sprintf;
 
 /**
- * @implements Rule<Node\Stmt\PropertyProperty>
+ * @implements Rule<ClassPropertyNode>
  */
 class EntityColumnRule implements Rule
 {
@@ -67,7 +68,7 @@ public function __construct(
 
 	public function getNodeType(): string
 	{
-		return Node\Stmt\PropertyProperty::class;
+		return ClassPropertyNode::class;
 	}
 
 	public function processNode(Node $node, Scope $scope): array
@@ -86,7 +87,7 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		$propertyName = (string) $node->name;
+		$propertyName = $node->getName();
 		try {
 			$property = $class->getNativeProperty($propertyName);
 		} catch (MissingPropertyFromReflectionException $e) {

src/Rules/Doctrine/ORM/EntityRelationRule.php

@@ -4,6 +4,7 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\Node\ClassPropertyNode;
 use PHPStan\Reflection\MissingPropertyFromReflectionException;
 use PHPStan\Rules\Rule;
 use PHPStan\Type\Doctrine\ObjectMetadataResolver;
@@ -20,7 +21,7 @@
 use function sprintf;
 
 /**
- * @implements Rule<Node\Stmt\PropertyProperty>
+ * @implements Rule<ClassPropertyNode>
  */
 class EntityRelationRule implements Rule
 {
@@ -47,7 +48,7 @@ public function __construct(
 
 	public function getNodeType(): string
 	{
-		return Node\Stmt\PropertyProperty::class;
+		return ClassPropertyNode::class;
 	}
 
 	public function processNode(Node $node, Scope $scope): array
@@ -67,7 +68,7 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		$propertyName = (string) $node->name;
+		$propertyName = $node->getName();
 		try {
 			$property = $class->getNativeProperty($propertyName);
 		} catch (MissingPropertyFromReflectionException $e) {

tests/Rules/Doctrine/ORM/EntityColumnRuleTest.php

@@ -374,4 +374,22 @@ public function testPhpStanBug6445(?string $objectManagerLoader): void
 		$this->analyse([__DIR__ . '/data/phpstan-bug-6445.php'], []);
 	}
 
+	/**
+	 * @dataProvider dataObjectManagerLoader
+	 */
+	public function testBug306(?string $objectManagerLoader): void
+	{
+		if (PHP_VERSION_ID < 80000) {
+			self::markTestSkipped('Test requires PHP 8.0');
+		}
+		$this->allowNullablePropertyForRequiredField = false;
+		$this->objectManagerLoader = $objectManagerLoader;
+		$this->analyse([__DIR__ . '/data/bug-306.php'], [
+			[
+				'Property PHPStan\Rules\Doctrine\ORM\Bug306\MyBrokenEntity::$one type mapping mismatch: database can contain string|null but property expects string.',
+				25,
+			],
+		]);
+	}
+
 }

tests/Rules/Doctrine/ORM/EntityRelationRuleTest.php

@@ -6,6 +6,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 use PHPStan\Type\Doctrine\ObjectMetadataResolver;
+use const PHP_VERSION_ID;
 
 /**
  * @extends RuleTestCase<EntityRelationRule>
@@ -307,4 +308,19 @@ public function ruleWithAllowedNullablePropertyProvider(): Iterator
 		];
 	}
 
+	public function testBug306(): void
+	{
+		if (PHP_VERSION_ID < 80000) {
+			self::markTestSkipped('Test requires PHP 8.0');
+		}
+		$this->allowNullablePropertyForRequiredField = false;
+		$this->objectManagerLoader = __DIR__ . '/entity-manager.php';
+		$this->analyse([__DIR__ . '/data/bug-306-relation.php'], [
+			[
+				'Property PHPStan\Rules\Doctrine\ORM\Bug306Relation\MyBrokenEntity::$genericCollection type mapping mismatch: property can contain Doctrine\Common\Collections\Collection but database expects Doctrine\Common\Collections\Collection&iterable<PHPStan\Rules\Doctrine\ORM\AnotherEntity>.',
+				25,
+			],
+		]);
+	}
+
 }

tests/Rules/Doctrine/ORM/data/bug-306-relation.php

@@ -0,0 +1,29 @@
+<?php // lint >= 8.0
+
+namespace PHPStan\Rules\Doctrine\ORM\Bug306Relation;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity()
+ */
+class MyBrokenEntity
+{
+
+	/**
+	 * @ORM\Id()
+	 * @ORM\GeneratedValue()
+	 * @ORM\Column(type="int")
+	 * @var int|null
+	 */
+	private $id;
+
+	public function __construct(
+		/**
+		 * @ORM\OneToMany(targetEntity="PHPStan\Rules\Doctrine\ORM\AnotherEntity", mappedBy="manyToOne")
+		 */
+		private \Doctrine\Common\Collections\Collection $genericCollection
+	)
+	{
+	}
+}

tests/Rules/Doctrine/ORM/data/bug-306.php

@@ -0,0 +1,34 @@
+<?php // lint >= 8.0
+
+namespace PHPStan\Rules\Doctrine\ORM\Bug306;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity()
+ */
+class MyBrokenEntity
+{
+
+	/**
+	 * @ORM\Id()
+	 * @ORM\GeneratedValue()
+	 * @ORM\Column(type="integer")
+	 * @var int|null
+	 */
+	private $id;
+
+	public function __construct(
+		/**
+		 * @ORM\Column(type="string", nullable=true)
+		 */
+		private string $one,
+
+		/**
+		 * @ORM\Column(type="string", nullable=true)
+		 */
+		private ?string $two
+	)
+	{
+	}
+}