Fixes parse_url return type when $component is -1 returning more type…

…s than were valid. Adds missing types when $component is not a constant value.
phpstan · May 30, 2024 · 1ebcae0 · 1ebcae0
1 parent 5422c7a
commit 1ebcae0
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 12 deletions.
diff --git a/src/Type/Php/ParseUrlFunctionDynamicReturnTypeExtension.php b/src/Type/Php/ParseUrlFunctionDynamicReturnTypeExtension.php
@@ -86,7 +86,7 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
 		}
 
 		if ($componentType->getValue() === -1) {
-			return $this->createAllComponentsReturnType();
+			return TypeCombinator::union($this->createComponentsArray(), new ConstantBooleanType(false));
 		}
 
 		return $this->componentTypesPairedConstants[$componentType->getValue()] ?? new ConstantBooleanType(false);
@@ -97,24 +97,31 @@ private function createAllComponentsReturnType(): Type
 		if ($this->allComponentsTogetherType === null) {
 			$returnTypes = [
 				new ConstantBooleanType(false),
+				new NullType(),
+				IntegerRangeType::fromInterval(0, 65535),
+				new StringType(),
+				$this->createComponentsArray(),
 			];
 
-			$builder = ConstantArrayTypeBuilder::createEmpty();
+			$this->allComponentsTogetherType = TypeCombinator::union(...$returnTypes);
+		}
 
-			if ($this->componentTypesPairedStrings === null) {
-				throw new ShouldNotHappenException();
-			}
+		return $this->allComponentsTogetherType;
+	}
 
-			foreach ($this->componentTypesPairedStrings as $componentName => $componentValueType) {
-				$builder->setOffsetValueType(new ConstantStringType($componentName), $componentValueType, true);
-			}
+	private function createComponentsArray(): Type
+	{
+			$builder = ConstantArrayTypeBuilder::createEmpty();
 
-			$returnTypes[] = $builder->getArray();
+		if ($this->componentTypesPairedStrings === null) {
+			throw new ShouldNotHappenException();
+		}
 
-			$this->allComponentsTogetherType = TypeCombinator::union(...$returnTypes);
+		foreach ($this->componentTypesPairedStrings as $componentName => $componentValueType) {
+			$builder->setOffsetValueType(new ConstantStringType($componentName), $componentValueType, true);
 		}
 
-		return $this->allComponentsTogetherType;
+			return $builder->getArray();
 	}
 
 	private function cacheReturnTypes(): void

diff --git a/tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php b/tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php
@@ -5500,7 +5500,7 @@ public function dataFunctions(): array
 				'$parseUrlConstantUrlWithoutComponent2',
 			],
 			[
-				'array{scheme?: string, host?: string, port?: int<0, 65535>, user?: string, pass?: string, path?: string, query?: string, fragment?: string}|false',
+				'array{scheme?: string, host?: string, port?: int<0, 65535>, user?: string, pass?: string, path?: string, query?: string, fragment?: string}|int<0, 65535>|string|false|null',
 				'$parseUrlConstantUrlUnknownComponent',
 			],
 			[

diff --git a/tests/PHPStan/Analyser/NodeScopeResolverTest.php b/tests/PHPStan/Analyser/NodeScopeResolverTest.php
@@ -1485,6 +1485,7 @@ public function dataFileAsserts(): iterable
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-10952b.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/case-insensitive-parent.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-10893.php');
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-4754.php');
 	}
 
 	/**

diff --git a/tests/PHPStan/Analyser/data/bug-4754.php b/tests/PHPStan/Analyser/data/bug-4754.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace Bug4754;
+
+use function PHPStan\Testing\assertType;
+
+/**
+ * The standard PHP parse_url() function doesn't work with relative URI's only absolute URL's
+ * so this function works around that by adding a http://domain prefix
+ * if needed and passing through the results
+ *
+ * @param string $url
+ * @param int	 $component
+ *
+ * @return string|int|array|bool|null
+ */
+function parseUrl($url, $component = -1)
+{
+	$parsedComponentNotSpecified = parse_url($url);
+	$parsedNotConstant = parse_url($url, $component);
+	$parsedAllConstant = parse_url($url, -1);
+	$parsedSchemeConstant = parse_url($url, PHP_URL_SCHEME);
+	$parsedHostConstant = parse_url($url, PHP_URL_HOST);
+	$parsedPortConstant = parse_url($url, PHP_URL_PORT);
+	$parsedUserConstant = parse_url($url, PHP_URL_USER);
+	$parsedPassConstant = parse_url($url, PHP_URL_PASS);
+	$parsedPathConstant = parse_url($url, PHP_URL_PATH);
+	$parsedQueryConstant = parse_url($url, PHP_URL_QUERY);
+	$parsedFragmentConstant = parse_url($url, PHP_URL_FRAGMENT);
+
+	assertType('array{scheme?: string, host?: string, port?: int<0, 65535>, user?: string, pass?: string, path?: string, query?: string, fragment?: string}|false', $parsedComponentNotSpecified);
+	assertType('array{scheme?: string, host?: string, port?: int<0, 65535>, user?: string, pass?: string, path?: string, query?: string, fragment?: string}|int<0, 65535>|string|false|null', $parsedNotConstant);
+	assertType('array{scheme?: string, host?: string, port?: int<0, 65535>, user?: string, pass?: string, path?: string, query?: string, fragment?: string}|false', $parsedAllConstant);
+	assertType('string|false|null', $parsedSchemeConstant);
+	assertType('string|false|null', $parsedHostConstant);
+	assertType('int<0, 65535>|false|null', $parsedPortConstant);
+	assertType('string|false|null', $parsedUserConstant);
+	assertType('string|false|null', $parsedPassConstant);
+	assertType('string|false|null', $parsedPathConstant);
+	assertType('string|false|null', $parsedQueryConstant);
+	assertType('string|false|null', $parsedFragmentConstant);
+}