Fix parse_str issue

VincentLanglet · VincentLanglet · commit 38151b7667d2 · 2024-11-18T23:29:57.000+01:00
diff --git a/conf/config.neon b/conf/config.neon
@@ -1574,6 +1574,11 @@ services:
 		tags:
 			- phpstan.functionParameterOutTypeExtension
 
+	-
+		class: PHPStan\Type\Php\ParseStrParameterOutTypeExtension
+		tags:
+			- phpstan.functionParameterOutTypeExtension
+
 	-
 		class: PHPStan\Type\Php\PregReplaceCallbackClosureTypeExtension
 		tags:
diff --git a/src/Type/Php/ParseStrParameterOutTypeExtension.php b/src/Type/Php/ParseStrParameterOutTypeExtension.php
@@ -0,0 +1,59 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Php;
+
+use PhpParser\Node\Expr\FuncCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Reflection\ParameterReflection;
+use PHPStan\Type\Accessory\AccessoryLowercaseStringType;
+use PHPStan\Type\Accessory\AccessoryUppercaseStringType;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\FunctionParameterOutTypeExtension;
+use PHPStan\Type\IntegerType;
+use PHPStan\Type\IntersectionType;
+use PHPStan\Type\MixedType;
+use PHPStan\Type\StringType;
+use PHPStan\Type\Type;
+use PHPStan\Type\UnionType;
+
+use function in_array;
+use function strtolower;
+
+final class ParseStrParameterOutTypeExtension implements FunctionParameterOutTypeExtension
+{
+
+	public function isFunctionSupported(FunctionReflection $functionReflection, ParameterReflection $parameter): bool
+	{
+		return in_array(strtolower($functionReflection->getName()), ['parse_str', 'mb_parse_str'], true)
+			&& $parameter->getName() === 'result';
+	}
+
+	public function getParameterOutTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $funcCall, ParameterReflection $parameter, Scope $scope): ?Type
+	{
+		$args = $funcCall->getArgs();
+		if (count($args) < 1) {
+			return null;
+		}
+
+		$stringType = $scope->getType($args[0]->value);
+		$accessory = [];
+		if ($stringType->isLowercaseString()->yes()) {
+			$accessory[] = new AccessoryLowercaseStringType();
+		}
+		if ($stringType->isUppercaseString()->yes()) {
+			$accessory[] = new AccessoryUppercaseStringType();
+		}
+		if (count($accessory) > 0) {
+			$valueType = new IntersectionType([new StringType(), ...$accessory]);
+		} else {
+			$valueType = new StringType();
+		}
+
+		return new ArrayType(
+			new UnionType([new StringType(), new IntegerType()]),
+			new UnionType([new ArrayType(new MixedType(), new MixedType()), $valueType]),
+		);
+	}
+
+}
diff --git a/stubs/core.stub b/stubs/core.stub
@@ -69,22 +69,13 @@ function str_shuffle(string $string): string {}
 
 /**
  * @param array<mixed> $result
- * @param-out ($string is lowercase-string&uppercase-string
- * 		? array<int|string, array<mixed>|(lowercase-string&uppercase-string)>
- * 		: ($string is lowercase-string
- *     		? array<int|string, array<mixed>|lowercase-string>
- *     		: ($string is uppercase-string
- *    			? array<int|string, array<mixed>|uppercase-string>
- *         		: array<int|string, array<mixed>|string>
- *     		)
- * 		)
- * 	) $result
+ * @param-out array<int|string, array<mixed>|string> $result
  */
 function parse_str(string $string, array &$result): void {}
 
 /**
  * @param array<mixed> $result
- * @param-out array<string, array<mixed>|string> $result
+ * @param-out array<int|string, array<mixed>|string> $result
  */
 function mb_parse_str(string $string, array &$result): bool {}
 
