public function FunctionDeclarationSniff::process in Coder 8.3

Same name and namespace in other branches

1. 8.2 coder_sniffer/Drupal/Sniffs/Functions/FunctionDeclarationSniff.php \Drupal\Sniffs\Functions\FunctionDeclarationSniff::process()
2. 8.3.x coder_sniffer/Drupal/Sniffs/Functions/FunctionDeclarationSniff.php \Drupal\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

File

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');
  }
}