phpstan · ondrejmirtes · Mar 20, 2024 · Mar 19, 2024
diff --git a/src/Classes/ForbiddenClassNameExtension.php b/src/Classes/ForbiddenClassNameExtension.php
@@ -0,0 +1,32 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Classes;
+
+/**
+ * This is the extension interface to implement if you want to dynamically
+ * add forbidden class prefixes to the ClassForbiddenNameCheck rule.
+ *
+ * The idea is that you want to report usages of classes that you're not supposed to use in application.
+ * For example: Generated Doctrine proxies from their configured namespace.
+ *
+ * To register it in the configuration file use the `phpstan.forbiddenClassNamesExtension` service tag:
+ *
+ * ```
+ * services:
+ * 	-
+ *		class: App\PHPStan\MyExtension
+ *		tags:
+ *			- phpstan.forbiddenClassNamesExtension
+ * ```
+ *
+ * @api
+ */
+interface ForbiddenClassNameExtension
+{
+
+	public const EXTENSION_TAG = 'phpstan.forbiddenClassNamesExtension';
+
+	/** @return array<string, string> */
+	public function getClassPrefixes(): array;
+
+}
diff --git a/src/Rules/ClassForbiddenNameCheck.php b/src/Rules/ClassForbiddenNameCheck.php
@@ -2,8 +2,13 @@
 
 namespace PHPStan\Rules;
 
+use PHPStan\Classes\ForbiddenClassNameExtension;
+use PHPStan\DependencyInjection\Container;
+use function array_map;
+use function array_merge;
 use function sprintf;
 use function str_starts_with;
+use function strlen;
 use function strpos;
 use function substr;
 
@@ -16,22 +21,45 @@ class ClassForbiddenNameCheck
 		'PHP-Scoper' => '_PhpScoper',
 	];
 
+	public function __construct(private Container $container)
+	{
+	}
+
 	/**
 	 * @param ClassNameNodePair[] $pairs
 	 * @return RuleError[]
 	 */
 	public function checkClassNames(array $pairs): array
 	{
+		$extensions = $this->container->getServicesByTag(ForbiddenClassNameExtension::EXTENSION_TAG);
+
+		$classPrefixes = array_merge(
+			self::INTERNAL_CLASS_PREFIXES,
+			...array_map(
+				static fn (ForbiddenClassNameExtension $extension): array => $extension->getClassPrefixes(),
+				$extensions,
+			),
+		);
+
 		$errors = [];
 		foreach ($pairs as $pair) {
 			$className = $pair->getClassName();
 
 			$projectName = null;
-			foreach (self::INTERNAL_CLASS_PREFIXES as $project => $prefix) {
-				if (str_starts_with($className, $prefix)) {
-					$projectName = $project;
-					break;
+			$withoutPrefixClassName = null;
+			foreach ($classPrefixes as $project => $prefix) {
+				if (!str_starts_with($className, $prefix)) {
+					continue;
 				}
+
+				$projectName = $project;
+				$withoutPrefixClassName = substr($className, strlen($prefix));
+
+				if (strpos($withoutPrefixClassName, '\\') === false) {
+					continue;
+				}
+
+				$withoutPrefixClassName = substr($withoutPrefixClassName, strpos($withoutPrefixClassName, '\\'));
 			}
 
 			if ($projectName === null) {
@@ -44,10 +72,10 @@ public function checkClassNames(array $pairs): array
 				$className,
 			))->line($pair->getNode()->getLine())->nonIgnorable();
 
-			if (strpos($className, '\\') !== false) {
+			if ($withoutPrefixClassName !== null) {
 				$error->tip(sprintf(
 					'This is most likely unintentional. Did you mean to type %s?',
-					substr($className, strpos($className, '\\')),
+					$withoutPrefixClassName,
 				));
 			}
 

diff --git a/tests/PHPStan/Rules/Classes/ClassAttributesRuleTest.php b/tests/PHPStan/Rules/Classes/ClassAttributesRuleTest.php
@@ -42,7 +42,7 @@ protected function getRule(): Rule
 				),
 				new ClassNameCheck(
 					new ClassCaseSensitivityCheck($reflectionProvider, false),
-					new ClassForbiddenNameCheck(),
+					new ClassForbiddenNameCheck(self::getContainer()),
 				),
 				true,
 			),

diff --git a/tests/PHPStan/Rules/Classes/ClassConstantAttributesRuleTest.php b/tests/PHPStan/Rules/Classes/ClassConstantAttributesRuleTest.php
@@ -41,7 +41,7 @@ protected function getRule(): Rule
 				),
 				new ClassNameCheck(
 					new ClassCaseSensitivityCheck($reflectionProvider, false),
-					new ClassForbiddenNameCheck(),
+					new ClassForbiddenNameCheck(self::getContainer()),
 				),
 				true,
 			),

diff --git a/tests/PHPStan/Rules/Classes/ClassConstantRuleTest.php b/tests/PHPStan/Rules/Classes/ClassConstantRuleTest.php
@@ -27,7 +27,7 @@ protected function getRule(): Rule
 			new RuleLevelHelper($reflectionProvider, true, false, true, false, false, true, false),
 			new ClassNameCheck(
 				new ClassCaseSensitivityCheck($reflectionProvider, true),
-				new ClassForbiddenNameCheck(),
+				new ClassForbiddenNameCheck(self::getContainer()),
 			),
 			new PhpVersion($this->phpVersion),
 		);

diff --git a/tests/PHPStan/Rules/Classes/ExistingClassInClassExtendsRuleTest.php b/tests/PHPStan/Rules/Classes/ExistingClassInClassExtendsRuleTest.php
@@ -21,7 +21,7 @@ protected function getRule(): Rule
 		return new ExistingClassInClassExtendsRule(
 			new ClassNameCheck(
 				new ClassCaseSensitivityCheck($reflectionProvider, true),
-				new ClassForbiddenNameCheck(),
+				new ClassForbiddenNameCheck(self::getContainer()),
 			),
 			$reflectionProvider,
 		);

diff --git a/tests/PHPStan/Rules/Classes/ExistingClassInInstanceOfRuleTest.php b/tests/PHPStan/Rules/Classes/ExistingClassInInstanceOfRuleTest.php
@@ -21,7 +21,7 @@ protected function getRule(): Rule
 			$reflectionProvider,
 			new ClassNameCheck(
 				new ClassCaseSensitivityCheck($reflectionProvider, true),
-				new ClassForbiddenNameCheck(),
+				new ClassForbiddenNameCheck(self::getContainer()),
 			),
 			true,
 		);

diff --git a/tests/PHPStan/Rules/Classes/ExistingClassInTraitUseRuleTest.php b/tests/PHPStan/Rules/Classes/ExistingClassInTraitUseRuleTest.php
@@ -21,7 +21,7 @@ protected function getRule(): Rule
 		return new ExistingClassInTraitUseRule(
 			new ClassNameCheck(
 				new ClassCaseSensitivityCheck($reflectionProvider, true),
-				new ClassForbiddenNameCheck(),
+				new ClassForbiddenNameCheck(self::getContainer()),
 			),
 			$reflectionProvider,
 		);

diff --git a/tests/PHPStan/Rules/Classes/ExistingClassesInClassImplementsRuleTest.php b/tests/PHPStan/Rules/Classes/ExistingClassesInClassImplementsRuleTest.php
@@ -21,7 +21,7 @@ protected function getRule(): Rule
 		return new ExistingClassesInClassImplementsRule(
 			new ClassNameCheck(
 				new ClassCaseSensitivityCheck($reflectionProvider, true),
-				new ClassForbiddenNameCheck(),
+				new ClassForbiddenNameCheck(self::getContainer()),
 			),
 			$reflectionProvider,
 		);

diff --git a/tests/PHPStan/Rules/Classes/ExistingClassesInEnumImplementsRuleTest.php b/tests/PHPStan/Rules/Classes/ExistingClassesInEnumImplementsRuleTest.php
@@ -22,7 +22,7 @@ protected function getRule(): Rule
 		return new ExistingClassesInEnumImplementsRule(
 			new ClassNameCheck(
 				new ClassCaseSensitivityCheck($reflectionProvider, true),
-				new ClassForbiddenNameCheck(),
+				new ClassForbiddenNameCheck(self::getContainer()),
 			),
 			$reflectionProvider,
 		);

diff --git a/tests/PHPStan/Rules/Classes/ExistingClassesInInterfaceExtendsRuleTest.php b/tests/PHPStan/Rules/Classes/ExistingClassesInInterfaceExtendsRuleTest.php
@@ -21,7 +21,7 @@ protected function getRule(): Rule
 		return new ExistingClassesInInterfaceExtendsRule(
 			new ClassNameCheck(
 				new ClassCaseSensitivityCheck($reflectionProvider, true),
-				new ClassForbiddenNameCheck(),
+				new ClassForbiddenNameCheck(self::getContainer()),
 			),
 			$reflectionProvider,
 		);

diff --git a/tests/PHPStan/Rules/Classes/ForbiddenNameCheckExtensionRuleTest.php b/tests/PHPStan/Rules/Classes/ForbiddenNameCheckExtensionRuleTest.php
@@ -0,0 +1,60 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Classes;
+
+use PHPStan\Php\PhpVersion;
+use PHPStan\Rules\ClassCaseSensitivityCheck;
+use PHPStan\Rules\ClassForbiddenNameCheck;
+use PHPStan\Rules\ClassNameCheck;
+use PHPStan\Rules\FunctionCallParametersCheck;
+use PHPStan\Rules\NullsafeCheck;
+use PHPStan\Rules\PhpDoc\UnresolvableTypeHelper;
+use PHPStan\Rules\Properties\PropertyReflectionFinder;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleLevelHelper;
+use PHPStan\Testing\RuleTestCase;
+use function array_merge;
+
+/**
+ * @extends RuleTestCase<InstantiationRule>
+ */
+class ForbiddenNameCheckExtensionRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		$reflectionProvider = $this->createReflectionProvider();
+		return new InstantiationRule(
+			$reflectionProvider,
+			new FunctionCallParametersCheck(new RuleLevelHelper($reflectionProvider, true, false, true, false, false, true, false), new NullsafeCheck(), new PhpVersion(80000), new UnresolvableTypeHelper(), new PropertyReflectionFinder(), true, true, true, true, true),
+			new ClassNameCheck(
+				new ClassCaseSensitivityCheck($reflectionProvider, true),
+				new ClassForbiddenNameCheck(self::getContainer()),
+			),
+		);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return array_merge(parent::getAdditionalConfigFiles(), [
+			__DIR__ . '/data/forbidden-name-class-extension.neon',
+		]);
+	}
+
+	public function testInternalClassFromExtensions(): void
+	{
+		$this->analyse([__DIR__ . '/data/forbidden-name-class-extension.php'], [
+			[
+				'Referencing prefixed Doctrine class: App\GeneratedProxy\__CG__\App\TestDoctrineEntity.',
+				31,
+				'This is most likely unintentional. Did you mean to type \App\TestDoctrineEntity?',
+			],
+			[
+				'Referencing prefixed PHPStan class: _PHPStan_15755dag8c\TestPhpStanEntity.',
+				32,
+				'This is most likely unintentional. Did you mean to type \TestPhpStanEntity?',
+			],
+		]);
+	}
+
+}
diff --git a/tests/PHPStan/Rules/Classes/InstantiationRuleTest.php b/tests/PHPStan/Rules/Classes/InstantiationRuleTest.php
@@ -29,7 +29,7 @@ protected function getRule(): Rule
 			new FunctionCallParametersCheck(new RuleLevelHelper($reflectionProvider, true, false, true, false, false, true, false), new NullsafeCheck(), new PhpVersion(80000), new UnresolvableTypeHelper(), new PropertyReflectionFinder(), true, true, true, true, true),
 			new ClassNameCheck(
 				new ClassCaseSensitivityCheck($reflectionProvider, true),
-				new ClassForbiddenNameCheck(),
+				new ClassForbiddenNameCheck(self::getContainer()),
 			),
 		);
 	}

diff --git a/tests/PHPStan/Rules/Classes/MixinRuleTest.php b/tests/PHPStan/Rules/Classes/MixinRuleTest.php
@@ -26,7 +26,7 @@ protected function getRule(): Rule
 			$reflectionProvider,
 			new ClassNameCheck(
 				new ClassCaseSensitivityCheck($reflectionProvider, true),
-				new ClassForbiddenNameCheck(),
+				new ClassForbiddenNameCheck(self::getContainer()),
 			),
 			new GenericObjectTypeCheck(),
 			new MissingTypehintCheck(true, true, true, true, []),

diff --git a/tests/PHPStan/Rules/Classes/data/forbidden-name-class-extension.neon b/tests/PHPStan/Rules/Classes/data/forbidden-name-class-extension.neon
@@ -0,0 +1,5 @@
+services:
+	-
+		class: ForbiddenNameClassExtension\CGForbiddenNameClassExtension
+		tags:
+			- phpstan.forbiddenClassNamesExtension
diff --git a/tests/PHPStan/Rules/Classes/data/forbidden-name-class-extension.php b/tests/PHPStan/Rules/Classes/data/forbidden-name-class-extension.php
@@ -0,0 +1,32 @@
+<?php declare(strict_types = 1);
+
+namespace App\GeneratedProxy\__CG__\App;
+
+class TestDoctrineEntity
+{
+}
+
+namespace _PHPStan_15755dag8c;
+
+class TestPhpStanEntity
+{
+}
+
+namespace ForbiddenNameClassExtension;
+
+use App\GeneratedProxy\__CG__\App\TestEntity;
+
+class CGForbiddenNameClassExtension implements \PHPStan\Classes\ForbiddenClassNameExtension
+{
+
+	public function getClassPrefixes(): array
+	{
+		return [
+			'Doctrine' => 'App\GeneratedProxy\__CG__',
+		];
+	}
+
+}
+
+$doctrineEntity = new \App\GeneratedProxy\__CG__\App\TestDoctrineEntity();
+$phpStanEntity = new \_PHPStan_15755dag8c\TestPhpStanEntity();
diff --git a/tests/PHPStan/Rules/EnumCases/EnumCaseAttributesRuleTest.php b/tests/PHPStan/Rules/EnumCases/EnumCaseAttributesRuleTest.php
@@ -41,7 +41,7 @@ protected function getRule(): Rule
 				),
 				new ClassNameCheck(
 					new ClassCaseSensitivityCheck($reflectionProvider, false),
-					new ClassForbiddenNameCheck(),
+					new ClassForbiddenNameCheck(self::getContainer()),
 				),
 				true,
 			),

diff --git a/tests/PHPStan/Rules/Exceptions/CaughtExceptionExistenceRuleTest.php b/tests/PHPStan/Rules/Exceptions/CaughtExceptionExistenceRuleTest.php
@@ -21,7 +21,7 @@ protected function getRule(): Rule
 			$reflectionProvider,
 			new ClassNameCheck(
 				new ClassCaseSensitivityCheck($reflectionProvider, true),
-				new ClassForbiddenNameCheck(),
+				new ClassForbiddenNameCheck(self::getContainer()),
 			),
 			true,
 		);

diff --git a/tests/PHPStan/Rules/Functions/ArrowFunctionAttributesRuleTest.php b/tests/PHPStan/Rules/Functions/ArrowFunctionAttributesRuleTest.php
@@ -41,7 +41,7 @@ protected function getRule(): Rule
 				),
 				new ClassNameCheck(
 					new ClassCaseSensitivityCheck($reflectionProvider, false),
-					new ClassForbiddenNameCheck(),
+					new ClassForbiddenNameCheck(self::getContainer()),
 				),
 				true,
 			),

diff --git a/tests/PHPStan/Rules/Functions/ClosureAttributesRuleTest.php b/tests/PHPStan/Rules/Functions/ClosureAttributesRuleTest.php
@@ -41,7 +41,7 @@ protected function getRule(): Rule
 				),
 				new ClassNameCheck(
 					new ClassCaseSensitivityCheck($reflectionProvider, false),
-					new ClassForbiddenNameCheck(),
+					new ClassForbiddenNameCheck(self::getContainer()),
 				),
 				true,
 			),

diff --git a/tests/PHPStan/Rules/Functions/ExistingClassesInArrowFunctionTypehintsRuleTest.php b/tests/PHPStan/Rules/Functions/ExistingClassesInArrowFunctionTypehintsRuleTest.php
@@ -28,7 +28,7 @@ protected function getRule(): Rule
 				$reflectionProvider,
 				new ClassNameCheck(
 					new ClassCaseSensitivityCheck($reflectionProvider, true),
-					new ClassForbiddenNameCheck(),
+					new ClassForbiddenNameCheck(self::getContainer()),
 				),
 				new UnresolvableTypeHelper(),
 				new PhpVersion($this->phpVersionId),

diff --git a/tests/PHPStan/Rules/Functions/ExistingClassesInClosureTypehintsRuleTest.php b/tests/PHPStan/Rules/Functions/ExistingClassesInClosureTypehintsRuleTest.php
@@ -28,7 +28,7 @@ protected function getRule(): Rule
 				$reflectionProvider,
 				new ClassNameCheck(
 					new ClassCaseSensitivityCheck($reflectionProvider, true),
-					new ClassForbiddenNameCheck(),
+					new ClassForbiddenNameCheck(self::getContainer()),
 				),
 				new UnresolvableTypeHelper(),
 				new PhpVersion($this->phpVersionId),

diff --git a/tests/PHPStan/Rules/Functions/ExistingClassesInTypehintsRuleTest.php b/tests/PHPStan/Rules/Functions/ExistingClassesInTypehintsRuleTest.php
@@ -28,7 +28,7 @@ protected function getRule(): Rule
 				$reflectionProvider,
 				new ClassNameCheck(
 					new ClassCaseSensitivityCheck($reflectionProvider, true),
-					new ClassForbiddenNameCheck(),
+					new ClassForbiddenNameCheck(self::getContainer()),
 				),
 				new UnresolvableTypeHelper(),
 				new PhpVersion($this->phpVersionId),

diff --git a/tests/PHPStan/Rules/Functions/FunctionAttributesRuleTest.php b/tests/PHPStan/Rules/Functions/FunctionAttributesRuleTest.php
@@ -41,7 +41,7 @@ protected function getRule(): Rule
 				),
 				new ClassNameCheck(
 					new ClassCaseSensitivityCheck($reflectionProvider, false),
-					new ClassForbiddenNameCheck(),
+					new ClassForbiddenNameCheck(self::getContainer()),
 				),
 				true,
 			),

diff --git a/tests/PHPStan/Rules/Functions/ParamAttributesRuleTest.php b/tests/PHPStan/Rules/Functions/ParamAttributesRuleTest.php
@@ -41,7 +41,7 @@ protected function getRule(): Rule
 				),
 				new ClassNameCheck(
 					new ClassCaseSensitivityCheck($reflectionProvider, false),
-					new ClassForbiddenNameCheck(),
+					new ClassForbiddenNameCheck(self::getContainer()),
 				),
 				true,
 			),

diff --git a/tests/PHPStan/Rules/Generics/ClassTemplateTypeRuleTest.php b/tests/PHPStan/Rules/Generics/ClassTemplateTypeRuleTest.php
@@ -25,7 +25,7 @@ protected function getRule(): Rule
 				$reflectionProvider,
 				new ClassNameCheck(
 					new ClassCaseSensitivityCheck($reflectionProvider, true),
-					new ClassForbiddenNameCheck(),
+					new ClassForbiddenNameCheck(self::getContainer()),
 				),
 				new GenericObjectTypeCheck(),
 				$typeAliasResolver,