Use a dedicated virtual node

Author: cedric-anne

src/Analyser/MutatingScope.php

@@ -37,6 +37,7 @@
 use PHPStan\Node\Expr\GetIterableKeyTypeExpr;
 use PHPStan\Node\Expr\GetIterableValueTypeExpr;
 use PHPStan\Node\Expr\GetOffsetValueTypeExpr;
+use PHPStan\Node\Expr\GlobalVariableExpr;
 use PHPStan\Node\Expr\NativeTypeExpr;
 use PHPStan\Node\Expr\OriginalPropertyTypeExpr;
 use PHPStan\Node\Expr\ParameterVariableOriginalValueExpr;
@@ -179,8 +180,6 @@ final class MutatingScope implements Scope
 
 private const KEEP_VOID_ATTRIBUTE_NAME = 'keepVoid';
 
-private const IS_GLOBAL_ATTRIBUTE_NAME = 'isGlobal';
-
 /** @var Type[] */
 private array $resolvedTypes = [];
 
@@ -618,12 +617,8 @@ public function isGlobalVariable(string $variableName): bool
 return true;
 }
 
-$varExprString = '$' . $variableName;
-if (!isset($this->expressionTypes[$varExprString])) {
-return false;
-}
-
-return $this->expressionTypes[$varExprString]->getExpr()->getAttribute(self::IS_GLOBAL_ATTRIBUTE_NAME) === true;
+$globalVariableExprString = $this->getNodeKey(new GlobalVariableExpr(new Variable($variableName)));
+return array_key_exists($globalVariableExprString, $this->expressionTypes);
 }
 
 /** @api */
@@ -824,6 +819,10 @@ public function getType(Expr $node): Type
 return $propertyReflection->getReadableType();
 }
 
+if ($node instanceof GlobalVariableExpr) {
+return $this->getType($node->getVar());
+}
+
 $key = $this->getNodeKey($node);
 
 if (!array_key_exists($key, $this->resolvedTypes)) {
@@ -4221,13 +4220,9 @@ public function isUndefinedExpressionAllowed(Expr $expr): bool
 return array_key_exists($exprString, $this->currentlyAllowedUndefinedExpressions);
 }
 
-public function assignVariable(string $variableName, Type $type, Type $nativeType, TrinaryLogic $certainty, bool $isGlobal = false): self
+public function assignVariable(string $variableName, Type $type, Type $nativeType, TrinaryLogic $certainty): 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();
@@ -4330,6 +4325,17 @@ public function specifyExpressionType(Expr $expr, Type $type, Type $nativeType,
 }
 }
 
+if ($expr instanceof GlobalVariableExpr) {
+foreach ($this->expressionTypeResolverExtensionRegistry->getExtensions() as $extension) {
+$typeFromExtension = $extension->getType($expr, $this);
+if ($typeFromExtension !== null) {
+$type = $typeFromExtension;
+break;
+}
+}
+$scope = $scope->specifyExpressionType($expr->getVar(), $type, $nativeType, $certainty);
+}
+
 if ($certainty->no()) {
 throw new ShouldNotHappenException();
 }

src/Analyser/NodeScopeResolver.php

@@ -89,6 +89,7 @@
 use PHPStan\Node\Expr\GetIterableKeyTypeExpr;
 use PHPStan\Node\Expr\GetIterableValueTypeExpr;
 use PHPStan\Node\Expr\GetOffsetValueTypeExpr;
+use PHPStan\Node\Expr\GlobalVariableExpr;
 use PHPStan\Node\Expr\NativeTypeExpr;
 use PHPStan\Node\Expr\OriginalPropertyTypeExpr;
 use PHPStan\Node\Expr\PropertyInitializationExpr;
@@ -1976,7 +1977,7 @@ static function (Node $node, Scope $scope) use ($nodeCallback): void {
 continue;
 }
 
-$scope = $scope->assignVariable($var->name, new MixedType(), new MixedType(), TrinaryLogic::createYes(), true);
+$scope = $scope->assignExpression(new GlobalVariableExpr($var), new MixedType(), new MixedType());
 $vars[] = $var->name;
 }
 $scope = $this->processVarAnnotation($scope, $vars, $stmt);

src/Node/Expr/GlobalVariableExpr.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Node\Expr;
+
+use Override;
+use PhpParser\Node\Expr;
+use PHPStan\Node\VirtualNode;
+
+final class GlobalVariableExpr extends Expr implements VirtualNode
+{
+
+public function __construct(private Expr $var)
+{
+parent::__construct([]);
+}
+
+public function getVar(): Expr
+{
+return $this->var;
+}
+
+#[Override]
+public function getType(): string
+{
+return 'PHPStan_Node_GlobalVariableExpr';
+}
+
+/**
+ * @return string[]
+ */
+#[Override]
+public function getSubNodeNames(): array
+{
+return [];
+}
+
+}

src/Node/Printer/Printer.php

@@ -9,6 +9,7 @@
 use PHPStan\Node\Expr\GetIterableKeyTypeExpr;
 use PHPStan\Node\Expr\GetIterableValueTypeExpr;
 use PHPStan\Node\Expr\GetOffsetValueTypeExpr;
+use PHPStan\Node\Expr\GlobalVariableExpr;
 use PHPStan\Node\Expr\NativeTypeExpr;
 use PHPStan\Node\Expr\OriginalPropertyTypeExpr;
 use PHPStan\Node\Expr\ParameterVariableOriginalValueExpr;
@@ -98,4 +99,9 @@ protected function pPHPStan_Node_IssetExpr(IssetExpr $expr): string // phpcs:ign
 return sprintf('__phpstanIssetExpr(%s)', $this->p($expr->getExpr()));
 }
 
+protected function pPHPStan_Node_GlobalVariableExpr(GlobalVariableExpr $expr): string // phpcs:ignore
+{
+return sprintf('__phpstanGlobalVariable(%s)', $this->p($expr->getVar()));
+}
+
 }

tests/PHPStan/Analyser/ExpressionTypeResolverExtensionTest.php

@@ -10,7 +10,8 @@ class ExpressionTypeResolverExtensionTest extends TypeInferenceTestCase
 
 public static function dataFileAsserts(): iterable
 {
-yield from self::gatherAssertTypes(__DIR__ . '/data/expression-type-resolver-extension.php');
+yield from self::gatherAssertTypes(__DIR__ . '/data/expression-type-resolver-extension-method-call-returns-bool.php');
+yield from self::gatherAssertTypes(__DIR__ . '/data/expression-type-resolver-extension-global-statement.php');
 }
 
 /**

tests/PHPStan/Analyser/data/GlobalExpressionTypeResolverExtension.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace ExpressionTypeResolverExtension;
+
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\Expr\GlobalVariableExpr;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\BenevolentUnionType;
+use PHPStan\Type\BooleanType;
+use PHPStan\Type\ExpressionTypeResolverExtension;
+use PHPStan\Type\IntegerType;
+use PHPStan\Type\MixedType;
+use PHPStan\Type\StringType;
+use PHPStan\Type\Type;
+use PhpParser\Node\Expr;
+
+class GlobalExpressionTypeResolverExtension implements ExpressionTypeResolverExtension {
+
+public function getType(Expr $expr, Scope $scope): ?Type
+{
+
+if (!$expr instanceof GlobalVariableExpr) {
+return null;
+}
+
+$variableName = $expr->getVar()->name;
+
+if ($variableName === 'MY_GLOBAL_BOOL') {
+return new BooleanType();
+}
+
+if ($variableName === 'MY_GLOBAL_INT') {
+return new IntegerType();
+}
+
+if ($variableName === 'MY_GLOBAL_STR') {
+return new StringType();
+}
+
+if ($variableName === 'MY_GLOBAL_ARRAY') {
+return new ArrayType(new BenevolentUnionType([new IntegerType(), new StringType()]), new MixedType(true));
+}
+
+return null;
+}
+
+}

tests/PHPStan/Analyser/data/expression-type-resolver-extension-global-statement.php

@@ -0,0 +1,32 @@
+<?php
+
+// test file for ExpressionTypeResolverExtensionTest
+
+use function PHPStan\Testing\assertType;
+
+global $MY_GLOBAL_BOOL, $ANOTHER_GLOBAL;
+
+assertType('bool', $MY_GLOBAL_BOOL);
+assertType('mixed', $MY_GLOBAL_INT); // not declared in the global statement = no type assigned
+assertType('mixed', $ANOTHER_GLOBAL);
+
+$testFct = function ($MY_GLOBAL_BOOL) {
+/** @var float $MY_GLOBAL_STR */
+global $MY_GLOBAL_INT, $MY_GLOBAL_STR, $MY_GLOBAL_ARRAY;
+
+$MY_GLOBAL_ARRAY = new ArrayIterator([1, 2, 3]);
+
+assertType('mixed', $MY_GLOBAL_BOOL); // not declared in the global statement = no type assigned
+assertType('float', $MY_GLOBAL_STR); // overriden by PHPDoc
+assertType('ArrayIterator<int, int>', $MY_GLOBAL_ARRAY); // overriden by value assign expression
+assertType('int', $MY_GLOBAL_INT);
+};
+
+$testClass = new class () {
+public function foo($MY_GLOBAL_INT) {
+global $MY_GLOBAL_STR;
+
+assertType('string', $MY_GLOBAL_STR);
+assertType('mixed', $MY_GLOBAL_INT);
+}
+};

tests/PHPStan/Analyser/data/expression-type-resolver-extension.php renamed to tests/PHPStan/Analyser/data/expression-type-resolver-extension-method-call-returns-bool.php

@@ -1,5 +1,9 @@
 # config for ExpressionTypeResolverExtensionTest
 services:
+-
+class: ExpressionTypeResolverExtension\GlobalExpressionTypeResolverExtension
+tags:
+- phpstan.broker.expressionTypeResolverExtension
 -
 class: ExpressionTypeResolverExtension\MethodCallReturnsBoolExpressionTypeResolverExtension
 tags: