Added ReflectionDescriptor for properly annotated custom types

Author: lookyman

src/Type/Doctrine/Descriptors/ReflectionDescriptor.php

@@ -0,0 +1,39 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Doctrine\Descriptors;
+
+use PHPStan\Broker\Broker;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Type\Type;
+
+class ReflectionDescriptor implements DoctrineTypeDescriptor
+{
+
+	/** @var string */
+	private $type;
+
+	/** @var \PHPStan\Broker\Broker */
+	private $broker;
+
+	public function __construct(string $type, Broker $broker)
+	{
+		$this->type = $type;
+		$this->broker = $broker;
+	}
+
+	public function getType(): string
+	{
+		return $this->type;
+	}
+
+	public function getWritableToPropertyType(): Type
+	{
+		return ParametersAcceptorSelector::selectSingle($this->broker->getClass((['Doctrine\DBAL\Types\Type', 'getTypesMap'])()[$this->type])->getNativeMethod('convertToPHPValue')->getVariants())->getReturnType();
+	}
+
+	public function getWritableToDatabaseType(): Type
+	{
+		return ParametersAcceptorSelector::selectSingle($this->broker->getClass((['Doctrine\DBAL\Types\Type', 'getTypesMap'])()[$this->type])->getNativeMethod('convertToDatabaseValue')->getVariants())->getParameters()[0]->getType();
+	}
+
+}

tests/Rules/Doctrine/ORM/EntityColumnRuleTest.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Rules\Doctrine\ORM;
 
+use Doctrine\DBAL\Types\Type;
 use Iterator;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
@@ -10,6 +11,7 @@
 use PHPStan\Type\Doctrine\Descriptors\BinaryType;
 use PHPStan\Type\Doctrine\Descriptors\DateTimeImmutableType;
 use PHPStan\Type\Doctrine\Descriptors\DateTimeType;
+use PHPStan\Type\Doctrine\Descriptors\ReflectionDescriptor;
 use PHPStan\Type\Doctrine\Descriptors\StringType;
 use PHPStan\Type\Doctrine\ObjectMetadataResolver;
 
@@ -18,6 +20,10 @@ class EntityColumnRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
+		if (!Type::hasType(CustomType::NAME)) {
+			Type::addType(CustomType::NAME, CustomType::class);
+		}
+
 		return new EntityColumnRule(
 			new ObjectMetadataResolver(__DIR__ . '/entity-manager.php', null),
 			new DescriptorRegistry([
@@ -26,6 +32,7 @@ protected function getRule(): Rule
 				new DateTimeType(),
 				new DateTimeImmutableType(),
 				new BinaryType(),
+				new ReflectionDescriptor(CustomType::NAME, $this->createBroker()),
 			])
 		);
 	}
@@ -94,4 +101,18 @@ public function generatedIdsProvider(): Iterator
 		yield 'nullable both' => [__DIR__ . '/data/GeneratedIdEntity4.php', []];
 	}
 
+	public function testCustomType(): void
+	{
+		$this->analyse([__DIR__ . '/data/EntityWithCustomType.php'], [
+			[
+				'Property PHPStan\Rules\Doctrine\ORM\EntityWithCustomType::$foo type mapping mismatch: database can contain DateTimeInterface but property expects int.',
+				24,
+			],
+			[
+				'Property PHPStan\Rules\Doctrine\ORM\EntityWithCustomType::$foo type mapping mismatch: property can contain int but database expects array.',
+				24,
+			],
+		]);
+	}
+
 }

tests/Rules/Doctrine/ORM/data/CustomType.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Doctrine\ORM;
+
+use DateTimeImmutable;
+use DateTimeInterface;
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class CustomType extends Type
+{
+
+	public const NAME = 'custom';
+
+	public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform): string
+	{
+		return '';
+	}
+
+	public function getName(): string
+	{
+		return self::NAME;
+	}
+
+	public function convertToPHPValue($value, AbstractPlatform $abstractPlatform): DateTimeInterface
+	{
+		return new DateTimeImmutable();
+	}
+
+	/**
+	 * @param array $value
+	 */
+	public function convertToDatabaseValue($value, AbstractPlatform $abstractPlatform): string
+	{
+		return '';
+	}
+
+}

tests/Rules/Doctrine/ORM/data/EntityWithCustomType.php

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