Reworked @var support so that view files can be analysed successfully

Author: ondrejmirtes

src/Analyser/MutatingScope.php

@@ -292,7 +292,11 @@ public function enterDeclareStrictTypes(): self
 	{
 		return $this->scopeFactory->create(
 			$this->context,
-			true
+			true,
+			[],
+			null,
+			null,
+			$this->variableTypes
 		);
 	}
 

src/Analyser/NodeScopeResolver.php

@@ -336,21 +336,19 @@ private function processStmtNode(
 	): StatementResult
 	{
 		if (
-			$stmt instanceof Echo_
-			|| (
-				$stmt instanceof Node\Stmt\Expression
-				&& !$stmt->expr instanceof Assign && !$stmt->expr instanceof AssignRef
-			)
-			|| $stmt instanceof If_
-			|| $stmt instanceof While_
-			|| $stmt instanceof Switch_
-		) {
-			$scope = $this->processStmtVarAnnotation($scope, $stmt, null);
-		} elseif (
 			$stmt instanceof Throw_
 			|| $stmt instanceof Return_
 		) {
 			$scope = $this->processStmtVarAnnotation($scope, $stmt, $stmt->expr);
+		} elseif (
+			!$stmt instanceof Static_
+			&& !$stmt instanceof Foreach_
+			&& (
+				!$stmt instanceof Node\Stmt\Expression
+				|| !$stmt->expr instanceof Assign && !$stmt->expr instanceof AssignRef
+			)
+		) {
+			$scope = $this->processStmtVarAnnotation($scope, $stmt, null);
 		}
 
 		if ($stmt instanceof Node\Stmt\ClassMethod) {

src/Type/FileTypeMapper.php

@@ -202,7 +202,7 @@ private function shouldPhpDocNodeBeCachedToDisk(PhpDocNode $phpDocNode): bool
 	private function getResolvedPhpDocMap(string $fileName): array
 	{
 		if (!isset($this->memoryCache[$fileName])) {
-			$cacheKey = sprintf('%s-phpdocstring-v2', $fileName);
+			$cacheKey = sprintf('%s-phpdocstring-v3', $fileName);
 			$variableCacheKey = implode(',', array_map(static function (array $file): string {
 				return sprintf('%s-%d', $file['filename'], $file['modifiedTime']);
 			}, $this->getCachedDependentFilesWithTimestamps($fileName)));
@@ -353,12 +353,10 @@ function (\PhpParser\Node $node) use ($fileName, $lookForTrait, $traitMethodAlia
 					return null;
 				} elseif ($node instanceof \PhpParser\Node\Stmt\Namespace_) {
 					$namespace = (string) $node->name;
-					return null;
 				} elseif ($node instanceof \PhpParser\Node\Stmt\Use_ && $node->type === \PhpParser\Node\Stmt\Use_::TYPE_NORMAL) {
 					foreach ($node->uses as $use) {
 						$uses[strtolower($use->getAlias()->name)] = (string) $use->name;
 					}
-					return null;
 				} elseif ($node instanceof \PhpParser\Node\Stmt\GroupUse) {
 					$prefix = (string) $node->prefix;
 					foreach ($node->uses as $use) {
@@ -368,7 +366,6 @@ function (\PhpParser\Node $node) use ($fileName, $lookForTrait, $traitMethodAlia
 
 						$uses[strtolower($use->getAlias()->name)] = sprintf('%s\\%s', $prefix, (string) $use->name);
 					}
-					return null;
 				} elseif ($node instanceof Node\Stmt\ClassMethod) {
 					$functionName = $node->name->name;
 					if (array_key_exists($functionName, $traitMethodAliases)) {
@@ -385,22 +382,11 @@ function (\PhpParser\Node $node) use ($fileName, $lookForTrait, $traitMethodAlia
 					$resolvableTemplateTypes = true;
 				} elseif ($node instanceof Node\Stmt\Property) {
 					$resolvableTemplateTypes = true;
-				} elseif (!in_array(get_class($node), [
-					Node\Stmt\Foreach_::class,
-					Node\Expr\Assign::class,
-					Node\Expr\AssignRef::class,
-					Node\Stmt\Class_::class,
-					Node\Stmt\ClassConst::class,
-					Node\Stmt\Static_::class,
-					Node\Stmt\Echo_::class,
-					Node\Stmt\Return_::class,
-					Node\Stmt\Expression::class,
-					Node\Stmt\Throw_::class,
-					Node\Stmt\If_::class,
-					Node\Stmt\While_::class,
-					Node\Stmt\Switch_::class,
-					Node\Stmt\Nop::class,
-				], true)) {
+				} elseif (
+					!$node instanceof Node\Stmt
+					&& !$node instanceof Node\Expr\Assign
+					&& !$node instanceof Node\Expr\AssignRef
+				) {
 					return null;
 				}
 

tests/PHPStan/Analyser/NodeScopeResolverTest.php

@@ -10710,6 +10710,16 @@ public function dataBug4351(): array
 		return $this->gatherAssertTypes(__DIR__ . '/data/bug-4351.php');
 	}
 
+	public function dataVarAboveUse(): array
+	{
+		return $this->gatherAssertTypes(__DIR__ . '/data/var-above-use.php');
+	}
+
+	public function dataVarAboveDeclare(): array
+	{
+		return $this->gatherAssertTypes(__DIR__ . '/data/var-above-declare.php');
+	}
+
 	/**
 	 * @param string $file
 	 * @return array<string, mixed[]>
@@ -10917,6 +10927,8 @@ private function gatherAssertTypes(string $file): array
 	 * @dataProvider dataBug4343
 	 * @dataProvider dataImpureMethod
 	 * @dataProvider dataBug4351
+	 * @dataProvider dataVarAboveUse
+	 * @dataProvider dataVarAboveDeclare
 	 * @param string $assertType
 	 * @param string $file
 	 * @param mixed ...$args

tests/PHPStan/Analyser/data/var-above-declare.php

@@ -0,0 +1,10 @@
+<?php
+
+/**
+ * @var string $foo
+ */
+
+declare(strict_types = 1);
+
+\PHPStan\Analyser\assertVariableCertainty(\PHPStan\TrinaryLogic::createYes(), $foo);
+\PHPStan\Analyser\assertType('string', $foo);

tests/PHPStan/Analyser/data/var-above-use.php

@@ -0,0 +1,10 @@
+<?php
+
+/**
+ * @var string $foo
+ */
+
+use Foo\Bar\Baz;
+
+\PHPStan\Analyser\assertVariableCertainty(\PHPStan\TrinaryLogic::createYes(), $foo);
+\PHPStan\Analyser\assertType('string', $foo);

tests/PHPStan/Rules/PhpDoc/WrongVariableNameInVarTagRuleTest.php

@@ -90,4 +90,14 @@ public function testEmptyFileWithVarThis(): void
 		$this->analyse([__DIR__ . '/data/wrong-variable-name-var-empty-this.php'], []);
 	}
 
+	public function testAboveUse(): void
+	{
+		$this->analyse([__DIR__ . '/data/var-above-use.php'], []);
+	}
+
+	public function testAboveDeclare(): void
+	{
+		$this->analyse([__DIR__ . '/data/var-above-declare.php'], []);
+	}
+
 }

tests/PHPStan/Rules/PhpDoc/data/var-above-declare.php

@@ -0,0 +1,7 @@
+<?php
+
+/**
+ * @var string $foo
+ */
+
+declare(strict_types = 1);

tests/PHPStan/Rules/PhpDoc/data/var-above-use.php

@@ -0,0 +1,5 @@
+<?php
+
+/** @var string $foo */
+
+use Foo\Bar\Baz;