Refactored descriptors so they work with Doctrine\DBAL\Types\Type::overrideType()

ondrejmirtes · ondrejmirtes · commit 59c6543e8736 · 2019-11-26T13:14:13.000+01:00
diff --git a/README.md b/README.md
@@ -88,7 +88,7 @@ public function getWritableToPropertyType(): Type;
 public function getWritableToDatabaseType(): Type;
 ```
 
-* The `getType()` method simply returns the name of the custom type.
+* The `getType()` method simply returns the class name of the custom type.
 * The `getWritableToPropertyType()` method returns the PHPStan type that the custom type will write into the entity's property field. Basically it is the return type of the custom type's `convertToPHPValue()` method.
 * The `getWritableToDatabaseType()` method returns the PHPStan type that can be written from the entity's property field into the custom type. Again, basically it's the allowed type for the custom type's `convertToDatabaseValue()`'s first argument.
 
@@ -114,6 +114,6 @@ services:
 
 	# in case you are using the ReflectionDescriptor
 	-
-		class: PHPStan\Type\Doctrine\Descriptors\ReflectionDescriptor('my_custom_type_name')
+		class: PHPStan\Type\Doctrine\Descriptors\ReflectionDescriptor('MyApp\MyCustomTypeName')
 		tags: [phpstan.doctrine.typeDescriptor]
 ```
diff --git a/src/Type/Doctrine/DescriptorRegistry.php b/src/Type/Doctrine/DescriptorRegistry.php
@@ -2,12 +2,13 @@
 
 namespace PHPStan\Type\Doctrine;
 
+use Doctrine\DBAL\Types\Type;
 use PHPStan\Type\Doctrine\Descriptors\DoctrineTypeDescriptor;
 
 class DescriptorRegistry
 {
 
-	/** @var array<string, \PHPStan\Type\Doctrine\Descriptors\DoctrineTypeDescriptor> */
+	/** @var array<class-string<\Doctrine\DBAL\Types\Type>, \PHPStan\Type\Doctrine\Descriptors\DoctrineTypeDescriptor> */
 	private $descriptors = [];
 
 	/**
@@ -22,10 +23,17 @@ public function __construct(array $descriptors)
 
 	public function get(string $type): DoctrineTypeDescriptor
 	{
-		if (!isset($this->descriptors[$type])) {
+		$typesMap = Type::getTypesMap();
+		if (!isset($typesMap[$type])) {
 			throw new \PHPStan\Type\Doctrine\DescriptorNotRegisteredException();
 		}
-		return $this->descriptors[$type];
+
+		/** @var class-string<\Doctrine\DBAL\Types\Type> $typeClass */
+		$typeClass = $typesMap[$type];
+		if (!isset($this->descriptors[$typeClass])) {
+			throw new \PHPStan\Type\Doctrine\DescriptorNotRegisteredException();
+		}
+		return $this->descriptors[$typeClass];
 	}
 
 }
diff --git a/src/Type/Doctrine/Descriptors/ArrayType.php b/src/Type/Doctrine/Descriptors/ArrayType.php
@@ -10,7 +10,7 @@ class ArrayType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'array';
+		return \Doctrine\DBAL\Types\ArrayType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/BigIntType.php b/src/Type/Doctrine/Descriptors/BigIntType.php
@@ -10,7 +10,7 @@ class BigIntType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'bigint';
+		return \Doctrine\DBAL\Types\BigIntType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/BinaryType.php b/src/Type/Doctrine/Descriptors/BinaryType.php
@@ -11,7 +11,7 @@ class BinaryType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'binary';
+		return \Doctrine\DBAL\Types\BinaryType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/BlobType.php b/src/Type/Doctrine/Descriptors/BlobType.php
@@ -11,7 +11,7 @@ class BlobType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'blob';
+		return \Doctrine\DBAL\Types\BlobType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/BooleanType.php b/src/Type/Doctrine/Descriptors/BooleanType.php
@@ -9,7 +9,7 @@ class BooleanType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'boolean';
+		return \Doctrine\DBAL\Types\BooleanType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/DateImmutableType.php b/src/Type/Doctrine/Descriptors/DateImmutableType.php
@@ -11,7 +11,7 @@ class DateImmutableType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'date_immutable';
+		return \Doctrine\DBAL\Types\DateTimeImmutableType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/DateIntervalType.php b/src/Type/Doctrine/Descriptors/DateIntervalType.php
@@ -11,7 +11,7 @@ class DateIntervalType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'dateinterval';
+		return \Doctrine\DBAL\Types\DateIntervalType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/DateTimeImmutableType.php b/src/Type/Doctrine/Descriptors/DateTimeImmutableType.php
@@ -11,7 +11,7 @@ class DateTimeImmutableType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'datetime_immutable';
+		return \Doctrine\DBAL\Types\DateTimeImmutableType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/DateTimeType.php b/src/Type/Doctrine/Descriptors/DateTimeType.php
@@ -11,7 +11,7 @@ class DateTimeType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'datetime';
+		return \Doctrine\DBAL\Types\DateTimeType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/DateTimeTzImmutableType.php b/src/Type/Doctrine/Descriptors/DateTimeTzImmutableType.php
@@ -11,7 +11,7 @@ class DateTimeTzImmutableType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'datetimetz_immutable';
+		return \Doctrine\DBAL\Types\DateTimeTzType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/DateTimeTzType.php b/src/Type/Doctrine/Descriptors/DateTimeTzType.php
@@ -11,7 +11,7 @@ class DateTimeTzType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'datetimetz';
+		return \Doctrine\DBAL\Types\DateTimeTzType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/DateType.php b/src/Type/Doctrine/Descriptors/DateType.php
@@ -11,7 +11,7 @@ class DateType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'date';
+		return \Doctrine\DBAL\Types\DateType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/DecimalType.php b/src/Type/Doctrine/Descriptors/DecimalType.php
@@ -10,7 +10,7 @@ class DecimalType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'decimal';
+		return \Doctrine\DBAL\Types\DecimalType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/DoctrineTypeDescriptor.php b/src/Type/Doctrine/Descriptors/DoctrineTypeDescriptor.php
@@ -7,6 +7,9 @@
 interface DoctrineTypeDescriptor
 {
 
+	/**
+	 * @return class-string<\Doctrine\DBAL\Types\Type>
+	 */
 	public function getType(): string;
 
 	public function getWritableToPropertyType(): Type;
diff --git a/src/Type/Doctrine/Descriptors/FloatType.php b/src/Type/Doctrine/Descriptors/FloatType.php
@@ -10,7 +10,7 @@ class FloatType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'float';
+		return \Doctrine\DBAL\Types\FloatType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/GuidType.php b/src/Type/Doctrine/Descriptors/GuidType.php
@@ -10,7 +10,7 @@ class GuidType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'guid';
+		return \Doctrine\DBAL\Types\GuidType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/IntegerType.php b/src/Type/Doctrine/Descriptors/IntegerType.php
@@ -9,7 +9,7 @@ class IntegerType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'integer';
+		return \Doctrine\DBAL\Types\IntegerType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/JsonArrayType.php b/src/Type/Doctrine/Descriptors/JsonArrayType.php
@@ -10,7 +10,7 @@ class JsonArrayType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'json_array';
+		return \Doctrine\DBAL\Types\JsonArrayType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/JsonType.php b/src/Type/Doctrine/Descriptors/JsonType.php
@@ -10,7 +10,7 @@ class JsonType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'json';
+		return \Doctrine\DBAL\Types\JsonType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/ObjectType.php b/src/Type/Doctrine/Descriptors/ObjectType.php
@@ -10,7 +10,7 @@ class ObjectType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'object';
+		return \Doctrine\DBAL\Types\ObjectType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/ReflectionDescriptor.php b/src/Type/Doctrine/Descriptors/ReflectionDescriptor.php
@@ -9,12 +9,16 @@
 class ReflectionDescriptor implements DoctrineTypeDescriptor
 {
 
-	/** @var string */
+	/** @var class-string<\Doctrine\DBAL\Types\Type> */
 	private $type;
 
 	/** @var \PHPStan\Broker\Broker */
 	private $broker;
 
+	/**
+	 * @param class-string<\Doctrine\DBAL\Types\Type> $type
+	 * @param \PHPStan\Broker\Broker $broker
+	 */
 	public function __construct(string $type, Broker $broker)
 	{
 		$this->type = $type;
@@ -28,12 +32,12 @@ public function getType(): string
 
 	public function getWritableToPropertyType(): Type
 	{
-		return ParametersAcceptorSelector::selectSingle($this->broker->getClass((['Doctrine\DBAL\Types\Type', 'getTypesMap'])()[$this->type])->getNativeMethod('convertToPHPValue')->getVariants())->getReturnType();
+		return ParametersAcceptorSelector::selectSingle($this->broker->getClass($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();
+		return ParametersAcceptorSelector::selectSingle($this->broker->getClass($this->type)->getNativeMethod('convertToDatabaseValue')->getVariants())->getParameters()[0]->getType();
 	}
 
 }
diff --git a/src/Type/Doctrine/Descriptors/SimpleArrayType.php b/src/Type/Doctrine/Descriptors/SimpleArrayType.php
@@ -10,7 +10,7 @@ class SimpleArrayType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'simple_array';
+		return \Doctrine\DBAL\Types\SimpleArrayType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/SmallIntType.php b/src/Type/Doctrine/Descriptors/SmallIntType.php
@@ -9,7 +9,7 @@ class SmallIntType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'smallint';
+		return \Doctrine\DBAL\Types\SmallIntType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/StringType.php b/src/Type/Doctrine/Descriptors/StringType.php
@@ -9,7 +9,7 @@ class StringType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'string';
+		return \Doctrine\DBAL\Types\StringType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/TextType.php b/src/Type/Doctrine/Descriptors/TextType.php
@@ -9,7 +9,7 @@ class TextType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'text';
+		return \Doctrine\DBAL\Types\TextType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/TimeImmutableType.php b/src/Type/Doctrine/Descriptors/TimeImmutableType.php
@@ -11,7 +11,7 @@ class TimeImmutableType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'time_immutable';
+		return \Doctrine\DBAL\Types\TimeImmutableType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/src/Type/Doctrine/Descriptors/TimeType.php b/src/Type/Doctrine/Descriptors/TimeType.php
@@ -11,7 +11,7 @@ class TimeType implements DoctrineTypeDescriptor
 
 	public function getType(): string
 	{
-		return 'time';
+		return \Doctrine\DBAL\Types\TimeType::class;
 	}
 
 	public function getWritableToPropertyType(): Type
diff --git a/tests/Rules/Doctrine/ORM/EntityColumnRuleTest.php b/tests/Rules/Doctrine/ORM/EntityColumnRuleTest.php
@@ -11,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\DateType;
 use PHPStan\Type\Doctrine\Descriptors\IntegerType;
 use PHPStan\Type\Doctrine\Descriptors\ReflectionDescriptor;
 use PHPStan\Type\Doctrine\Descriptors\StringType;
@@ -37,7 +38,8 @@ protected function getRule(): Rule
 				new DateTimeImmutableType(),
 				new BinaryType(),
 				new IntegerType(),
-				new ReflectionDescriptor(CustomType::NAME, $this->createBroker()),
+				new ReflectionDescriptor(CustomType::class, $this->createBroker()),
+				new DateType(),
 			]),
 			true
 		);
diff --git a/tests/Rules/Doctrine/ORM/data/MyBrokenEntity.php b/tests/Rules/Doctrine/ORM/data/MyBrokenEntity.php
@@ -42,4 +42,10 @@ class MyBrokenEntity extends MyBrokenSuperclass
 	 */
 	private $four;
 
+	/**
+	 * @ORM\Column(type="date")
+	 * @var \DateTimeImmutable
+	 */
+	private $six;
+
 }
diff --git a/tests/Rules/Doctrine/ORM/entity-manager.php b/tests/Rules/Doctrine/ORM/entity-manager.php
@@ -21,6 +21,11 @@
 	)
 );
 
+\Doctrine\DBAL\Types\Type::overrideType(
+	'date',
+	\Doctrine\DBAL\Types\DateTimeImmutableType::class
+);
+
 return EntityManager::create(
 	[
 		'driver' => 'pdo_sqlite',

Original file line number	Diff line number	Diff line change
`@@ -2,12 +2,13 @@`
`2`	`2`
`3`	`3`	`namespace PHPStan\Type\Doctrine;`
`4`	`4`
	`5`	`+use Doctrine\DBAL\Types\Type;`
`5`	`6`	`use PHPStan\Type\Doctrine\Descriptors\DoctrineTypeDescriptor;`
`6`	`7`
`7`	`8`	`class DescriptorRegistry`
`8`	`9`	`{`
`9`	`10`
`10`		`- /** @var array<string, \PHPStan\Type\Doctrine\Descriptors\DoctrineTypeDescriptor> */`
	`11`	`+ /** @var array<class-string<\Doctrine\DBAL\Types\Type>, \PHPStan\Type\Doctrine\Descriptors\DoctrineTypeDescriptor> */`
`11`	`12`	`private $descriptors = [];`
`12`	`13`
`13`	`14`	`/**`
`@@ -22,10 +23,17 @@ public function __construct(array $descriptors)`
`22`	`23`
`23`	`24`	`public function get(string $type): DoctrineTypeDescriptor`
`24`	`25`	`{`
`25`		`- if (!isset($this->descriptors[$type])) {`
	`26`	`+ $typesMap = Type::getTypesMap();`
	`27`	`+ if (!isset($typesMap[$type])) {`
`26`	`28`	`throw new \PHPStan\Type\Doctrine\DescriptorNotRegisteredException();`
`27`	`29`	`}`
`28`		`- return $this->descriptors[$type];`
	`30`	`+`
	`31`	`+ /** @var class-string<\Doctrine\DBAL\Types\Type> $typeClass */`
	`32`	`+ $typeClass = $typesMap[$type];`
	`33`	`+ if (!isset($this->descriptors[$typeClass])) {`
	`34`	`+ throw new \PHPStan\Type\Doctrine\DescriptorNotRegisteredException();`
	`35`	`+ }`
	`36`	`+ return $this->descriptors[$typeClass];`
`29`	`37`	`}`
`30`	`38`
`31`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ class ArrayType implements DoctrineTypeDescriptor`
`10`	`10`
`11`	`11`	`public function getType(): string`
`12`	`12`	`{`
`13`		`- return 'array';`
	`13`	`+ return \Doctrine\DBAL\Types\ArrayType::class;`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`public function getWritableToPropertyType(): Type`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ class BigIntType implements DoctrineTypeDescriptor`
`10`	`10`
`11`	`11`	`public function getType(): string`
`12`	`12`	`{`
`13`		`- return 'bigint';`
	`13`	`+ return \Doctrine\DBAL\Types\BigIntType::class;`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`public function getWritableToPropertyType(): Type`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ class BinaryType implements DoctrineTypeDescriptor`
`11`	`11`
`12`	`12`	`public function getType(): string`
`13`	`13`	`{`
`14`		`- return 'binary';`
	`14`	`+ return \Doctrine\DBAL\Types\BinaryType::class;`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`public function getWritableToPropertyType(): Type`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ class BlobType implements DoctrineTypeDescriptor`
`11`	`11`
`12`	`12`	`public function getType(): string`
`13`	`13`	`{`
`14`		`- return 'blob';`
	`14`	`+ return \Doctrine\DBAL\Types\BlobType::class;`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`public function getWritableToPropertyType(): Type`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ class BooleanType implements DoctrineTypeDescriptor`
`9`	`9`
`10`	`10`	`public function getType(): string`
`11`	`11`	`{`
`12`		`- return 'boolean';`
	`12`	`+ return \Doctrine\DBAL\Types\BooleanType::class;`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`public function getWritableToPropertyType(): Type`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ class DateImmutableType implements DoctrineTypeDescriptor`
`11`	`11`
`12`	`12`	`public function getType(): string`
`13`	`13`	`{`
`14`		`- return 'date_immutable';`
	`14`	`+ return \Doctrine\DBAL\Types\DateTimeImmutableType::class;`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`public function getWritableToPropertyType(): Type`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ class DateIntervalType implements DoctrineTypeDescriptor`
`11`	`11`
`12`	`12`	`public function getType(): string`
`13`	`13`	`{`
`14`		`- return 'dateinterval';`
	`14`	`+ return \Doctrine\DBAL\Types\DateIntervalType::class;`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`public function getWritableToPropertyType(): Type`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ class DateTimeImmutableType implements DoctrineTypeDescriptor`
`11`	`11`
`12`	`12`	`public function getType(): string`
`13`	`13`	`{`
`14`		`- return 'datetime_immutable';`
	`14`	`+ return \Doctrine\DBAL\Types\DateTimeImmutableType::class;`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`public function getWritableToPropertyType(): Type`