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

Breadcrumb

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

class SAPIUsageSniff

Hierarchy

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

Expanded class hierarchy of SAPIUsageSniff

File

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

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\PHP
View source
class SAPIUsageSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_STRING,
        ];
    }
    
    //end register()
    
    /**
     * Processes this test, 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();
        $ignore = [
            T_DOUBLE_COLON => true,
            T_OBJECT_OPERATOR => true,
            T_NULLSAFE_OBJECT_OPERATOR => true,
            T_FUNCTION => true,
            T_CONST => true,
        ];
        $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
        if (isset($ignore[$tokens[$prevToken]['code']]) === true) {
            // Not a call to a PHP function.
            return;
        }
        $function = strtolower($tokens[$stackPtr]['content']);
        if ($function === 'php_sapi_name') {
            $error = 'Use the PHP_SAPI constant instead of calling php_sapi_name()';
            $phpcsFile->addError($error, $stackPtr, 'FunctionFound');
        }
    }
    
    //end process()

}

Members

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