Check if embedded class matches property's type

Author: malarzm

Diff for: src/Rules/Doctrine/ORM/EntityEmbeddableRule.php

@@ -0,0 +1,87 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Doctrine\ORM;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MissingPropertyFromReflectionException;
+use PHPStan\Rules\Rule;
+use PHPStan\Type\Doctrine\ObjectMetadataResolver;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\TypeCombinator;
+use PHPStan\Type\VerbosityLevel;
+use function sprintf;
+
+/**
+ * @implements Rule<Node\Stmt\PropertyProperty>
+ */
+class EntityEmbeddableRule implements Rule
+{
+
+	/** @var \PHPStan\Type\Doctrine\ObjectMetadataResolver */
+	private $objectMetadataResolver;
+
+	public function __construct(ObjectMetadataResolver $objectMetadataResolver)
+	{
+		$this->objectMetadataResolver = $objectMetadataResolver;
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Stmt\PropertyProperty::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 {
+			$metadata = $objectManager->getClassMetadata($className);
+		} catch (\Doctrine\ORM\Mapping\MappingException $e) {
+			return [];
+		}
+
+		$classMetadataInfo = 'Doctrine\ORM\Mapping\ClassMetadataInfo';
+		if (!$metadata instanceof $classMetadataInfo) {
+			return [];
+		}
+
+		$propertyName = (string) $node->name;
+		try {
+			$property = $class->getNativeProperty($propertyName);
+		} catch (MissingPropertyFromReflectionException $e) {
+			return [];
+		}
+
+		if (!isset($metadata->embeddedClasses[$propertyName])) {
+			return [];
+		}
+
+		$errors = [];
+		$embeddedClass = $metadata->embeddedClasses[$propertyName];
+		$propertyWritableType = $property->getWritableType();
+		$accordingToMapping = new ObjectType($embeddedClass['class']);
+		if (!TypeCombinator::removeNull($propertyWritableType)->equals($accordingToMapping)) {
+			$errors[] = sprintf(
+				'Property %s::$%s type mapping mismatch: mapping specifies %s but property expects %s.',
+				$class->getName(),
+				$propertyName,
+				$accordingToMapping->describe(VerbosityLevel::typeOnly()),
+				$propertyWritableType->describe(VerbosityLevel::typeOnly())
+			);
+		}
+
+		return $errors;
+	}
+
+}

Diff for: tests/Rules/Doctrine/ORM/EntityEmbeddableRuleTest.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<EntityEmbeddableRule>
+ */
+class EntityEmbeddableRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new EntityEmbeddableRule(
+			new ObjectMetadataResolver(__DIR__ . '/entity-manager.php', null)
+		);
+	}
+
+	public function testEmbedded(): void
+	{
+		$this->analyse([__DIR__ . '/data/EntityWithEmbeddable.php'], []);
+	}
+
+	public function testEmbeddedWithWrongTypeHint(): void
+	{
+		$this->analyse([__DIR__ . '/data/EntityWithBrokenEmbeddable.php'], [
+			[
+				'Property PHPStan\Rules\Doctrine\ORM\EntityWithBrokenEmbeddable::$embedded type mapping mismatch: mapping specifies PHPStan\Rules\Doctrine\ORM\Embeddable but property expects int.',
+				24,
+			],
+		]);
+	}
+
+}

Diff for: tests/Rules/Doctrine/ORM/data/Embeddable.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Doctrine\ORM;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Embeddable()
+ */
+class Embeddable
+{
+	/**
+	 * @ORM\Column(type="string")
+	 * @var string
+	 */
+	private $one;
+}

Diff for: tests/Rules/Doctrine/ORM/data/EntityWithBrokenEmbeddable.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Doctrine\ORM;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity()
+ */
+class EntityWithBrokenEmbeddable
+{
+
+	/**
+	 * @ORM\Id()
+	 * @ORM\Column(type="integer")
+	 * @var int
+	 */
+	private $id;
+
+	/**
+	 * @ORM\Embedded(class=Embeddable::class)
+	 * @var int
+	 */
+	private $embedded;
+}

Diff for: tests/Rules/Doctrine/ORM/data/EntityWithEmbeddable.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Doctrine\ORM;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity()
+ */
+class EntityWithEmbeddable
+{
+
+	/**
+	 * @ORM\Id()
+	 * @ORM\Column(type="integer")
+	 * @var int
+	 */
+	private $id;
+
+	/**
+	 * @ORM\Embedded(class=Embeddable::class)
+	 * @var Embeddable
+	 */
+	private $embedded;
+
+	/**
+	 * @ORM\Embedded(class=Embeddable::class)
+	 * @var ?Embeddable
+	 */
+	private $nullable;
+}