Bleeding edge - check existing classes in @param-out

phpstan · Aug 22, 2024 · 30c4b9e · 30c4b9e
1 parent 30d3c0a
commit 30c4b9e
Show file tree

Hide file tree

Showing 10 changed files with 103 additions and 0 deletions.
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -61,5 +61,6 @@ parameters:
 		noImplicitWildcard: true
 		tooWidePropertyType: true
 		explicitThrow: true
+		absentTypeChecks: true
 	stubFiles:
 		- ../stubs/bleedingEdge/Rule.stub
diff --git a/conf/config.neon b/conf/config.neon
@@ -97,6 +97,7 @@ parameters:
 		narrowPregMatches: true
 		tooWidePropertyType: false
 		explicitThrow: false
+		absentTypeChecks: false
 	fileExtensions:
 		- php
 	checkAdvancedIsset: false
@@ -970,6 +971,7 @@ services:
 		arguments:
 			checkClassCaseSensitivity: %checkClassCaseSensitivity%
 			checkThisOnly: %checkThisOnly%
+			absentTypeChecks: %featureToggles.absentTypeChecks%
 
 	-
 		class: PHPStan\Rules\FunctionReturnTypeCheck

diff --git a/conf/parametersSchema.neon b/conf/parametersSchema.neon
@@ -92,6 +92,7 @@ parametersSchema:
 		narrowPregMatches: bool()
 		tooWidePropertyType: bool()
 		explicitThrow: bool()
+		absentTypeChecks: bool()
 	])
 	fileExtensions: listOf(string())
 	checkAdvancedIsset: bool()

diff --git a/src/Rules/FunctionDefinitionCheck.php b/src/Rules/FunctionDefinitionCheck.php
@@ -52,6 +52,7 @@ public function __construct(
 		private PhpVersion $phpVersion,
 		private bool $checkClassCaseSensitivity,
 		private bool $checkThisOnly,
+		private bool $absentTypeChecks,
 	)
 	{
 	}
@@ -583,9 +584,15 @@ private function getParameterReferencedClasses(ParameterReflection $parameter):
 			return $parameter->getNativeType()->getReferencedClasses();
 		}
 
+		$outTypeClasses = [];
+		if ($parameter->getOutType() !== null && $this->absentTypeChecks) {
+			$outTypeClasses = $parameter->getOutType()->getReferencedClasses();
+		}
+
 		return array_merge(
 			$parameter->getNativeType()->getReferencedClasses(),
 			$parameter->getPhpDocType()->getReferencedClasses(),
+			$outTypeClasses,
 		);
 	}
 

diff --git a/tests/PHPStan/Rules/Functions/ExistingClassesInArrowFunctionTypehintsRuleTest.php b/tests/PHPStan/Rules/Functions/ExistingClassesInArrowFunctionTypehintsRuleTest.php
@@ -34,6 +34,7 @@ protected function getRule(): Rule
 				new PhpVersion($this->phpVersionId),
 				true,
 				false,
+				true,
 			),
 			new PhpVersion(PHP_VERSION_ID),
 		);

diff --git a/tests/PHPStan/Rules/Functions/ExistingClassesInClosureTypehintsRuleTest.php b/tests/PHPStan/Rules/Functions/ExistingClassesInClosureTypehintsRuleTest.php
@@ -34,6 +34,7 @@ protected function getRule(): Rule
 				new PhpVersion($this->phpVersionId),
 				true,
 				false,
+				true,
 			),
 		);
 	}

diff --git a/tests/PHPStan/Rules/Functions/ExistingClassesInTypehintsRuleTest.php b/tests/PHPStan/Rules/Functions/ExistingClassesInTypehintsRuleTest.php
@@ -34,6 +34,7 @@ protected function getRule(): Rule
 				new PhpVersion($this->phpVersionId),
 				true,
 				false,
+				true,
 			),
 		);
 	}
@@ -451,4 +452,22 @@ public function testTemplateInParamOut(): void
 		]);
 	}
 
+	public function testParamOutClasses(): void
+	{
+		$this->analyse([__DIR__ . '/data/param-out-classes.php'], [
+			[
+				'Parameter $p of function ParamOutClasses\doFoo() has invalid type ParamOutClasses\Nonexistent.',
+				20,
+			],
+			[
+				'Parameter $q of function ParamOutClasses\doFoo() has invalid type ParamOutClasses\FooTrait.',
+				20,
+			],
+			[
+				'Class ParamOutClasses\Foo referenced with incorrect case: ParamOutClasses\fOO.',
+				20,
+			],
+		]);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Functions/data/param-out-classes.php b/tests/PHPStan/Rules/Functions/data/param-out-classes.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace ParamOutClasses;
+
+trait FooTrait
+{
+
+}
+
+class Foo
+{
+
+}
+
+/**
+ * @param-out Nonexistent $p
+ * @param-out FooTrait $q
+ * @param-out fOO $r
+ */
+function doFoo(&$p, &$q, $r): void
+{
+
+}
diff --git a/tests/PHPStan/Rules/Methods/ExistingClassesInTypehintsRuleTest.php b/tests/PHPStan/Rules/Methods/ExistingClassesInTypehintsRuleTest.php
@@ -34,6 +34,7 @@ protected function getRule(): Rule
 				new PhpVersion($this->phpVersionId),
 				true,
 				false,
+				true,
 			),
 		);
 	}
@@ -471,4 +472,22 @@ public function testTemplateInParamOut(): void
 		]);
 	}
 
+	public function testParamOutClasses(): void
+	{
+		$this->analyse([__DIR__ . '/data/param-out-classes.php'], [
+			[
+				'Parameter $p of method ParamOutClassesMethods\Bar::doFoo() has invalid type ParamOutClassesMethods\Nonexistent.',
+				23,
+			],
+			[
+				'Parameter $q of method ParamOutClassesMethods\Bar::doFoo() has invalid type ParamOutClassesMethods\FooTrait.',
+				23,
+			],
+			[
+				'Class ParamOutClassesMethods\Foo referenced with incorrect case: ParamOutClassesMethods\fOO.',
+				23,
+			],
+		]);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Methods/data/param-out-classes.php b/tests/PHPStan/Rules/Methods/data/param-out-classes.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace ParamOutClassesMethods;
+
+trait FooTrait
+{
+
+}
+
+class Foo
+{
+
+}
+
+class Bar
+{
+
+	/**
+	 * @param-out Nonexistent $p
+	 * @param-out FooTrait $q
+	 * @param-out fOO $r
+	 */
+	public function doFoo(&$p, &$q, $r): void
+	{
+
+	}
+
+
+}