Detect void parameter typehint

ondrejmirtes · ondrejmirtes · commit 5d76184343c7 · 2020-06-03T13:31:15.000+02:00
diff --git a/src/Rules/FunctionDefinitionCheck.php b/src/Rules/FunctionDefinitionCheck.php
@@ -18,6 +18,7 @@
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Type\NonexistentParentClassType;
 use PHPStan\Type\VerbosityLevel;
+use PHPStan\Type\VoidType;
 
 class FunctionDefinitionCheck
 {
@@ -87,12 +88,15 @@ public function checkAnonymousFunction(
 			if ($param->type === null) {
 				continue;
 			}
+			if (!$param->var instanceof Variable || !is_string($param->var->name)) {
+				throw new \PHPStan\ShouldNotHappenException();
+			}
 			$type = $scope->getFunctionType($param->type, false, $param->variadic);
+			if ($type instanceof VoidType) {
+				$errors[] = RuleErrorBuilder::message(sprintf($parameterMessage, $param->var->name, 'void'))->line($param->type->getLine())->nonIgnorable()->build();
+			}
 			foreach ($type->getReferencedClasses() as $class) {
 				if (!$this->reflectionProvider->hasClass($class) || $this->reflectionProvider->getClass($class)->isTrait()) {
-					if (!$param->var instanceof Variable || !is_string($param->var->name)) {
-						throw new \PHPStan\ShouldNotHappenException();
-					}
 					$errors[] = RuleErrorBuilder::message(sprintf($parameterMessage, $param->var->name, $class))->line($param->type->getLine())->build();
 				} elseif ($this->checkClassCaseSensitivity) {
 					$errors = array_merge(
@@ -178,6 +182,16 @@ private function checkParametersAcceptor(
 
 				return $parameterNode;
 			};
+			if (
+				$parameter instanceof ParameterReflectionWithPhpDocs
+				&& $parameter->getNativeType() instanceof VoidType
+			) {
+				$parameterVar = $parameterNodeCallback()->var;
+				if (!$parameterVar instanceof Variable || !is_string($parameterVar->name)) {
+					throw new \PHPStan\ShouldNotHappenException();
+				}
+				$errors[] = RuleErrorBuilder::message(sprintf($parameterMessage, $parameterVar->name, 'void'))->line($parameterNodeCallback()->getLine())->nonIgnorable()->build();
+			}
 			foreach ($referencedClasses as $class) {
 				if ($this->reflectionProvider->hasClass($class) && !$this->reflectionProvider->getClass($class)->isTrait()) {
 					continue;
diff --git a/tests/PHPStan/Rules/Functions/ExistingClassesInClosureTypehintsRuleTest.php b/tests/PHPStan/Rules/Functions/ExistingClassesInClosureTypehintsRuleTest.php
@@ -69,4 +69,17 @@ public function testValidTypehintPhp72(): void
 		$this->analyse([__DIR__ . '/data/closure-7.2-typehints.php'], []);
 	}
 
+	public function testVoidParameterTypehint(): void
+	{
+		if (!self::$useStaticReflectionProvider) {
+			$this->markTestSkipped('Test requires static reflection');
+		}
+		$this->analyse([__DIR__ . '/data/void-parameter-typehint.php'], [
+			[
+				'Parameter $param of anonymous function has invalid typehint type void.',
+				5,
+			],
+		]);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Functions/ExistingClassesInTypehintsRuleTest.php b/tests/PHPStan/Rules/Functions/ExistingClassesInTypehintsRuleTest.php
@@ -143,4 +143,17 @@ public function testWithoutNamespace(): void
 		]);
 	}
 
+	public function testVoidParameterTypehint(): void
+	{
+		if (!self::$useStaticReflectionProvider) {
+			$this->markTestSkipped('Test requires static reflection');
+		}
+		$this->analyse([__DIR__ . '/data/void-parameter-typehint.php'], [
+			[
+				'Parameter $param of function VoidParameterTypehint\doFoo() has invalid typehint type void.',
+				9,
+			],
+		]);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Functions/data/void-parameter-typehint.php b/tests/PHPStan/Rules/Functions/data/void-parameter-typehint.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace VoidParameterTypehint;
+
+function (void $param): int {
+	return 1;
+};
+
+function doFoo(void $param): int
+{
+	return 1;
+}
diff --git a/tests/PHPStan/Rules/Methods/ExistingClassesInTypehintsRuleTest.php b/tests/PHPStan/Rules/Methods/ExistingClassesInTypehintsRuleTest.php
@@ -128,4 +128,17 @@ public function testExistingClassInIterableTypehint(): void
 		]);
 	}
 
+	public function testVoidParameterTypehint(): void
+	{
+		if (!self::$useStaticReflectionProvider) {
+			$this->markTestSkipped('Test requires static reflection');
+		}
+		$this->analyse([__DIR__ . '/data/void-parameter-typehint.php'], [
+			[
+				'Parameter $param of method VoidParameterTypehintMethod\Foo::doFoo() has invalid typehint type void.',
+				8,
+			],
+		]);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Methods/data/void-parameter-typehint.php b/tests/PHPStan/Rules/Methods/data/void-parameter-typehint.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace VoidParameterTypehintMethod;
+
+class Foo
+{
+
+	public function doFoo(void $param): int
+	{
+		return 1;
+	}
+
+}
