[8.4] Add support for __PROPERTY__ magic constant

Part of property hooks RFC.
nikic · Jul 14, 2024 · d8235a2 · d8235a2
1 parent 5973c30
commit d8235a2
Show file tree

Hide file tree

Showing 14 changed files with 1,415 additions and 1,323 deletions.
diff --git a/grammar/php.y b/grammar/php.y
@@ -103,6 +103,7 @@
 %token T_TRAIT_C
 %token T_METHOD_C
 %token T_FUNC_C
+%token T_PROPERTY_C
 %token T_LINE
 %token T_FILE
 %token T_START_HEREDOC
@@ -1165,6 +1166,7 @@ constant:
     | T_METHOD_C                                            { $$ = Scalar\MagicConst\Method[]; }
     | T_FUNC_C                                              { $$ = Scalar\MagicConst\Function_[]; }
     | T_NS_C                                                { $$ = Scalar\MagicConst\Namespace_[]; }
+    | T_PROPERTY_C                                          { $$ = Scalar\MagicConst\Property[]; }
 ;
 
 class_constant:

diff --git a/lib/PhpParser/Lexer/Emulative.php b/lib/PhpParser/Lexer/Emulative.php
@@ -7,13 +7,10 @@
 use PhpParser\Lexer;
 use PhpParser\Lexer\TokenEmulator\AttributeEmulator;
 use PhpParser\Lexer\TokenEmulator\EnumTokenEmulator;
-use PhpParser\Lexer\TokenEmulator\CoaleseEqualTokenEmulator;
 use PhpParser\Lexer\TokenEmulator\ExplicitOctalEmulator;
-use PhpParser\Lexer\TokenEmulator\FlexibleDocStringEmulator;
-use PhpParser\Lexer\TokenEmulator\FnTokenEmulator;
 use PhpParser\Lexer\TokenEmulator\MatchTokenEmulator;
 use PhpParser\Lexer\TokenEmulator\NullsafeTokenEmulator;
-use PhpParser\Lexer\TokenEmulator\NumericLiteralSeparatorEmulator;
+use PhpParser\Lexer\TokenEmulator\PropertyTokenEmulator;
 use PhpParser\Lexer\TokenEmulator\ReadonlyFunctionTokenEmulator;
 use PhpParser\Lexer\TokenEmulator\ReadonlyTokenEmulator;
 use PhpParser\Lexer\TokenEmulator\ReverseEmulator;
@@ -47,6 +44,7 @@ public function __construct(?PhpVersion $phpVersion = null) {
             new ReadonlyTokenEmulator(),
             new ExplicitOctalEmulator(),
             new ReadonlyFunctionTokenEmulator(),
+            new PropertyTokenEmulator(),
         ];
 
         // Collect emulators that are relevant for the PHP version we're running

diff --git a/lib/PhpParser/Lexer/TokenEmulator/KeywordEmulator.php b/lib/PhpParser/Lexer/TokenEmulator/KeywordEmulator.php
@@ -14,8 +14,12 @@ public function isEmulationNeeded(string $code): bool {
 
     /** @param Token[] $tokens */
     protected function isKeywordContext(array $tokens, int $pos): bool {
-        $previousNonSpaceToken = $this->getPreviousNonSpaceToken($tokens, $pos);
-        return $previousNonSpaceToken === null || $previousNonSpaceToken->id !== \T_OBJECT_OPERATOR;
+        $prevToken = $this->getPreviousNonSpaceToken($tokens, $pos);
+        if ($prevToken === null) {
+            return false;
+        }
+        return $prevToken->id !== \T_OBJECT_OPERATOR
+            && $prevToken->id !== \T_NULLSAFE_OBJECT_OPERATOR;
     }
 
     public function emulate(string $code, array $tokens): array {

diff --git a/lib/PhpParser/Lexer/TokenEmulator/PropertyTokenEmulator.php b/lib/PhpParser/Lexer/TokenEmulator/PropertyTokenEmulator.php
@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser\Lexer\TokenEmulator;
+
+use PhpParser\PhpVersion;
+
+final class PropertyTokenEmulator extends KeywordEmulator {
+    public function getPhpVersion(): PhpVersion {
+        return PhpVersion::fromComponents(8, 4);
+    }
+
+    public function getKeywordString(): string {
+        return '__property__';
+    }
+
+    public function getKeywordToken(): int {
+        return \T_PROPERTY_C;
+    }
+}
diff --git a/lib/PhpParser/Node/Scalar/MagicConst/Property.php b/lib/PhpParser/Node/Scalar/MagicConst/Property.php
@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser\Node\Scalar\MagicConst;
+
+use PhpParser\Node\Scalar\MagicConst;
+
+class Property extends MagicConst {
+    public function getName(): string {
+        return '__PROPERTY__';
+    }
+
+    public function getType(): string {
+        return 'Scalar_MagicConst_Property';
+    }
+}
diff --git a/lib/PhpParser/Parser/Php7.php b/lib/PhpParser/Parser/Php7.php
diff --git a/lib/PhpParser/Parser/Php8.php b/lib/PhpParser/Parser/Php8.php
diff --git a/lib/PhpParser/ParserAbstract.php b/lib/PhpParser/ParserAbstract.php
@@ -1224,6 +1224,7 @@ protected function createTokenMap(): array {
         $tokenMap[\T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG] = static::T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG;
         $tokenMap[\T_ENUM] = static::T_ENUM;
         $tokenMap[\T_READONLY] = static::T_READONLY;
+        $tokenMap[\T_PROPERTY_C] = static::T_PROPERTY_C;
 
         // We have create a map from PHP token IDs to external symbol IDs.
         // Now map them to the internal symbol ID.

diff --git a/lib/PhpParser/PrettyPrinter/Standard.php b/lib/PhpParser/PrettyPrinter/Standard.php
@@ -125,6 +125,10 @@ protected function pScalar_MagicConst_Trait(MagicConst\Trait_ $node): string {
         return '__TRAIT__';
     }
 
+    protected function pScalar_MagicConst_Property(MagicConst\Property $node): string {
+        return '__PROPERTY__';
+    }
+
     // Scalars
 
     private function indentString(string $str): string {

diff --git a/lib/PhpParser/compatibility_tokens.php b/lib/PhpParser/compatibility_tokens.php
@@ -17,6 +17,8 @@ function defineCompatibilityTokens(): void {
             'T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG',
             'T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG',
             'T_READONLY',
+            // PHP 8.4
+            'T_PROPERTY_C',
         ];
 
         // PHP-Parser might be used together with another library that also emulates some or all

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -90,6 +90,11 @@ parameters:
 			count: 1
 			path: lib/PhpParser/Lexer/Emulative.php
 
+		-
+			message: "#^Constant T_PROPERTY_C not found\\.$#"
+			count: 1
+			path: lib/PhpParser/Lexer/TokenEmulator/PropertyTokenEmulator.php
+
 		-
 			message: "#^Method PhpParser\\\\NodeDumper\\:\\:__construct\\(\\) has parameter \\$options with no value type specified in iterable type array\\.$#"
 			count: 1
@@ -220,11 +225,21 @@ parameters:
 			count: 1
 			path: lib/PhpParser/ParserAbstract.php
 
+		-
+			message: "#^Access to undefined constant static\\(PhpParser\\\\ParserAbstract\\)\\:\\:T_PROPERTY_C\\.$#"
+			count: 1
+			path: lib/PhpParser/ParserAbstract.php
+
 		-
 			message: "#^Access to undefined constant static\\(PhpParser\\\\ParserAbstract\\)\\:\\:T_READONLY\\.$#"
 			count: 1
 			path: lib/PhpParser/ParserAbstract.php
 
+		-
+			message: "#^Constant T_PROPERTY_C not found\\.$#"
+			count: 1
+			path: lib/PhpParser/ParserAbstract.php
+
 		-
 			message: "#^Unary operation \"\\+\" on string results in an error\\.$#"
 			count: 1

diff --git a/test/PhpParser/Lexer/EmulativeTest.php b/test/PhpParser/Lexer/EmulativeTest.php
@@ -91,6 +91,9 @@ public function testNoReplaceKeywordsAfterNullsafeObjectOperator(string $keyword
 
     public static function provideTestReplaceKeywords() {
         return [
+            // PHP 8.4
+            ['__PROPERTY__', \T_PROPERTY_C],
+
             // PHP 8.0
             ['match',         \T_MATCH],
 
@@ -424,6 +427,10 @@ public static function provideTestTargetVersion() {
                 [\T_ENCAPSED_AND_WHITESPACE, ' baz'],
                 [ord('"'), '"'],
             ]],
+            ['8.4', '__PROPERTY__', [[\T_PROPERTY_C, '__PROPERTY__']]],
+            ['8.3', '__PROPERTY__', [[\T_STRING, '__PROPERTY__']]],
+            ['8.4', '__property__', [[\T_PROPERTY_C, '__property__']]],
+            ['8.3', '__property__', [[\T_STRING, '__property__']]],
         ];
     }
 }
diff --git a/test/code/parser/scalar/magicConst.test b/test/code/parser/scalar/magicConst.test
@@ -10,6 +10,7 @@ __LINE__;
 __METHOD__;
 __NAMESPACE__;
 __TRAIT__;
+__PROPERTY__;
 -----
 array(
     0: Stmt_Expression(
@@ -44,4 +45,8 @@ array(
         expr: Scalar_MagicConst_Trait(
         )
     )
+    8: Stmt_Expression(
+        expr: Scalar_MagicConst_Property(
+        )
+    )
 )
diff --git a/test/code/prettyPrinter/expr/literals.test b/test/code/prettyPrinter/expr/literals.test
@@ -11,6 +11,7 @@ __CLASS__;
 __TRAIT__;
 __METHOD__;
 __NAMESPACE__;
+__PROPERTY__;
 
 // not actually literals, but close
 null;
@@ -94,6 +95,7 @@ __CLASS__;
 __TRAIT__;
 __METHOD__;
 __NAMESPACE__;
+__PROPERTY__;
 // not actually literals, but close
 null;
 true;