function GlobalConstantSniff::process

Processes this test, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The current file being processed.:

int $stackPtr The position of the current token: in the stack passed in $tokens.

Return value

void|int

Overrides Sniff::process

File

vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalConstantSniff.php, line 48

Class

GlobalConstantSniff

Checks that globally defined constants are not used in Drupal 8 and higher.

Namespace

DrupalPractice\Sniffs\Constants

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    // Only check constants in the global scope.
    if (empty($tokens[$stackPtr]['conditions']) === false) {
        return;
    }
    $coreVersion = Project::getCoreVersion($phpcsFile);
    if ($coreVersion < 8) {
        // No need to check this file again, mark it as done.
        return $phpcsFile->numTokens + 1;
    }
    // Allow constants if they are deprecated.
    $commentEnd = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
    if ($commentEnd !== null && $tokens[$commentEnd]['code'] === T_DOC_COMMENT_CLOSE_TAG) {
        // Go through all comment tags and check if one is @deprecated.
        $commentTag = $commentEnd;
        while ($commentTag !== null && $commentTag > $tokens[$commentEnd]['comment_opener']) {
            if ($tokens[$commentTag]['content'] === '@deprecated') {
                return;
            }
            $commentTag = $phpcsFile->findPrevious(T_DOC_COMMENT_TAG, $commentTag - 1, $tokens[$commentEnd]['comment_opener']);
        }
    }
    $warning = 'Global constants should not be used, move it to a class or interface';
    $phpcsFile->addWarning($warning, $stackPtr, 'GlobalConstant');
}