class FunctionDeclarationSniff
Same name in this branch
- 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Functions/FunctionDeclarationSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\Functions\FunctionDeclarationSniff
- 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/PEAR/Sniffs/Functions/FunctionDeclarationSniff.php \PHP_CodeSniffer\Standards\PEAR\Sniffs\Functions\FunctionDeclarationSniff
Ensure that there is only one space after the function keyword and no space before the opening parenthesis.
@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer
Hierarchy
- class \Drupal\Sniffs\Functions\FunctionDeclarationSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of FunctionDeclarationSniff
Deprecated
in Coder 8.x, will be removed in Coder 9.x. MultiLineFunctionDeclarationSniff is used instead.
File
-
vendor/
drupal/ coder/ coder_sniffer/ Drupal/ Sniffs/ Functions/ FunctionDeclarationSniff.php, line 26
Namespace
Drupal\Sniffs\FunctionsView source
class FunctionDeclarationSniff implements Sniff {
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register() {
return [
T_FUNCTION,
];
}
//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();
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');
}
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
FunctionDeclarationSniff::process | public | function | Processes this test, when one of its tokens is encountered. | Overrides Sniff::process |
FunctionDeclarationSniff::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |