function FunctionDeclarationSniff::process

Same name in this branch

11.1.x vendor/squizlabs/php_codesniffer/src/Standards/PEAR/Sniffs/Functions/FunctionDeclarationSniff.php \PHP_CodeSniffer\Standards\PEAR\Sniffs\Functions\FunctionDeclarationSniff::process()

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

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

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

Return value

void

Overrides Sniff::process

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Functions/FunctionDeclarationSniff.php, line 51

Class

FunctionDeclarationSniff: Ensure that there is only one space after the function keyword and no space before the opening parenthesis.

Namespace

Drupal\Sniffs\Functions

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    if ($tokens[$stackPtr + 1]['content'] !== ' ') {
        $error = 'Expected exactly one space after the function keyword';
        $phpcsFile->addError($error, $stackPtr + 1, 'SpaceAfter');
    }
    if (isset($tokens[$stackPtr + 3]) === true && $tokens[$stackPtr + 3]['code'] === T_WHITESPACE) {
        $error = 'Space before opening parenthesis of function definition prohibited';
        $phpcsFile->addError($error, $stackPtr + 3, 'SpaceBeforeParenthesis');
    }
}