Allow to dump more than one thing (#4941)

VincentLanglet · web-flow · commit 47923edd8afc · 2026-02-16T09:29:57.000+01:00
diff --git a/src/Rules/Debug/DumpNativeTypeRule.php b/src/Rules/Debug/DumpNativeTypeRule.php
@@ -35,7 +35,8 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		if (count($node->getArgs()) === 0) {
+		$args = $node->getArgs();
+		if (count($args) === 0) {
 			return [];
 		}
 
@@ -48,14 +49,17 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		return [
-			RuleErrorBuilder::message(
+		$errors = [];
+		foreach ($args as $arg) {
+			$errors[] = RuleErrorBuilder::message(
 				sprintf(
 					'Dumped type: %s',
-					$scope->getNativeType($node->getArgs()[0]->value)->describe(VerbosityLevel::precise()),
+					$scope->getNativeType($arg->value)->describe(VerbosityLevel::precise()),
 				),
-			)->nonIgnorable()->identifier('phpstan.dumpNativeType')->build(),
-		];
+			)->nonIgnorable()->identifier('phpstan.dumpNativeType')->build();
+		}
+
+		return $errors;
 	}
 
 }
diff --git a/src/Rules/Debug/DumpPhpDocTypeRule.php b/src/Rules/Debug/DumpPhpDocTypeRule.php
@@ -35,7 +35,8 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		if (count($node->getArgs()) === 0) {
+		$args = $node->getArgs();
+		if (count($args) === 0) {
 			return [];
 		}
 
@@ -48,14 +49,17 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		return [
-			RuleErrorBuilder::message(
+		$errors = [];
+		foreach ($args as $arg) {
+			$errors[] = RuleErrorBuilder::message(
 				sprintf(
 					'Dumped type: %s',
-					$this->printer->print($scope->getType($node->getArgs()[0]->value)->toPhpDocNode()),
+					$this->printer->print($scope->getType($arg->value)->toPhpDocNode()),
 				),
-			)->nonIgnorable()->identifier('phpstan.dumpPhpDocType')->build(),
-		];
+			)->nonIgnorable()->identifier('phpstan.dumpPhpDocType')->build();
+		}
+
+		return $errors;
 	}
 
 }
diff --git a/src/Rules/Debug/DumpTypeRule.php b/src/Rules/Debug/DumpTypeRule.php
@@ -35,7 +35,8 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		if (count($node->getArgs()) === 0) {
+		$args = $node->getArgs();
+		if (count($args) === 0) {
 			return [];
 		}
 
@@ -48,14 +49,17 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		return [
-			RuleErrorBuilder::message(
+		$errors = [];
+		foreach ($args as $arg) {
+			$errors[] = RuleErrorBuilder::message(
 				sprintf(
 					'Dumped type: %s',
-					$scope->getType($node->getArgs()[0]->value)->describe(VerbosityLevel::precise()),
+					$scope->getType($arg->value)->describe(VerbosityLevel::precise()),
 				),
-			)->nonIgnorable()->identifier('phpstan.dumpType')->build(),
-		];
+			)->nonIgnorable()->identifier('phpstan.dumpType')->build();
+		}
+
+		return $errors;
 	}
 
 }
diff --git a/src/dumpType.php b/src/dumpType.php
@@ -5,35 +5,38 @@
 /**
  * @phpstan-pure
  * @param mixed $value
+ * @param mixed $values
  * @return mixed
  *
  * @throws void
  */
-function dumpType($value) // phpcs:ignore Squiz.Functions.GlobalFunction.Found
+function dumpType($value, ...$values) // phpcs:ignore Squiz.Functions.GlobalFunction.Found
 {
 	return null;
 }
 
 /**
  * @phpstan-pure
  * @param mixed $value
+ * @param mixed $values
  * @return mixed
  *
  * @throws void
  */
-function dumpNativeType($value) // phpcs:ignore Squiz.Functions.GlobalFunction.Found
+function dumpNativeType($value, ...$values) // phpcs:ignore Squiz.Functions.GlobalFunction.Found
 {
 	return null;
 }
 
 /**
  * @phpstan-pure
  * @param mixed $value
+ * @param mixed $values
  * @return mixed
  *
  * @throws void
  */
-function dumpPhpDocType($value) // phpcs:ignore Squiz.Functions.GlobalFunction.Found
+function dumpPhpDocType($value, ...$values) // phpcs:ignore Squiz.Functions.GlobalFunction.Found
 {
 	return null;
 }
diff --git a/tests/PHPStan/Rules/Debug/DumpNativeTypeRuleTest.php b/tests/PHPStan/Rules/Debug/DumpNativeTypeRuleTest.php
@@ -27,6 +27,14 @@ public function testRule(): void
 				'Dumped type: array',
 				12,
 			],
+			[
+				'Dumped type: non-empty-array',
+				14,
+			],
+			[
+				'Dumped type: array',
+				14,
+			],
 		]);
 	}
 
diff --git a/tests/PHPStan/Rules/Debug/DumpPhpDocTypeRuleTest.php b/tests/PHPStan/Rules/Debug/DumpPhpDocTypeRuleTest.php
@@ -100,6 +100,14 @@ public function testRuleSymbols(): void
 				'Dumped type: T',
 				36,
 			],
+			[
+				'Dumped type: array{1: 1}',
+				41,
+			],
+			[
+				'Dumped type: array{2: 2}',
+				41,
+			],
 		]);
 	}
 
diff --git a/tests/PHPStan/Rules/Debug/DumpTypeRuleTest.php b/tests/PHPStan/Rules/Debug/DumpTypeRuleTest.php
@@ -50,6 +50,20 @@ public function testRuleInUse(): void
 		]);
 	}
 
+	public function testRuleWithMultipleVars(): void
+	{
+		$this->analyse([__DIR__ . '/data/dump-type-variadic.php'], [
+			[
+				'Dumped type: non-empty-array',
+				10,
+			],
+			[
+				'Dumped type: array',
+				10,
+			],
+		]);
+	}
+
 	public function testBug7803(): void
 	{
 		$this->analyse([__DIR__ . '/data/bug-7803.php'], [
diff --git a/tests/PHPStan/Rules/Debug/data/dump-native-type.php b/tests/PHPStan/Rules/Debug/data/dump-native-type.php
@@ -10,4 +10,6 @@ function (array $a, array $b) {
 
 	dumpNativeType($a);
 	dumpNativeType($b);
+
+	dumpNativeType($a, $b);
 };
diff --git a/tests/PHPStan/Rules/Debug/data/dump-phpdoc-type.php b/tests/PHPStan/Rules/Debug/data/dump-phpdoc-type.php
@@ -37,3 +37,5 @@ function id($value)
 
 	return $value;
 }
+
+dumpPhpDocType([1 => 1], [2 => 2]);
diff --git a/tests/PHPStan/Rules/Debug/data/dump-type-variadic.php b/tests/PHPStan/Rules/Debug/data/dump-type-variadic.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace PHPStan;
+
+function (array $a, array $b) {
+	if ($a === []) {
+		return;
+	}
+
+	dumpType($a, $b);
+};
diff --git a/tests/PHPStan/Rules/Functions/CallToFunctionParametersRuleTest.php b/tests/PHPStan/Rules/Functions/CallToFunctionParametersRuleTest.php
@@ -2679,6 +2679,24 @@ public function testBug8936(): void
 		$this->analyse([__DIR__ . '/data/bug-8936.php'], []);
 	}
 
+	public function testDumpFunctions(): void
+	{
+		$this->analyse([__DIR__ . '/data/dump-functions.php'], [
+			[
+				'Function PHPStan\dumpType invoked with 0 parameters, at least 1 required.',
+				13,
+			],
+			[
+				'Function PHPStan\dumpNativeType invoked with 0 parameters, at least 1 required.',
+				14,
+			],
+			[
+				'Function PHPStan\dumpPhpDocType invoked with 0 parameters, at least 1 required.',
+				15,
+			],
+		]);
+	}
+
 	public function testBug14012(): void
 	{
 		$this->checkExplicitMixed = true;
diff --git a/tests/PHPStan/Rules/Functions/data/dump-functions.php b/tests/PHPStan/Rules/Functions/data/dump-functions.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace DumpFunctions;
+
+use function PHPStan\dumpType;
+use function PHPStan\dumpNativeType;
+use function PHPStan\dumpPhpdocType;
+
+class HelloWorld
+{
+	public function sayHello(): void
+	{
+		dumpType();
+		dumpNativeType();
+		dumpPhpdocType();
+
+		dumpType(1, 2, 3);
+		dumpNativeType(1, 2, 3);
+		dumpPhpdocType(1, 2, 3);
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,8 @@ public function processNode(Node $node, Scope $scope): array`
`35`	`35`	`return [];`
`36`	`36`	`}`
`37`	`37`
`38`		`- if (count($node->getArgs()) === 0) {`
	`38`	`+ $args = $node->getArgs();`
	`39`	`+ if (count($args) === 0) {`
`39`	`40`	`return [];`
`40`	`41`	`}`
`41`	`42`
`@@ -48,14 +49,17 @@ public function processNode(Node $node, Scope $scope): array`
`48`	`49`	`return [];`
`49`	`50`	`}`
`50`	`51`
`51`		`- return [`
`52`		`- RuleErrorBuilder::message(`
	`52`	`+ $errors = [];`
	`53`	`+ foreach ($args as $arg) {`
	`54`	`+ $errors[] = RuleErrorBuilder::message(`
`53`	`55`	`sprintf(`
`54`	`56`	`'Dumped type: %s',`
`55`		`- $scope->getNativeType($node->getArgs()[0]->value)->describe(VerbosityLevel::precise()),`
	`57`	`+ $scope->getNativeType($arg->value)->describe(VerbosityLevel::precise()),`
`56`	`58`	`),`
`57`		`- )->nonIgnorable()->identifier('phpstan.dumpNativeType')->build(),`
`58`		`- ];`
	`59`	`+ )->nonIgnorable()->identifier('phpstan.dumpNativeType')->build();`
	`60`	`+ }`
	`61`	`+`
	`62`	`+ return $errors;`
`59`	`63`	`}`
`60`	`64`
`61`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,35 +5,38 @@`
`5`	`5`	`/**`
`6`	`6`	`* @phpstan-pure`
`7`	`7`	`* @param mixed $value`
	`8`	`+ * @param mixed $values`
`8`	`9`	`* @return mixed`
`9`	`10`	`*`
`10`	`11`	`* @throws void`
`11`	`12`	`*/`
`12`		`-function dumpType($value) // phpcs:ignore Squiz.Functions.GlobalFunction.Found`
	`13`	`+function dumpType($value, ...$values) // phpcs:ignore Squiz.Functions.GlobalFunction.Found`
`13`	`14`	`{`
`14`	`15`	`return null;`
`15`	`16`	`}`
`16`	`17`
`17`	`18`	`/**`
`18`	`19`	`* @phpstan-pure`
`19`	`20`	`* @param mixed $value`
	`21`	`+ * @param mixed $values`
`20`	`22`	`* @return mixed`
`21`	`23`	`*`
`22`	`24`	`* @throws void`
`23`	`25`	`*/`
`24`		`-function dumpNativeType($value) // phpcs:ignore Squiz.Functions.GlobalFunction.Found`
	`26`	`+function dumpNativeType($value, ...$values) // phpcs:ignore Squiz.Functions.GlobalFunction.Found`
`25`	`27`	`{`
`26`	`28`	`return null;`
`27`	`29`	`}`
`28`	`30`
`29`	`31`	`/**`
`30`	`32`	`* @phpstan-pure`
`31`	`33`	`* @param mixed $value`
	`34`	`+ * @param mixed $values`
`32`	`35`	`* @return mixed`
`33`	`36`	`*`
`34`	`37`	`* @throws void`
`35`	`38`	`*/`
`36`		`-function dumpPhpDocType($value) // phpcs:ignore Squiz.Functions.GlobalFunction.Found`
	`39`	`+function dumpPhpDocType($value, ...$values) // phpcs:ignore Squiz.Functions.GlobalFunction.Found`
`37`	`40`	`{`
`38`	`41`	`return null;`
`39`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,3 +37,5 @@ function id($value)`
`37`	`37`
`38`	`38`	`return $value;`
`39`	`39`	`}`
	`40`	`+`
	`41`	`+dumpPhpDocType([1 => 1], [2 => 2]);`