Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. DisallowRequestSuperglobalSniff.php

class DisallowRequestSuperglobalSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\DisallowRequestSuperglobalSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of DisallowRequestSuperglobalSniff

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/PHP/DisallowRequestSuperglobalSniff.php, line 15

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\PHP
View source
class DisallowRequestSuperglobalSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_VARIABLE,
        ];
    }
    
    //end register()
    
    /**
     * Processes this sniff, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param int                         $stackPtr  The position of the current token in the stack
     *                                               passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        $varName = $tokens[$stackPtr]['content'];
        if ($varName !== '$_REQUEST') {
            return;
        }
        $error = 'The $_REQUEST superglobal should not be used; use $_GET, $_POST, or $_COOKIE instead';
        $phpcsFile->addError($error, $stackPtr, 'Found');
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
DisallowRequestSuperglobalSniff::process public function Processes this sniff, when one of its tokens is encountered. Overrides Sniff::process
DisallowRequestSuperglobalSniff::register public function Returns an array of tokens this test wants to listen for. Overrides Sniff::register
RSS feed
Powered by Drupal