Option to report unknown types

Author: lookyman

rules.neon

@@ -1,6 +1,7 @@
 parameters:
 	doctrine:
 		reportDynamicQueryBuilders: false
+		reportUnknownTypes: false
 
 parametersSchema:
 	doctrine: structure([
@@ -11,13 +12,13 @@ parametersSchema:
 		searchOtherMethodsForQueryBuilderBeginning: bool()
 		queryBuilderFastAlgorithm: bool()
 		reportDynamicQueryBuilders: bool()
+		reportUnknownTypes: bool()
 	])
 
 rules:
 	- PHPStan\Rules\Doctrine\ORM\DqlRule
 	- PHPStan\Rules\Doctrine\ORM\MagicRepositoryMethodCallRule
 	- PHPStan\Rules\Doctrine\ORM\RepositoryMethodCallRule
-	- PHPStan\Rules\Doctrine\ORM\EntityColumnRule
 	- PHPStan\Rules\Doctrine\ORM\EntityRelationRule
 
 services:
@@ -27,3 +28,9 @@ services:
 			reportDynamicQueryBuilders: %doctrine.reportDynamicQueryBuilders%
 		tags:
 			- phpstan.rules.rule
+	-
+		class: PHPStan\Rules\Doctrine\ORM\EntityColumnRule
+		arguments:
+			reportUnknownTypes: %doctrine.reportUnknownTypes%
+		tags:
+			- phpstan.rules.rule

src/Rules/Doctrine/ORM/EntityColumnRule.php

@@ -23,10 +23,18 @@ class EntityColumnRule implements Rule
 	/** @var \PHPStan\Type\Doctrine\DescriptorRegistry */
 	private $descriptorRegistry;
 
-	public function __construct(ObjectMetadataResolver $objectMetadataResolver, DescriptorRegistry $descriptorRegistry)
+	/** @var bool */
+	private $reportUnknownTypes;
+
+	public function __construct(
+		ObjectMetadataResolver $objectMetadataResolver,
+		DescriptorRegistry $descriptorRegistry,
+		bool $reportUnknownTypes
+	)
 	{
 		$this->objectMetadataResolver = $objectMetadataResolver;
 		$this->descriptorRegistry = $descriptorRegistry;
+		$this->reportUnknownTypes = $reportUnknownTypes;
 	}
 
 	public function getNodeType(): string
@@ -79,7 +87,12 @@ public function processNode(Node $node, Scope $scope): array
 		try {
 			$descriptor = $this->descriptorRegistry->get($fieldMapping['type']);
 		} catch (DescriptorNotRegisteredException $e) {
-			return [];
+			return $this->reportUnknownTypes ? [sprintf(
+				'Property %s::$%s: Doctrine type "%s" does not have any registered descriptor.',
+				$className,
+				$propertyName,
+				$fieldMapping['type']
+			)] : [];
 		}
 
 		$identifier = null;

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\IntegerType;
 use PHPStan\Type\Doctrine\Descriptors\ReflectionDescriptor;
 use PHPStan\Type\Doctrine\Descriptors\StringType;
 use PHPStan\Type\Doctrine\ObjectMetadataResolver;
@@ -32,8 +33,10 @@ protected function getRule(): Rule
 				new DateTimeType(),
 				new DateTimeImmutableType(),
 				new BinaryType(),
+				new IntegerType(),
 				new ReflectionDescriptor(CustomType::NAME, $this->createBroker()),
-			])
+			]),
+			true
 		);
 	}
 
@@ -115,4 +118,14 @@ public function testCustomType(): void
 		]);
 	}
 
+	public function testUnknownType(): void
+	{
+		$this->analyse([__DIR__ . '/data/EntityWithUnknownType.php'], [
+			[
+				'Property PHPStan\Rules\Doctrine\ORM\EntityWithUnknownType::$foo: Doctrine type "unknown" does not have any registered descriptor.',
+				24,
+			],
+		]);
+	}
+
 }

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

@@ -12,7 +12,7 @@ class AnotherEntity
 
 	/**
 	 * @ORM\Id()
-	 * @ORM\Column(type="int")
+	 * @ORM\Column(type="integer")
 	 * @var int
 	 */
 	private $id;

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

@@ -12,7 +12,7 @@ class EntityWithBrokenManyToManyRelations
 
 	/**
 	 * @ORM\Id()
-	 * @ORM\Column(type="int")
+	 * @ORM\Column(type="integer")
 	 * @var int
 	 */
 	private $id;

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

@@ -12,7 +12,7 @@ class EntityWithBrokenManyToOneRelations
 
 	/**
 	 * @ORM\Id()
-	 * @ORM\Column(type="int")
+	 * @ORM\Column(type="integer")
 	 * @var int
 	 */
 	private $id;

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

@@ -12,7 +12,7 @@ class EntityWithBrokenOneToManyRelations
 
 	/**
 	 * @ORM\Id()
-	 * @ORM\Column(type="int")
+	 * @ORM\Column(type="integer")
 	 * @var int
 	 */
 	private $id;

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

@@ -12,7 +12,7 @@ class EntityWithBrokenOneToOneRelations
 
 	/**
 	 * @ORM\Id()
-	 * @ORM\Column(type="int")
+	 * @ORM\Column(type="integer")
 	 * @var int
 	 */
 	private $id;

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

@@ -12,7 +12,7 @@ class EntityWithCustomType
 
 	/**
 	 * @ORM\Id()
-	 * @ORM\Column(type="int")
+	 * @ORM\Column(type="integer")
 	 * @var int
 	 */
 	private $id;

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

@@ -12,7 +12,7 @@ class EntityWithRelations
 
 	/**
 	 * @ORM\Id()
-	 * @ORM\Column(type="int")
+	 * @ORM\Column(type="integer")
 	 * @var int
 	 */
 	private $id;