GlobalVariablesSniff.php 869 Bytes
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace Magento\Sniffs\Variables;

use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;

/**
 * Sniff prohibiting usage of global variables.
 */
class GlobalVariablesSniff implements Sniff
{
    /**
     * @inheritdoc
     */
    public function register()
    {
        return [T_VARIABLE];
    }

    /**
     * @inheritdoc
     */
    public function process(File $phpcsFile, $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();
        if (preg_match('/^\$[_A-Z0-9]+$/', $tokens[$stackPtr]['content'])) {
            $phpcsFile->addError(
                'Usage of global variables is not allowed: ' . $tokens[$stackPtr]['content'],
                $stackPtr,
                'ERROR'
            );
            return;
        }
    }
}