Support array and offset access on const types

phpstan · May 6, 2024 · 536889f · 536889f
1 parent 9bb3855
commit 536889f
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 11 deletions.
diff --git a/src/Ast/Type/OffsetAccessTypeNode.php b/src/Ast/Type/OffsetAccessTypeNode.php
@@ -25,7 +25,6 @@ public function __toString(): string
 	{
 		if (
 			$this->type instanceof CallableTypeNode
-			|| $this->type instanceof ConstTypeNode
 			|| $this->type instanceof NullableTypeNode
 		) {
 			return '(' . $this->type . ')[' . $this->offset . ']';

diff --git a/src/Parser/TypeParser.php b/src/Parser/TypeParser.php
@@ -232,7 +232,17 @@ private function parseAtomic(TokenIterator $tokens): Ast\Type\TypeNode
 				);
 			}
 
-			return $this->enrichWithAttributes($tokens, new Ast\Type\ConstTypeNode($constExpr), $startLine, $startIndex);
+			$type = $this->enrichWithAttributes(
+				$tokens,
+				new Ast\Type\ConstTypeNode($constExpr),
+				$startLine,
+				$startIndex
+			);
+			if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
+				$type = $this->tryParseArrayOrOffsetAccess($tokens, $type);
+			}
+
+			return $type;
 		} catch (LogicException $e) {
 			throw new ParserException(
 				$currentTokenValue,
@@ -733,14 +743,14 @@ private function parseCallableReturnType(TokenIterator $tokens): Ast\Type\TypeNo
 				);
 			}
 
-			$type = new Ast\Type\ConstTypeNode($constExpr);
+			$type = $this->enrichWithAttributes(
+				$tokens,
+				new Ast\Type\ConstTypeNode($constExpr),
+				$startLine,
+				$startIndex
+			);
 			if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
-				$type = $this->tryParseArrayOrOffsetAccess($tokens, $this->enrichWithAttributes(
-					$tokens,
-					$type,
-					$startLine,
-					$startIndex
-				));
+				$type = $this->tryParseArrayOrOffsetAccess($tokens, $type);
 			}
 
 			return $type;

diff --git a/src/Printer/Printer.php b/src/Printer/Printer.php
@@ -141,7 +141,6 @@ final class Printer
 			CallableTypeNode::class,
 			UnionTypeNode::class,
 			IntersectionTypeNode::class,
-			ConstTypeNode::class,
 			NullableTypeNode::class,
 		],
 	];
@@ -512,7 +511,6 @@ private function printOffsetAccessType(TypeNode $type): string
 			$type instanceof CallableTypeNode
 			|| $type instanceof UnionTypeNode
 			|| $type instanceof IntersectionTypeNode
-			|| $type instanceof ConstTypeNode
 			|| $type instanceof NullableTypeNode
 		) {
 			return $this->wrapInParentheses($type);

diff --git a/tests/PHPStan/Parser/TypeParserTest.php b/tests/PHPStan/Parser/TypeParserTest.php
@@ -1067,6 +1067,13 @@ public function provideParseData(): array
 					new IdentifierTypeNode('int')
 				),
 			],
+			[
+				'self::TYPES[ int ]',
+				new OffsetAccessTypeNode(
+					new ConstTypeNode(new ConstFetchNode('self', 'TYPES')),
+					new IdentifierTypeNode('int')
+				),
+			],
 			[
 				"?\t\xA009", // edge-case with \h
 				new NullableTypeNode(

diff --git a/tests/PHPStan/Printer/PrinterTest.php b/tests/PHPStan/Printer/PrinterTest.php
@@ -1723,6 +1723,23 @@ public function enterNode(Node $node)
 
 			},
 		];
+
+		yield [
+			'/** @return Foo[abc] */',
+			'/** @return self::FOO[abc] */',
+			new class extends AbstractNodeVisitor {
+
+				public function enterNode(Node $node)
+				{
+					if ($node instanceof ReturnTagValueNode && $node->type instanceof OffsetAccessTypeNode) {
+						$node->type->type = new ConstTypeNode(new ConstFetchNode('self', 'FOO'));
+					}
+
+					return $node;
+				}
+
+			},
+		];
 	}
 
 	/**
@@ -1862,6 +1879,13 @@ public function dataPrintType(): iterable
 			]),
 			'Foo|Bar|(Baz|Lorem)',
 		];
+		yield [
+			new OffsetAccessTypeNode(
+				new ConstTypeNode(new ConstFetchNode('self', 'TYPES')),
+				new IdentifierTypeNode('int')
+			),
+			'self::TYPES[int]',
+		];
 	}
 
 	/**