Check if embedded class matches property's type

Author: malarzm

src/Rules/Doctrine/ORM/EntityColumnRule.php

@@ -2,9 +2,12 @@
 
 namespace PHPStan\Rules\Doctrine\ORM;
 
+use Doctrine\ORM\Mapping\ClassMetadata;
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\MissingPropertyFromReflectionException;
+use PHPStan\Reflection\Php\PhpPropertyReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Type\ArrayType;
 use PHPStan\Type\Doctrine\DescriptorNotRegisteredException;
@@ -13,6 +16,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;
@@ -86,6 +90,10 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
+		if (isset($metadata->embeddedClasses[$propertyName])) {
+			return $this->checkEmbeddedObject($class, $property, $metadata, $propertyName);
+		}
+
 		if (!isset($metadata->fieldMappings[$propertyName])) {
 			return [];
 		}
@@ -160,4 +168,23 @@ public function processNode(Node $node, Scope $scope): array
 		return $errors;
 	}
 
+	private function checkEmbeddedObject(ClassReflection $class, PhpPropertyReflection $property, ClassMetadata $metadata, string $propertyName): array
+	{
+		$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;
+	}
+
 }

tests/Rules/Doctrine/ORM/EntityColumnRuleTest.php

@@ -153,6 +153,21 @@ public function testCustomType(): void
 		]);
 	}
 
+	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,
+			],
+		]);
+	}
+
 	public function testUnknownType(): void
 	{
 		$this->analyse([__DIR__ . '/data/EntityWithUnknownType.php'], [

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;
+}

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;
+}

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;
+}