Allow disabling return type and stub extensions (#884)

* Allow disabling return type and stub extensions

* classes still need to be marked as a service

* update README.md

Author: mglaman

README.md

@@ -108,6 +108,23 @@ parameters:
             classExtendsInternalClassRule: false
 ```
 
+#### Disabling  extensions
+
+You can disable various extensions. This is useful when contributing to Drupal Core to improve its types.
+
+```neon
+parameters:
+    drupal:
+        extensions:
+            entityFieldsViaMagicReflection: true
+            entityFieldMethodsViaMagicReflection: true
+            entityQuery: true
+            entityRepository: true
+            stubFiles: true
+```
+
+Both options are enabled by default.
+
 ### Entity storage mappings.
 
 The `EntityTypeManagerGetStorageDynamicReturnTypeExtension` service helps map dynamic return types. This inspects the

extension.neon

@@ -21,6 +21,12 @@ parameters:
 			checkDeprecatedHooksInApiFiles: false
 			checkCoreDeprecatedHooksInApiFiles: false
 			checkContribDeprecatedHooksInApiFiles: false
+		extensions:
+			entityFieldsViaMagicReflection: true
+			entityFieldMethodsViaMagicReflection: true
+			entityQuery: true
+			entityRepository: true
+			stubFiles: true
 		rules:
 			testClassSuffixNameRule: false
 			dependencySerializationTraitPropertyRule: false
@@ -248,6 +254,13 @@ parametersSchema:
 			checkCoreDeprecatedHooksInApiFiles: boolean()
 			checkContribDeprecatedHooksInApiFiles: boolean()
 		])
+		extensions: structure([
+			entityFieldsViaMagicReflection: boolean()
+			entityFieldMethodsViaMagicReflection: boolean()
+			entityQuery: boolean()
+			entityRepository: boolean()
+			stubFiles: boolean()
+		])
 		rules: structure([
 			testClassSuffixNameRule: boolean()
 			dependencySerializationTraitPropertyRule: boolean()
@@ -282,10 +295,8 @@ services:
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\EntityRepositoryReturnTypeExtension
-		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\EntityStorage\GetQueryReturnTypeExtension
-		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\ContainerDynamicReturnTypeExtension
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
@@ -294,10 +305,8 @@ services:
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryDynamicReturnTypeExtension
-		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryAccessCheckDynamicReturnTypeExtension
-		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\EntityAccessControlHandlerReturnTypeExtension
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
@@ -312,17 +321,12 @@ services:
 		tags: [phpstan.broker.dynamicStaticMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Reflection\EntityFieldsViaMagicReflectionExtension
-		tags: [phpstan.broker.propertiesClassReflectionExtension]
 	-
 		class: mglaman\PHPStanDrupal\Reflection\EntityFieldMethodsViaMagicReflectionExtension
-		tags: [phpstan.broker.methodsClassReflectionExtension]
 	-
 		class: mglaman\PHPStanDrupal\Drupal\DrupalStubFilesExtension
-		tags: [phpstan.stubFilesExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\EntityQuery\AccessCheckTypeSpecifyingExtension
-		tags:
-			- phpstan.typeSpecifier.methodTypeSpecifyingExtension
 	-
 		class: mglaman\PHPStanDrupal\DeprecatedScope\GroupLegacyScope
 		tags:
@@ -338,4 +342,22 @@ services:
 	-
 		class: mglaman\PHPStanDrupal\Type\InspectorTypeExtension
 		tags:
-			- phpstan.typeSpecifier.staticMethodTypeSpecifyingExtension
+			- phpstan.typeSpecifier.staticMethodTypeSpecifyingExtension
+
+conditionalTags:
+	mglaman\PHPStanDrupal\Reflection\EntityFieldsViaMagicReflectionExtension:
+		phpstan.broker.propertiesClassReflectionExtension: %drupal.extensions.entityFieldsViaMagicReflection%
+	mglaman\PHPStanDrupal\Reflection\EntityFieldMethodsViaMagicReflectionExtension:
+		phpstan.broker.methodsClassReflectionExtension: %drupal.extensions.entityFieldMethodsViaMagicReflection%
+	mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryDynamicReturnTypeExtension:
+		phpstan.broker.dynamicMethodReturnTypeExtension: %drupal.extensions.entityQuery%
+	mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryAccessCheckDynamicReturnTypeExtension:
+		phpstan.broker.dynamicMethodReturnTypeExtension: %drupal.extensions.entityQuery%
+	mglaman\PHPStanDrupal\Type\EntityQuery\AccessCheckTypeSpecifyingExtension:
+		phpstan.typeSpecifier.methodTypeSpecifyingExtension: %drupal.extensions.entityQuery%
+	mglaman\PHPStanDrupal\Type\EntityStorage\GetQueryReturnTypeExtension:
+		phpstan.broker.dynamicMethodReturnTypeExtension: %drupal.extensions.entityQuery%
+	mglaman\PHPStanDrupal\Type\EntityRepositoryReturnTypeExtension:
+		phpstan.broker.dynamicMethodReturnTypeExtension: %drupal.extensions.entityRepository%
+	mglaman\PHPStanDrupal\Drupal\DrupalStubFilesExtension:
+		phpstan.stubFilesExtension: %drupal.extensions.stubFiles%

src/Reflection/EntityFieldMethodsViaMagicReflectionExtension.php

@@ -13,9 +13,9 @@
  */
 class EntityFieldMethodsViaMagicReflectionExtension implements MethodsClassReflectionExtension
 {
-
     public function hasMethod(ClassReflection $classReflection, string $methodName): bool
     {
+        
         if ($classReflection->hasNativeMethod($methodName) || array_key_exists($methodName, $classReflection->getMethodTags())) {
             // Let other parts of PHPStan handle this.
             return false;

tests/src/Reflection/EntityFieldMethodsViaMagicReflectionExtensionTest.php

@@ -53,5 +53,6 @@ public static function dataHasMethod(): \Generator
             false,
         ];
     }
+    
 
 }

tests/src/Reflection/EntityFieldsViaMagicReflectionExtensionTest.php

@@ -123,7 +123,7 @@ public function testGetPropertyFieldItemList(): void
         $propertyReflection = $this->extension->getProperty($classReflection, 'format');
         $readableType = $propertyReflection->getReadableType();
         self::assertInstanceOf(NullType::class, $readableType);
-
     }
+    
 
 }