Indicates whether a variable is global

Author: cedric-anne

src/Analyser/MutatingScope.php

@@ -182,6 +182,8 @@ final class MutatingScope implements Scope, NodeCallbackInvoker
 
 	private const KEEP_VOID_ATTRIBUTE_NAME = 'keepVoid';
 
+	private const IS_GLOBAL_ATTRIBUTE_NAME = 'isGlobal';
+
 	/** @var Type[] */
 	private array $resolvedTypes = [];
 
@@ -619,10 +621,25 @@ public function afterOpenSslCall(string $openSslFunctionName): self
 		);
 	}
 
+	/** @api */
+	public function isGlobalVariable(string $variableName): bool
+	{
+		if ($this->isSuperglobalVariable($variableName)) {
+			return true;
+		}
+
+		$varExprString = '$' . $variableName;
+		if (!isset($this->expressionTypes[$varExprString])) {
+			return false;
+		}
+
+		return $this->expressionTypes[$varExprString]->getExpr()->getAttribute(self::IS_GLOBAL_ATTRIBUTE_NAME) === true;
+	}
+
 	/** @api */
 	public function hasVariableType(string $variableName): TrinaryLogic
 	{
-		if ($this->isGlobalVariable($variableName)) {
+		if ($this->isSuperglobalVariable($variableName)) {
 			return TrinaryLogic::createYes();
 		}
 
@@ -663,7 +680,7 @@ public function getVariableType(string $variableName): Type
 
 		$varExprString = '$' . $variableName;
 		if (!array_key_exists($varExprString, $this->expressionTypes)) {
-			if ($this->isGlobalVariable($variableName)) {
+			if ($this->isSuperglobalVariable($variableName)) {
 				return new ArrayType(new BenevolentUnionType([new IntegerType(), new StringType()]), new MixedType(true));
 			}
 			return new MixedType();
@@ -714,7 +731,7 @@ public function getMaybeDefinedVariables(): array
 		return $variables;
 	}
 
-	private function isGlobalVariable(string $variableName): bool
+	private function isSuperglobalVariable(string $variableName): bool
 	{
 		return in_array($variableName, self::SUPERGLOBAL_VARIABLES, true);
 	}
@@ -4292,9 +4309,13 @@ public function isUndefinedExpressionAllowed(Expr $expr): bool
 		return array_key_exists($exprString, $this->currentlyAllowedUndefinedExpressions);
 	}
 
-	public function assignVariable(string $variableName, Type $type, Type $nativeType, TrinaryLogic $certainty): self
+	public function assignVariable(string $variableName, Type $type, Type $nativeType, TrinaryLogic $certainty, bool $isGlobal = false): self
 	{
 		$node = new Variable($variableName);
+		if ($isGlobal || $this->isGlobalVariable($variableName)) {
+			$node->setAttribute(self::IS_GLOBAL_ATTRIBUTE_NAME, true);
+		}
+
 		$scope = $this->assignExpression($node, $type, $nativeType);
 		if ($certainty->no()) {
 			throw new ShouldNotHappenException();
@@ -5079,7 +5100,7 @@ private function createConditionalExpressions(
 	private function mergeVariableHolders(array $ourVariableTypeHolders, array $theirVariableTypeHolders): array
 	{
 		$intersectedVariableTypeHolders = [];
-		$globalVariableCallback = fn (Node $node) => $node instanceof Variable && is_string($node->name) && $this->isGlobalVariable($node->name);
+		$globalVariableCallback = fn (Node $node) => $node instanceof Variable && is_string($node->name) && $this->isSuperglobalVariable($node->name);
 		$nodeFinder = new NodeFinder();
 		foreach ($ourVariableTypeHolders as $exprString => $variableTypeHolder) {
 			if (isset($theirVariableTypeHolders[$exprString])) {

src/Analyser/NodeScopeResolver.php

@@ -1978,7 +1978,7 @@ public function leaveNode(Node $node): ?ExistingArrayDimFetch
 					continue;
 				}
 
-				$scope = $scope->assignVariable($var->name, new MixedType(), new MixedType(), TrinaryLogic::createYes());
+				$scope = $scope->assignVariable($var->name, new MixedType(), new MixedType(), TrinaryLogic::createYes(), true);
 				$vars[] = $var->name;
 			}
 			$scope = $this->processVarAnnotation($scope, $vars, $stmt);

src/Analyser/Scope.php

@@ -57,6 +57,8 @@ public function getFunctionName(): ?string;
 
 	public function getParentScope(): ?self;
 
+	public function isGlobalVariable(string $variableName): bool;
+
 	public function hasVariableType(string $variableName): TrinaryLogic;
 
 	public function getVariableType(string $variableName): Type;

tests/PHPStan/Analyser/GlobalVariableTest.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Return_;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+class GlobalVariableTest extends TypeInferenceTestCase
+{
+
+	public function testGlobalVariableInScript(): void
+	{
+		self::processFile(__DIR__ . '/data/global-in-script.php', function (Node $node, Scope $scope): void {
+			if (!($node instanceof Return_)) {
+				return;
+			}
+
+			$this->assertTrue($scope->isGlobalVariable('FOO'));
+			$this->assertFalse($scope->isGlobalVariable('whatever'));
+		});
+	}
+
+	public function testGlobalVariableInFunction(): void
+	{
+		self::processFile(__DIR__ . '/data/global-in-function.php', function (Node $node, Scope $scope): void {
+			if (!($node instanceof Return_)) {
+				return;
+			}
+
+			$this->assertFalse($scope->isGlobalVariable('BAR'));
+			$this->assertTrue($scope->isGlobalVariable('CONFIG'));
+			$this->assertFalse($scope->isGlobalVariable('localVar'));
+		});
+	}
+
+	public function testGlobalVariableInClassMethod(): void
+	{
+		self::processFile(__DIR__ . '/data/global-in-class-method.php', function (Node $node, Scope $scope): void {
+			if (!($node instanceof Return_)) {
+				return;
+			}
+
+			$this->assertFalse($scope->isGlobalVariable('count'));
+			$this->assertTrue($scope->isGlobalVariable('GLB_A'));
+			$this->assertTrue($scope->isGlobalVariable('GLB_B'));
+			$this->assertFalse($scope->isGlobalVariable('key'));
+			$this->assertFalse($scope->isGlobalVariable('step'));
+		});
+	}
+
+}

tests/PHPStan/Analyser/data/global-in-class-method.php

@@ -0,0 +1,16 @@
+<?php
+
+class ClassForGlobalTest
+{
+
+	public function doSomething(int $count = 3): bool
+	{
+		global $GLB_A, $GLB_B;
+
+		foreach ([1, 2, 3] as $key => $step) {
+			break;
+		}
+
+		return false;
+	}
+}

tests/PHPStan/Analyser/data/global-in-function.php

@@ -0,0 +1,12 @@
+<?php
+
+global $BAR;
+
+function globalTest(string $BAR): void
+{
+	global $CONFIG;
+
+	$localVar = true;
+
+	return;
+}

tests/PHPStan/Analyser/data/global-in-script.php

@@ -0,0 +1,8 @@
+<?php
+
+global $FOO;
+
+$FOO = "bar";
+$whatever = 15;
+
+return;