From 114217e62b0113af64019bd4da82f0cd2fbb8705 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Thu, 1 Feb 2024 04:09:52 +0100
Subject: [PATCH] :sparkles: New `PHPCSUtils\Utils\Constants` class

... to contain utilities methods for analysing constants declared using the `const` keyword.

In the future, the scope of the methods might be expanded to also covered constants declared using `define()`, but that's for later.

Initially, the class comes with the following method:
* `getProperties(File $phpcsFile, $stackPtr): array` to retrieve an array of information about a constant declaration, like the visibility, whether visibility was explicitly declared, whether the constant was declared as final, what the type is for the constant etc.

Includes extensive unit tests.
---
 PHPCSUtils/Utils/Constants.php                | 180 ++++
 .../GetPropertiesParseError1Test.inc          |   6 +
 .../GetPropertiesParseError1Test.php          |  40 +
 .../GetPropertiesParseError2Test.inc          |   5 +
 .../GetPropertiesParseError2Test.php          |  40 +
 .../GetPropertiesParseError3Test.inc          |   6 +
 .../GetPropertiesParseError3Test.php          |  52 ++
 Tests/Utils/Constants/GetPropertiesTest.inc   | 182 ++++
 Tests/Utils/Constants/GetPropertiesTest.php   | 774 ++++++++++++++++++
 9 files changed, 1285 insertions(+)
 create mode 100644 PHPCSUtils/Utils/Constants.php
 create mode 100644 Tests/Utils/Constants/GetPropertiesParseError1Test.inc
 create mode 100644 Tests/Utils/Constants/GetPropertiesParseError1Test.php
 create mode 100644 Tests/Utils/Constants/GetPropertiesParseError2Test.inc
 create mode 100644 Tests/Utils/Constants/GetPropertiesParseError2Test.php
 create mode 100644 Tests/Utils/Constants/GetPropertiesParseError3Test.inc
 create mode 100644 Tests/Utils/Constants/GetPropertiesParseError3Test.php
 create mode 100644 Tests/Utils/Constants/GetPropertiesTest.inc
 create mode 100644 Tests/Utils/Constants/GetPropertiesTest.php

diff --git a/PHPCSUtils/Utils/Constants.php b/PHPCSUtils/Utils/Constants.php
new file mode 100644
index 00000000..84e1d063
--- /dev/null
+++ b/PHPCSUtils/Utils/Constants.php
@@ -0,0 +1,180 @@
+<?php
+/**
+ * PHPCSUtils, utility functions and classes for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSUtils
+ * @copyright 2019-2020 PHPCSUtils Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSUtils
+ */
+
+namespace PHPCSUtils\Utils;
+
+use PHP_CodeSniffer\Exceptions\RuntimeException;
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Util\Tokens;
+use PHPCSUtils\Internal\Cache;
+use PHPCSUtils\Tokens\Collections;
+use PHPCSUtils\Utils\Scopes;
+
+/**
+ * Utility functions for use when examining constants declared using the "const" keyword.
+ *
+ * @since 1.1.0
+ */
+final class Constants
+{
+
+    /**
+     * Retrieve the visibility and implementation properties of an OO constant.
+     *
+     * @since 1.1.0
+     *
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
+     * @param int                         $stackPtr  The position in the stack of the `T_CONST` token
+     *                                               to acquire the properties for.
+     *
+     * @return array<string, string|int|bool> Array with information about the constant declaration.
+     *         The format of the return value is:
+     *         ```php
+     *         array(
+     *             'scope'           => string,        // Public, private, or protected.
+     *             'scope_token'     => integer|false, // The stack pointer to the scope keyword or
+     *                                                 // FALSE if the scope was not explicitly specified.
+     *             'is_final'        => boolean,       // TRUE if the final keyword was found.
+     *             'final_token'     => integer|false, // The stack pointer to the final keyword
+     *                                                 // or FALSE if the const is not declared final.
+     *             'type'            => string,        // The type of the const (empty if no type specified).
+     *             'type_token'      => integer|false, // The stack pointer to the start of the type
+     *                                                 // or FALSE if there is no type.
+     *             'type_end_token'  => integer|false, // The stack pointer to the end of the type
+     *                                                 // or FALSE if there is no type.
+     *             'nullable_type'   => boolean,       // TRUE if the type is preceded by the
+     *                                                 // nullability operator.
+     *             'name_token'      => integer,       // The stack pointer to the constant name.
+     *                                                 // Note: for group declarations this points to the
+     *                                                 // name of the first constant.
+     *             'equal_token'     => integer,       // The stack pointer to the equal sign.
+     *                                                 // Note: for group declarations this points to the
+     *                                                 // equal sign of the first constant.
+     *         );
+     *         ```
+     *
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a `T_CONST` token.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not an OO constant.
+     */
+    public static function getProperties(File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        if (isset($tokens[$stackPtr]) === false || $tokens[$stackPtr]['code'] !== \T_CONST) {
+            throw new RuntimeException('$stackPtr must be of type T_CONST');
+        }
+
+        if (Scopes::isOOConstant($phpcsFile, $stackPtr) === false) {
+            throw new RuntimeException('$stackPtr is not an OO constant');
+        }
+
+        if (Cache::isCached($phpcsFile, __METHOD__, $stackPtr) === true) {
+            return Cache::get($phpcsFile, __METHOD__, $stackPtr);
+        }
+
+        $assignmentPtr = $phpcsFile->findNext([\T_EQUAL, \T_SEMICOLON, \T_CLOSE_CURLY_BRACKET], ($stackPtr + 1));
+        if ($assignmentPtr === false || $tokens[$assignmentPtr]['code'] !== \T_EQUAL) {
+            // Probably a parse error. Don't cache the result.
+            throw new RuntimeException('$stackPtr is not an OO constant');
+        }
+
+        $namePtr = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($assignmentPtr - 1), ($stackPtr + 1), true);
+
+        $returnValue = [
+            'scope'          => 'public',
+            'scope_token'    => false,
+            'is_final'       => false,
+            'final_token'    => false,
+            'type'           => '',
+            'type_token'     => false,
+            'type_end_token' => false,
+            'nullable_type'  => false,
+            'name_token'     => $namePtr,
+            'equal_token'    => $assignmentPtr,
+        ];
+
+        for ($i = ($stackPtr - 1);; $i--) {
+            // Skip over potentially large docblocks.
+            if ($tokens[$i]['code'] === \T_DOC_COMMENT_CLOSE_TAG
+                && isset($tokens[$i]['comment_opener'])
+            ) {
+                $i = $tokens[$i]['comment_opener'];
+                continue;
+            }
+
+            if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) {
+                continue;
+            }
+
+            switch ($tokens[$i]['code']) {
+                case \T_PUBLIC:
+                    $returnValue['scope']       = 'public';
+                    $returnValue['scope_token'] = $i;
+                    break;
+
+                case \T_PROTECTED:
+                    $returnValue['scope']       = 'protected';
+                    $returnValue['scope_token'] = $i;
+                    break;
+
+                case \T_PRIVATE:
+                    $returnValue['scope']       = 'private';
+                    $returnValue['scope_token'] = $i;
+                    break;
+
+                case \T_FINAL:
+                    $returnValue['is_final']    = true;
+                    $returnValue['final_token'] = $i;
+                    break;
+
+                default:
+                    // Any other token means that the start of the statement has been reached.
+                    break 2;
+            }
+        }
+
+        $type               = '';
+        $typeToken          = false;
+        $typeEndToken       = false;
+        $constantTypeTokens = Collections::constantTypeTokens();
+
+        // Now, let's check for a type.
+        for ($i = ($stackPtr + 1); $i < $namePtr; $i++) {
+            if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) {
+                continue;
+            }
+
+            if ($tokens[$i]['code'] === \T_NULLABLE) {
+                $returnValue['nullable_type'] = true;
+                continue;
+            }
+
+            if (isset($constantTypeTokens[$tokens[$i]['code']]) === true) {
+                $typeEndToken = $i;
+                if ($typeToken === false) {
+                    $typeToken = $i;
+                }
+
+                $type .= $tokens[$i]['content'];
+            }
+        }
+
+        if ($type !== '' && $returnValue['nullable_type'] === true) {
+            $type = '?' . $type;
+        }
+
+        $returnValue['type']           = $type;
+        $returnValue['type_token']     = $typeToken;
+        $returnValue['type_end_token'] = $typeEndToken;
+
+        Cache::set($phpcsFile, __METHOD__, $stackPtr, $returnValue);
+        return $returnValue;
+    }
+}
diff --git a/Tests/Utils/Constants/GetPropertiesParseError1Test.inc b/Tests/Utils/Constants/GetPropertiesParseError1Test.inc
new file mode 100644
index 00000000..4192e73f
--- /dev/null
+++ b/Tests/Utils/Constants/GetPropertiesParseError1Test.inc
@@ -0,0 +1,6 @@
+<?php
+
+class LiveCodingParseError {
+    /* testParseErrorLiveCoding */
+    final const false
+}
diff --git a/Tests/Utils/Constants/GetPropertiesParseError1Test.php b/Tests/Utils/Constants/GetPropertiesParseError1Test.php
new file mode 100644
index 00000000..6793e675
--- /dev/null
+++ b/Tests/Utils/Constants/GetPropertiesParseError1Test.php
@@ -0,0 +1,40 @@
+<?php
+/**
+ * PHPCSUtils, utility functions and classes for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSUtils
+ * @copyright 2019-2024 PHPCSUtils Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSUtils
+ */
+
+namespace PHPCSUtils\Tests\Utils\Constants;
+
+use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Utils\Constants;
+
+/**
+ * Tests for the \PHPCSUtils\Utils\Constants::getProperties method.
+ *
+ * @covers \PHPCSUtils\Utils\Constants::getProperties
+ *
+ * @group constants
+ *
+ * @since 1.1.0
+ */
+final class GetPropertiesParseError1Test extends UtilityMethodTestCase
+{
+
+    /**
+     * Test receiving an exception when encountering a specific parse error.
+     *
+     * @return void
+     */
+    public function testParseError()
+    {
+        $this->expectPhpcsException('$stackPtr is not an OO constant');
+
+        $const = $this->getTargetToken('/* testParseErrorLiveCoding */', \T_CONST);
+        Constants::getProperties(self::$phpcsFile, $const);
+    }
+}
diff --git a/Tests/Utils/Constants/GetPropertiesParseError2Test.inc b/Tests/Utils/Constants/GetPropertiesParseError2Test.inc
new file mode 100644
index 00000000..7950b74e
--- /dev/null
+++ b/Tests/Utils/Constants/GetPropertiesParseError2Test.inc
@@ -0,0 +1,5 @@
+<?php
+
+class LiveCodingParseError {
+    /* testParseErrorLiveCoding */
+    private const ?int TYPED_INT = 0;
diff --git a/Tests/Utils/Constants/GetPropertiesParseError2Test.php b/Tests/Utils/Constants/GetPropertiesParseError2Test.php
new file mode 100644
index 00000000..5d51f2c2
--- /dev/null
+++ b/Tests/Utils/Constants/GetPropertiesParseError2Test.php
@@ -0,0 +1,40 @@
+<?php
+/**
+ * PHPCSUtils, utility functions and classes for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSUtils
+ * @copyright 2019-2024 PHPCSUtils Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSUtils
+ */
+
+namespace PHPCSUtils\Tests\Utils\Constants;
+
+use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Utils\Constants;
+
+/**
+ * Tests for the \PHPCSUtils\Utils\Constants::getProperties method.
+ *
+ * @covers \PHPCSUtils\Utils\Constants::getProperties
+ *
+ * @group constants
+ *
+ * @since 1.1.0
+ */
+final class GetPropertiesParseError2Test extends UtilityMethodTestCase
+{
+
+    /**
+     * Test receiving an exception when encountering a specific parse error.
+     *
+     * @return void
+     */
+    public function testParseError()
+    {
+        $this->expectPhpcsException('$stackPtr is not an OO constant');
+
+        $const = $this->getTargetToken('/* testParseErrorLiveCoding */', \T_CONST);
+        Constants::getProperties(self::$phpcsFile, $const);
+    }
+}
diff --git a/Tests/Utils/Constants/GetPropertiesParseError3Test.inc b/Tests/Utils/Constants/GetPropertiesParseError3Test.inc
new file mode 100644
index 00000000..fa7cec26
--- /dev/null
+++ b/Tests/Utils/Constants/GetPropertiesParseError3Test.inc
@@ -0,0 +1,6 @@
+<?php
+
+class LiveCodingParseError {
+    /* testParseErrorMissingName */
+    private const = 0;
+}
diff --git a/Tests/Utils/Constants/GetPropertiesParseError3Test.php b/Tests/Utils/Constants/GetPropertiesParseError3Test.php
new file mode 100644
index 00000000..557cde17
--- /dev/null
+++ b/Tests/Utils/Constants/GetPropertiesParseError3Test.php
@@ -0,0 +1,52 @@
+<?php
+/**
+ * PHPCSUtils, utility functions and classes for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSUtils
+ * @copyright 2019-2024 PHPCSUtils Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSUtils
+ */
+
+namespace PHPCSUtils\Tests\Utils\Constants;
+
+use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Utils\Constants;
+
+/**
+ * Tests for the \PHPCSUtils\Utils\Constants::getProperties method.
+ *
+ * @covers \PHPCSUtils\Utils\Constants::getProperties
+ *
+ * @group constants
+ *
+ * @since 1.1.0
+ */
+final class GetPropertiesParseError3Test extends UtilityMethodTestCase
+{
+
+    /**
+     * Test the getProperties() method returns false for the name pointer, when the name is missing.
+     *
+     * @return void
+     */
+    public function testGetProperties()
+    {
+        $const    = $this->getTargetToken('/* testParseErrorMissingName */', \T_CONST);
+        $expected = [
+            'scope'           => 'private',
+            'scope_token'     => ($const - 2),
+            'is_final'        => false,
+            'final_token'     => false,
+            'type'            => '',
+            'type_token'      => false,
+            'type_end_token'  => false,
+            'nullable_type'   => false,
+            'name_token'      => false,
+            'equal_token'     => ($const + 2),
+        ];
+        $result   = Constants::getProperties(self::$phpcsFile, $const);
+
+        $this->assertSame($expected, $result);
+    }
+}
diff --git a/Tests/Utils/Constants/GetPropertiesTest.inc b/Tests/Utils/Constants/GetPropertiesTest.inc
new file mode 100644
index 00000000..2af138d0
--- /dev/null
+++ b/Tests/Utils/Constants/GetPropertiesTest.inc
@@ -0,0 +1,182 @@
+<?php
+
+/* testNotAConstToken */
+define('FOO', true);
+
+/* testGlobalConstantCannotHaveModifiersOrType */
+const GLOBAL_UNTYPED = true;
+
+class ClassWithTypedConstants {
+
+    public function foo() {
+        /* testConstInMethodIsNotOO */
+        const NOT_OO_CONST = true;
+    }
+
+    /* testNoModifiersNoTypesWithDocblock */
+    /**
+     * Comment here.
+     *
+     * @phpcs:ignore Standard.Category.Sniff -- because
+     * @var boolean
+     */
+    const NO_MODIFIERS_UNTYPED = true;
+
+    /* testFinalNoTypesConstAsName */
+    final const CONST = true;
+
+    /* testPublicNoTypes */
+    public const PUBLIC_UNTYPED = true;
+
+    /* testProtectedNoTypesWithComment */
+    protected /*comment*/ const PROTECTED_UNTYPED = true;
+
+    /* testPrivateNoTypesWithCommentAndWhitespace */
+    private
+        /*comment*/
+        const
+        // phpcs:ignore Stnd.Cat.Sniff -- for reasons.
+        PRIVATE_UNTYPED = true;
+
+    /* testFinalPublicNoTypes */
+    final public const FINAL_PUBLIC_UNTYPED = true;
+
+    /* testProtectedFinalNoTypes */
+    protected final const PROTECTED_FINAL_UNTYPED = true;
+
+    /* testTypedTrue */
+    const true TYPED_TRUE = true;
+
+    /* testTypedFalse */
+    final const false TYPED_FALSE = false;
+
+    /* testTypedNull */
+    public const null TYPED_NULL = null;
+
+    /* testTypedBoolWihComment */
+    final protected const/*comment*/bool TYPED_BOOL = false;
+
+    /* testTypedNullableIntWithDocblock */
+    /**
+     * Comment here.
+     *
+     * @phpcs:ignore Standard.Category.Sniff -- because
+     * @var int|null
+     */
+    private const ?int TYPED_INT = 0;
+
+    /* testTypedFloatWithAttribute */
+    #[ConstantWithAttribute]
+    const float TYPED_FLOAT = 0.5;
+
+    /* testTypedNullableStringWithComment */
+    public /*comment*/ final const ?string/*comment*/TYPED_STRING = 'string';
+
+    /* testTypedArray */
+    private final const array TYPED_ARRAY = [];
+
+    /* testTypedObjectWithExtraWhitespace */
+    const
+        object
+        TYPED_OBJECT
+        // comment.
+        =
+        MyClass::getInstance();
+
+    /* testTypedNullableIterableLowercaseName */
+    const ?iterable typed_iterable = [];
+
+    /* testTypedMixed */
+    const mixed TYPED_MIXED = 'string';
+
+    /* testTypedClassUnqualifiedWithComment */
+    const ? /*comment*/ MyClass TYPED_UNQUALIFIED_CLASSNAME = MyClass::getInstance();
+
+    /* testTypedClassFullyQualifiedWithDocblock */
+    /**
+     * Comment here.
+     *
+     * @phpcs:ignore Standard.Category.Sniff -- because
+     * @var MyClass
+     */
+    public const \MyClass TYPED_FULLY_QUALIFIED_CLASSNAME = MyClass::getInstance();
+
+    /* testTypedClassNamespaceRelative */
+    protected const namespace\MyClass TYPED_NAMESPACE_RELATIVE_CLASSNAME = MyClass::getInstance();
+
+    /* testTypedClassPartiallyQualifiedWithMultipleAttributes */
+    #[PropertyWithAttribute(foo: 'bar'), MyAttribute]
+    private const Partial\MyClass TYPED_PARTIALLY_QUALIFIED_CLASSNAME = MyClass::getInstance();
+
+    /* testTypedNullableParentMessy */
+    const /* comment
+         */ ? //comment
+        parent TYPED_PARENT = parent::getInstance();
+
+    /* testMultiConstSingleLine */
+    public const bool NAME_1 = true, NAME_2 = false;
+
+    /* testMultiConstMultiLine */
+    public const ?array
+        // First constant.
+        NAME_1 = [],
+        // Second constant.
+        NAME_2 = [];
+}
+
+enum EnumWithOOHierarchyTypedConstants {
+    // Illegal types in a class, but legal in an enum.
+    /* testEnumConstTypedSelf */
+    final const self TYPED_SELF = self::getInstance();
+
+    /* testEnumConstTypedNullableStatic */
+    const ?static TYPED_STATIC = static::getInstance();
+}
+
+trait TraitWithNullableTypedConstants {
+    // Illegal types - the fact that these are not allowed in PHP is not the concern of this method.
+    /* testTypedNullableCallable */
+    protected const ?callable TYPED_CALLABLE = 'function_name';
+
+    /* testTypedVoid */
+    final public const void TYPED_VOID = null;
+
+    /* testTypedNever */
+    private const never TYPED_NEVER = null;
+}
+
+interface InterfaceWithUnionTypedConstants {
+    /* testTypedUnionTrueNull */
+    const true|null /*comment*/ UNION_TRUE_NULL = true;
+
+    /* testTypedUnionArrayObjectWithMultilineAttribute */
+    #[
+        PropertyWithAttribute(/* comment */ 'baz')
+    ]
+    final const array|object UNION_ARRAY_OBJECT = [];
+
+    /* testTypedUnionStringArrayInt */
+    const string | array | int UNION_STRING_ARRAY_INT = 'array middle';
+
+    /* testTypedUnionFloatBoolArrayIllegalNullable */
+    public final const ?float /*comment*/| bool|array UNION_FLOAT_BOOL_ARRAY = false;
+
+    /* testTypedUnionIterableFalse */
+    const iterable|false UNION_ITERABLE_FALSE = false;
+
+    /* testTypedUnionUnqualifiedNamespaceRelativeWithWhiteSpaceAndComments */
+    final protected const Unqualified /*comment*/ | namespace\Relative UNION_UNQUALIFIED_NSRELATIVE = new Unqualified();
+
+    /* testTypedUnionFullyQualifiedPartiallyQualified */
+    private /*comment*/ const \Fully\Qualified|Partially\Qualified UNION_FQN_PARTIAL = new Partial\Qualified;
+}
+
+$a = ( $foo == $bar ? new stdClass() :
+    new class {
+        /* testTypedIntersectUnqualifiedNamespaceRelative */
+        final const Unqualified&namespace\Relative UNION_UNQUALIFIED_NSRELATIVE = new Unqualified();
+
+        /* testTypedIntersectFullyQualifiedPartiallyQualified */
+        protected const \Fully\Qualified&Partially\Qualified UNION_FQN_PARTIAL = new Partial\Qualified;
+    }
+);
diff --git a/Tests/Utils/Constants/GetPropertiesTest.php b/Tests/Utils/Constants/GetPropertiesTest.php
new file mode 100644
index 00000000..b7f9fbef
--- /dev/null
+++ b/Tests/Utils/Constants/GetPropertiesTest.php
@@ -0,0 +1,774 @@
+<?php
+/**
+ * PHPCSUtils, utility functions and classes for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSUtils
+ * @copyright 2019-2024 PHPCSUtils Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSUtils
+ */
+
+namespace PHPCSUtils\Tests\Utils\Constants;
+
+use PHPCSUtils\Internal\Cache;
+use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+use PHPCSUtils\Utils\Constants;
+
+/**
+ * Tests for the \PHPCSUtils\Utils\Constants::getProperties method.
+ *
+ * @covers \PHPCSUtils\Utils\Constants::getProperties
+ *
+ * @group constants
+ *
+ * @since 1.1.0
+ */
+final class GetPropertiesTest extends UtilityMethodTestCase
+{
+
+    /**
+     * Test receiving an expected exception when a non const token is passed.
+     *
+     * @return void
+     */
+    public function testNotAConstException()
+    {
+        $this->expectPhpcsException('$stackPtr must be of type T_CONST');
+
+        $define = $this->getTargetToken('/* testNotAConstToken */', \T_STRING);
+        Constants::getProperties(self::$phpcsFile, $define);
+    }
+
+    /**
+     * Test receiving an expected exception when a non OO constant is passed.
+     *
+     * @dataProvider dataNotOOConstantException
+     *
+     * @param string $identifier Comment which precedes the test case.
+     *
+     * @return void
+     */
+    public function testNotOOConstantException($identifier)
+    {
+        $this->expectPhpcsException('$stackPtr is not an OO constant');
+
+        $const = $this->getTargetToken($identifier, \T_CONST);
+        Constants::getProperties(self::$phpcsFile, $const);
+    }
+
+    /**
+     * Data provider.
+     *
+     * @see testNotOOConstantException()
+     *
+     * @return array<string, array<string>>
+     */
+    public static function dataNotOOConstantException()
+    {
+        return [
+            'global constant'                          => ['/* testGlobalConstantCannotHaveModifiersOrType */'],
+            'constant declared in OO method (illegal)' => ['/* testConstInMethodIsNotOO */'],
+        ];
+    }
+
+    /**
+     * Test the getProperties() method.
+     *
+     * @dataProvider dataGetProperties
+     *
+     * @param string                         $identifier Comment which precedes the test case.
+     * @param array<string, string|int|bool> $expected   Expected function output.
+     *
+     * @return void
+     */
+    public function testGetProperties($identifier, $expected)
+    {
+        $const    = $this->getTargetToken($identifier, \T_CONST);
+        $expected = $this->updateExpectedTokenPositions($const, $expected);
+        $result   = Constants::getProperties(self::$phpcsFile, $const);
+
+        $this->assertSame($expected, $result);
+    }
+
+    /**
+     * Data provider.
+     *
+     * Note: all indexes containing token positions should contain either `false` (no position)
+     * or the _offset_ of the token in relation to the `T_CONST` token which is passed
+     * to the getProperties() method.
+     *
+     * @see testGetProperties()
+     *
+     * @return array<string, array<string|array<string, string|int|bool>>>
+     */
+    public static function dataGetProperties()
+    {
+        $php8Names = parent::usesPhp8NameTokens();
+
+        return [
+            'no modifiers, no type, with docblock' => [
+                'identifier' => '/* testNoModifiersNoTypesWithDocblock */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '',
+                    'type_token'      => false,
+                    'type_end_token'  => false,
+                    'nullable_type'   => false,
+                    'name_token'      => 2,
+                    'equal_token'     => 4,
+                ],
+            ],
+
+            // Testing modifier keyword recognition.
+            'final, no type' => [
+                'identifier' => '/* testFinalNoTypesConstAsName */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => true,
+                    'final_token'     => -2,
+                    'type'            => '',
+                    'type_token'      => false,
+                    'type_end_token'  => false,
+                    'nullable_type'   => false,
+                    'name_token'      => 2,
+                    'equal_token'     => 4,
+                ],
+            ],
+            'public, no type' => [
+                'identifier' => '/* testPublicNoTypes */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => -2,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '',
+                    'type_token'      => false,
+                    'type_end_token'  => false,
+                    'nullable_type'   => false,
+                    'name_token'      => 2,
+                    'equal_token'     => 4,
+                ],
+            ],
+            'protected, no type, with comment' => [
+                'identifier' => '/* testProtectedNoTypesWithComment */',
+                'expected'   => [
+                    'scope'           => 'protected',
+                    'scope_token'     => -4,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '',
+                    'type_token'      => false,
+                    'type_end_token'  => false,
+                    'nullable_type'   => false,
+                    'name_token'      => 2,
+                    'equal_token'     => 4,
+                ],
+            ],
+            'private, no type, comments and whitespace' => [
+                'identifier' => '/* testPrivateNoTypesWithCommentAndWhitespace */',
+                'expected'   => [
+                    'scope'           => 'private',
+                    'scope_token'     => -6,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '',
+                    'type_token'      => false,
+                    'type_end_token'  => false,
+                    'nullable_type'   => false,
+                    'name_token'      => 5,
+                    'equal_token'     => 7,
+                ],
+            ],
+            'final public, no type' => [
+                'identifier' => '/* testFinalPublicNoTypes */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => -2,
+                    'is_final'        => true,
+                    'final_token'     => -4,
+                    'type'            => '',
+                    'type_token'      => false,
+                    'type_end_token'  => false,
+                    'nullable_type'   => false,
+                    'name_token'      => 2,
+                    'equal_token'     => 4,
+                ],
+            ],
+            'protected final, no type' => [
+                'identifier' => '/* testProtectedFinalNoTypes */',
+                'expected'   => [
+                    'scope'           => 'protected',
+                    'scope_token'     => -4,
+                    'is_final'        => true,
+                    'final_token'     => -2,
+                    'type'            => '',
+                    'type_token'      => false,
+                    'type_end_token'  => false,
+                    'nullable_type'   => false,
+                    'name_token'      => 2,
+                    'equal_token'     => 4,
+                ],
+            ],
+
+            // Testing typed constants.
+            'no modifiers, typed: true' => [
+                'identifier' => '/* testTypedTrue */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'true',
+                    'type_token'      => 2,
+                    'type_end_token'  => 2,
+                    'nullable_type'   => false,
+                    'name_token'      => 4,
+                    'equal_token'     => 6,
+                ],
+            ],
+            'final, typed: false' => [
+                'identifier' => '/* testTypedFalse */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => true,
+                    'final_token'     => -2,
+                    'type'            => 'false',
+                    'type_token'      => 2,
+                    'type_end_token'  => 2,
+                    'nullable_type'   => false,
+                    'name_token'      => 4,
+                    'equal_token'     => 6,
+                ],
+            ],
+            'public, typed: null' => [
+                'identifier' => '/* testTypedNull */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => -2,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'null',
+                    'type_token'      => 2,
+                    'type_end_token'  => 2,
+                    'nullable_type'   => false,
+                    'name_token'      => 4,
+                    'equal_token'     => 6,
+                ],
+            ],
+            'final protected, typed: bool, with comment' => [
+                'identifier' => '/* testTypedBoolWihComment */',
+                'expected'   => [
+                    'scope'           => 'protected',
+                    'scope_token'     => -2,
+                    'is_final'        => true,
+                    'final_token'     => -4,
+                    'type'            => 'bool',
+                    'type_token'      => 2,
+                    'type_end_token'  => 2,
+                    'nullable_type'   => false,
+                    'name_token'      => 4,
+                    'equal_token'     => 6,
+                ],
+            ],
+            'private, typed: ?int, with docblock' => [
+                'identifier' => '/* testTypedNullableIntWithDocblock */',
+                'expected'   => [
+                    'scope'           => 'private',
+                    'scope_token'     => -2,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '?int',
+                    'type_token'      => 3,
+                    'type_end_token'  => 3,
+                    'nullable_type'   => true,
+                    'name_token'      => 5,
+                    'equal_token'     => 7,
+                ],
+            ],
+            'no modifiers, typed: float, with attribute' => [
+                'identifier' => '/* testTypedFloatWithAttribute */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'float',
+                    'type_token'      => 2,
+                    'type_end_token'  => 2,
+                    'nullable_type'   => false,
+                    'name_token'      => 4,
+                    'equal_token'     => 6,
+                ],
+            ],
+            'public final, typed: ?string, with comment' => [
+                'identifier' => '/* testTypedNullableStringWithComment */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => -6,
+                    'is_final'        => true,
+                    'final_token'     => -2,
+                    'type'            => '?string',
+                    'type_token'      => 3,
+                    'type_end_token'  => 3,
+                    'nullable_type'   => true,
+                    'name_token'      => 5,
+                    'equal_token'     => 7,
+                ],
+            ],
+            'private final, typed: array' => [
+                'identifier' => '/* testTypedArray */',
+                'expected'   => [
+                    'scope'           => 'private',
+                    'scope_token'     => -4,
+                    'is_final'        => true,
+                    'final_token'     => -2,
+                    'type'            => 'array',
+                    'type_token'      => 2,
+                    'type_end_token'  => 2,
+                    'nullable_type'   => false,
+                    'name_token'      => 4,
+                    'equal_token'     => 6,
+                ],
+            ],
+            'no modifiers, typed: object, extra whitespace' => [
+                'identifier' => '/* testTypedObjectWithExtraWhitespace */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'object',
+                    'type_token'      => 3,
+                    'type_end_token'  => 3,
+                    'nullable_type'   => false,
+                    'name_token'      => 6,
+                    'equal_token'     => 11,
+                ],
+            ],
+            'no modifiers, typed: ?iterable, lowercase constant name' => [
+                'identifier' => '/* testTypedNullableIterableLowercaseName */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '?iterable',
+                    'type_token'      => 3,
+                    'type_end_token'  => 3,
+                    'nullable_type'   => true,
+                    'name_token'      => 5,
+                    'equal_token'     => 7,
+                ],
+            ],
+            'no modifiers, typed: mixed' => [
+                'identifier' => '/* testTypedMixed */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'mixed',
+                    'type_token'      => 2,
+                    'type_end_token'  => 2,
+                    'nullable_type'   => false,
+                    'name_token'      => 4,
+                    'equal_token'     => 6,
+                ],
+            ],
+            'no modifiers, typed: nullable unqualified name, comment in type' => [
+                'identifier' => '/* testTypedClassUnqualifiedWithComment */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '?MyClass',
+                    'type_token'      => 6,
+                    'type_end_token'  => 6,
+                    'nullable_type'   => true,
+                    'name_token'      => 8,
+                    'equal_token'     => 10,
+                ],
+            ],
+            'public, typed: fully qualified name, with docblock' => [
+                'identifier' => '/* testTypedClassFullyQualifiedWithDocblock */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => -2,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '\MyClass',
+                    'type_token'      => 2,
+                    'type_end_token'  => ($php8Names === true) ? 2 : 3,
+                    'nullable_type'   => false,
+                    'name_token'      => ($php8Names === true) ? 4 : 5,
+                    'equal_token'     => ($php8Names === true) ? 6 : 7,
+                ],
+            ],
+            'protected, typed: namespace relative name' => [
+                'identifier' => '/* testTypedClassNamespaceRelative */',
+                'expected'   => [
+                    'scope'           => 'protected',
+                    'scope_token'     => -2,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'namespace\MyClass',
+                    'type_token'      => 2,
+                    'type_end_token'  => ($php8Names === true) ? 2 : 4,
+                    'nullable_type'   => false,
+                    'name_token'      => ($php8Names === true) ? 4 : 6,
+                    'equal_token'     => ($php8Names === true) ? 6 : 8,
+                ],
+            ],
+            'private, typed: partially qualified, with multi-attribute' => [
+                'identifier' => '/* testTypedClassPartiallyQualifiedWithMultipleAttributes */',
+                'expected'   => [
+                    'scope'           => 'private',
+                    'scope_token'     => -2,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'Partial\MyClass',
+                    'type_token'      => 2,
+                    'type_end_token'  => ($php8Names === true) ? 2 : 4,
+                    'nullable_type'   => false,
+                    'name_token'      => ($php8Names === true) ? 4 : 6,
+                    'equal_token'     => ($php8Names === true) ? 6 : 8,
+                ],
+            ],
+            'no modifiers, typed: ?parent, with comments, messy' => [
+                'identifier' => '/* testTypedNullableParentMessy */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '?parent',
+                    'type_token'      => 9,
+                    'type_end_token'  => 9,
+                    'nullable_type'   => true,
+                    'name_token'      => 11,
+                    'equal_token'     => 13,
+                ],
+            ],
+            'public, typed: bool, multi-constant, single line' => [
+                'identifier' => '/* testMultiConstSingleLine */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => -2,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'bool',
+                    'type_token'      => 2,
+                    'type_end_token'  => 2,
+                    'nullable_type'   => false,
+                    'name_token'      => 4,
+                    'equal_token'     => 6,
+                ],
+            ],
+            'public, typed: ?array, multi-constant, multi-line' => [
+                'identifier' => '/* testMultiConstMultiLine */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => -2,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '?array',
+                    'type_token'      => 3,
+                    'type_end_token'  => 3,
+                    'nullable_type'   => true,
+                    'name_token'      => 8,
+                    'equal_token'     => 10,
+                ],
+            ],
+
+            // Types which are only legal in enums.
+            'final, typed: self' => [
+                'identifier' => '/* testEnumConstTypedSelf */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => true,
+                    'final_token'     => -2,
+                    'type'            => 'self',
+                    'type_token'      => 2,
+                    'type_end_token'  => 2,
+                    'nullable_type'   => false,
+                    'name_token'      => 4,
+                    'equal_token'     => 6,
+                ],
+            ],
+            'no modifiers, typed: static' => [
+                'identifier' => '/* testEnumConstTypedNullableStatic */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '?static',
+                    'type_token'      => 3,
+                    'type_end_token'  => 3,
+                    'nullable_type'   => true,
+                    'name_token'      => 5,
+                    'equal_token'     => 7,
+                ],
+            ],
+
+            // Illegal types, but that's not the concern of this method.
+            'protected, typed: ?callable (not supported in PHP)' => [
+                'identifier' => '/* testTypedNullableCallable */',
+                'expected'   => [
+                    'scope'           => 'protected',
+                    'scope_token'     => -2,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '?callable',
+                    'type_token'      => 3,
+                    'type_end_token'  => 3,
+                    'nullable_type'   => true,
+                    'name_token'      => 5,
+                    'equal_token'     => 7,
+                ],
+            ],
+            'final public, typed: void (not supported in PHP)' => [
+                'identifier' => '/* testTypedVoid */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => -2,
+                    'is_final'        => true,
+                    'final_token'     => -4,
+                    'type'            => 'void',
+                    'type_token'      => 2,
+                    'type_end_token'  => 2,
+                    'nullable_type'   => false,
+                    'name_token'      => 4,
+                    'equal_token'     => 6,
+                ],
+            ],
+            'private, typed: never (not supported in PHP)' => [
+                'identifier' => '/* testTypedNever */',
+                'expected'   => [
+                    'scope'           => 'private',
+                    'scope_token'     => -2,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'never',
+                    'type_token'      => 2,
+                    'type_end_token'  => 2,
+                    'nullable_type'   => false,
+                    'name_token'      => 4,
+                    'equal_token'     => 6,
+                ],
+            ],
+
+            // Union types.
+            'no modifiers, typed: true|null' => [
+                'identifier' => '/* testTypedUnionTrueNull */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'true|null',
+                    'type_token'      => 2,
+                    'type_end_token'  => 4,
+                    'nullable_type'   => false,
+                    'name_token'      => 8,
+                    'equal_token'     => 10,
+                ],
+            ],
+            'final, typed: array|object, with multi-line atribute' => [
+                'identifier' => '/* testTypedUnionArrayObjectWithMultilineAttribute */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => true,
+                    'final_token'     => -2,
+                    'type'            => 'array|object',
+                    'type_token'      => 2,
+                    'type_end_token'  => 4,
+                    'nullable_type'   => false,
+                    'name_token'      => 6,
+                    'equal_token'     => 8,
+                ],
+            ],
+            'no modifiers, typed: string|array|int, with whitespace in type' => [
+                'identifier' => '/* testTypedUnionStringArrayInt */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'string|array|int',
+                    'type_token'      => 2,
+                    'type_end_token'  => 10,
+                    'nullable_type'   => false,
+                    'name_token'      => 12,
+                    'equal_token'     => 14,
+                ],
+            ],
+            'public final, typed: ?float|bool|array, illegal nullable union type' => [
+                'identifier' => '/* testTypedUnionFloatBoolArrayIllegalNullable */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => -4,
+                    'is_final'        => true,
+                    'final_token'     => -2,
+                    'type'            => '?float|bool|array',
+                    'type_token'      => 3,
+                    'type_end_token'  => 10,
+                    'nullable_type'   => true,
+                    'name_token'      => 12,
+                    'equal_token'     => 14,
+                ],
+            ],
+            'no modifiers, typed: iterable|false' => [
+                'identifier' => '/* testTypedUnionIterableFalse */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => 'iterable|false',
+                    'type_token'      => 2,
+                    'type_end_token'  => 4,
+                    'nullable_type'   => false,
+                    'name_token'      => 6,
+                    'equal_token'     => 8,
+                ],
+            ],
+            'final protected, typed: Unqualified|namespace\Relative, with whitespace and comments in type' => [
+                'identifier' => '/* testTypedUnionUnqualifiedNamespaceRelativeWithWhiteSpaceAndComments */',
+                'expected'   => [
+                    'scope'           => 'protected',
+                    'scope_token'     => -2,
+                    'is_final'        => true,
+                    'final_token'     => -4,
+                    'type'            => 'Unqualified|namespace\Relative',
+                    'type_token'      => 2,
+                    'type_end_token'  => ($php8Names === true) ? 8 : 10,
+                    'nullable_type'   => false,
+                    'name_token'      => ($php8Names === true) ? 10 : 12,
+                    'equal_token'     => ($php8Names === true) ? 12 : 14,
+                ],
+            ],
+            'private, typed: \Fully\Qualified|Partially\Qualified' => [
+                'identifier' => '/* testTypedUnionFullyQualifiedPartiallyQualified */',
+                'expected'   => [
+                    'scope'           => 'private',
+                    'scope_token'     => -4,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '\Fully\Qualified|Partially\Qualified',
+                    'type_token'      => 2,
+                    'type_end_token'  => ($php8Names === true) ? 4 : 9,
+                    'nullable_type'   => false,
+                    'name_token'      => ($php8Names === true) ? 6 : 11,
+                    'equal_token'     => ($php8Names === true) ? 8 : 13,
+                ],
+            ],
+
+            // Intersection types.
+            'final, typed: Unqualified|namespace\Relative, with whitespace and comments in type' => [
+                'identifier' => '/* testTypedIntersectUnqualifiedNamespaceRelative */',
+                'expected'   => [
+                    'scope'           => 'public',
+                    'scope_token'     => false,
+                    'is_final'        => true,
+                    'final_token'     => -2,
+                    'type'            => 'Unqualified&namespace\Relative',
+                    'type_token'      => 2,
+                    'type_end_token'  => ($php8Names === true) ? 4 : 6,
+                    'nullable_type'   => false,
+                    'name_token'      => ($php8Names === true) ? 6 : 8,
+                    'equal_token'     => ($php8Names === true) ? 8 : 10,
+                ],
+            ],
+            'protected, typed: \Fully\Qualified|Partially\Qualified' => [
+                'identifier' => '/* testTypedIntersectFullyQualifiedPartiallyQualified */',
+                'expected'   => [
+                    'scope'           => 'protected',
+                    'scope_token'     => -2,
+                    'is_final'        => false,
+                    'final_token'     => false,
+                    'type'            => '\Fully\Qualified&Partially\Qualified',
+                    'type_token'      => 2,
+                    'type_end_token'  => ($php8Names === true) ? 4 : 9,
+                    'nullable_type'   => false,
+                    'name_token'      => ($php8Names === true) ? 6 : 11,
+                    'equal_token'     => ($php8Names === true) ? 8 : 13,
+                ],
+            ],
+        ];
+    }
+
+    /**
+     * Verify that the build-in caching is used when caching is enabled.
+     *
+     * @return void
+     */
+    public function testResultIsCached()
+    {
+        $methodName = 'PHPCSUtils\\Utils\\Constants::getProperties';
+        $cases      = self::dataGetProperties();
+        $identifier = $cases['public final, typed: ?float|bool|array, illegal nullable union type']['identifier'];
+        $expected   = $cases['public final, typed: ?float|bool|array, illegal nullable union type']['expected'];
+
+        $const    = $this->getTargetToken($identifier, \T_CONST);
+        $expected = $this->updateExpectedTokenPositions($const, $expected);
+
+        // Verify the caching works.
+        $origStatus     = Cache::$enabled;
+        Cache::$enabled = true;
+
+        $resultFirstRun  = Constants::getProperties(self::$phpcsFile, $const);
+        $isCached        = Cache::isCached(self::$phpcsFile, $methodName, $const);
+        $resultSecondRun = Constants::getProperties(self::$phpcsFile, $const);
+
+        if ($origStatus === false) {
+            Cache::clear();
+        }
+        Cache::$enabled = $origStatus;
+
+        $this->assertSame($expected, $resultFirstRun, 'First result did not match expectation');
+        $this->assertTrue($isCached, 'Cache::isCached() could not find the cached value');
+        $this->assertSame($resultFirstRun, $resultSecondRun, 'Second result did not match first');
+    }
+
+    /**
+     * Test helper to translate token offsets to absolute positions in an "expected" array.
+     *
+     * @param int                            $targetPtr The token pointer to the target token from which
+     *                                                  the offset is calculated.
+     * @param array<string, string|int|bool> $expected  The expected function output containing offsets.
+     *
+     * @return array<string, string|int|bool>
+     */
+    private function updateExpectedTokenPositions($targetPtr, $expected)
+    {
+        if (\is_int($expected['scope_token']) === true) {
+            $expected['scope_token'] += $targetPtr;
+        }
+        if (\is_int($expected['final_token']) === true) {
+            $expected['final_token'] += $targetPtr;
+        }
+        if (\is_int($expected['type_token']) === true) {
+            $expected['type_token'] += $targetPtr;
+        }
+        if (\is_int($expected['type_end_token']) === true) {
+            $expected['type_end_token'] += $targetPtr;
+        }
+        if (\is_int($expected['name_token']) === true) {
+            $expected['name_token'] += $targetPtr;
+        }
+        if (\is_int($expected['equal_token'])) {
+            $expected['equal_token'] += $targetPtr;
+        }
+
+        return $expected;
+    }
+}