Getenv

Author: VincentLanglet

conf/config.neon

@@ -1541,6 +1541,11 @@ services:
 		tags:
 			- phpstan.broker.dynamicFunctionReturnTypeExtension
 
+	-
+		class: PHPStan\Type\Php\GetenvFunctionReturnTypeExtension
+		tags:
+			- phpstan.broker.dynamicFunctionReturnTypeExtension
+
 	-
 		class: PHPStan\Type\Php\GetParentClassDynamicFunctionReturnTypeExtension
 		tags:

resources/functionMap_php80delta.php

@@ -78,6 +78,8 @@
 		'imagejpeg' => ['bool', 'im'=>'GdImage', 'filename='=>'string|resource|null', 'quality='=>'int'],
 		'imagerotate' => ['false|object', 'src_im'=>'resource', 'angle'=>'float', 'bgdcolor'=>'int', 'ignoretransparent='=>'int'],
 		'imagescale' => ['false|object', 'im'=>'resource', 'new_width'=>'int', 'new_height='=>'int', 'method='=>'int'],
+		'getenv' => ['array<string, string>|string|false', 'varname'=>'string|null', 'local_only='=>'bool'],
+		'getenv\'1' => ['array<string, string>'],
 		'ldap_set_rebind_proc' => ['bool', 'ldap'=>'resource', 'callback'=>'?callable'],
 		'mb_decode_numericentity' => ['string|false', 'string'=>'string', 'convmap'=>'array', 'encoding='=>'string'],
 		'mb_encoding_aliases' => ['list<non-falsy-string>', 'encoding'=>'string'],

src/Php/PhpVersion.php

@@ -353,4 +353,9 @@ public function substrReturnFalseInsteadOfEmptyString(): bool
 		return $this->versionId < 80000;
 	}
 
+	public function getenvAcceptsNull(): bool
+	{
+		return $this->versionId >= 80000;
+	}
+
 }

src/Type/Php/GetenvFunctionReturnTypeExtension.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Php;
+
+use PhpParser\Node\Expr\FuncCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Php\PhpVersion;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\Constant\ConstantBooleanType;
+use PHPStan\Type\DynamicFunctionReturnTypeExtension;
+use PHPStan\Type\StringType;
+use PHPStan\Type\Type;
+use PHPStan\Type\UnionType;
+
+final class GetenvFunctionReturnTypeExtension implements DynamicFunctionReturnTypeExtension
+{
+	public function __construct(private PhpVersion $phpVersion)
+	{
+	}
+
+	public function isFunctionSupported(FunctionReflection $functionReflection): bool
+	{
+		return $functionReflection->getName() === 'getenv';
+	}
+
+	public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): ?Type
+	{
+		if (!$this->phpVersion->getenvAcceptsNull()) {
+			return null;
+		}
+		if (count($functionCall->getArgs()) < 1) {
+			return null;
+		}
+
+		$argType = $scope->getType($functionCall->getArgs()[0]->value);
+		if ($argType->isNull()->yes()) {
+			return new ArrayType(new StringType(), new StringType());
+		}
+		if ($argType->isNull()->no()) {
+			return new UnionType([new StringType(), new ConstantBooleanType(false)]);
+		}
+
+		return null;
+	}
+
+}

tests/PHPStan/Analyser/NodeScopeResolverTest.php

@@ -57,6 +57,12 @@ private static function findTestFiles(): iterable
 			yield __DIR__ . '/data/explode-php80.php';
 		}
 
+		if (PHP_VERSION_ID < 80000) {
+			yield __DIR__ . '/data/getenv-php74.php';
+		} else {
+			yield __DIR__ . '/data/getenv-php80.php';
+		}
+
 		if (PHP_VERSION_ID >= 80000) {
 			yield __DIR__ . '/../Reflection/data/unionTypes.php';
 			yield __DIR__ . '/../Reflection/data/mixedType.php';

tests/PHPStan/Analyser/data/getenv-php74.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace GetenvPHP74;
+
+use function PHPStan\Testing\assertType;
+
+class Foo
+{
+
+	public function test()
+	{
+		assertType('TODO', getenv(null));
+		assertType('array<string, string>', getenv());
+		assertType('string|false', getenv('foo'));
+	}
+
+}

tests/PHPStan/Analyser/data/getenv-php80.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace GetenvPHP80;
+
+use function PHPStan\Testing\assertType;
+
+class Foo
+{
+
+	public function test()
+	{
+		assertType('array<string, string>', getenv(null));
+		assertType('array<string, string>', getenv());
+		assertType('string|false', getenv('foo'));
+	}
+
+}