Source for file FunctionDeclarationSniff.php
Documentation is available at FunctionDeclarationSniff.php
* Ensure single and multi-line function declarations are defined correctly.
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\PEAR\Sniffs\Functions;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Util\Tokens;
use PHP_CodeSniffer\Standards\Generic\Sniffs\Functions\OpeningFunctionBraceKernighanRitchieSniff;
use PHP_CodeSniffer\Standards\Generic\Sniffs\Functions\OpeningFunctionBraceBsdAllmanSniff;
class FunctionDeclarationSniff implements Sniff
* A list of tokenizers this sniff supports.
public $supportedTokenizers = array (
* The number of spaces code should be indented.
* Returns an array of tokens this test wants to listen for.
public function 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.
public function process (File $phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
if (isset ($tokens[$stackPtr]['parenthesis_opener']) === false
|| isset ($tokens[$stackPtr]['parenthesis_closer']) === false
|| $tokens[$stackPtr]['parenthesis_opener'] === null
|| $tokens[$stackPtr]['parenthesis_closer'] === null
$openBracket = $tokens[$stackPtr]['parenthesis_opener'];
$closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
if (strtolower($tokens[$stackPtr]['content']) === 'function') {
// Must be one space after the FUNCTION keyword.
if ($tokens[($stackPtr + 1 )]['content'] === $phpcsFile->eolChar ) {
} else if ($tokens[($stackPtr + 1 )]['code'] === T_WHITESPACE ) {
$spaces = strlen($tokens[($stackPtr + 1 )]['content']);
$error = 'Expected 1 space after FUNCTION keyword; %s found';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'SpaceAfterFunction', $data);
$phpcsFile->fixer ->addContent ($stackPtr, ' ');
$phpcsFile->fixer ->replaceToken (($stackPtr + 1 ), ' ');
// Must be one space before the opening parenthesis. For closures, this is
// enforced by the first check because there is no content between the keywords
// and the opening parenthesis.
if ($tokens[$stackPtr]['code'] === T_FUNCTION ) {
if ($tokens[($openBracket - 1 )]['content'] === $phpcsFile->eolChar ) {
} else if ($tokens[($openBracket - 1 )]['code'] === T_WHITESPACE ) {
$spaces = strlen($tokens[($openBracket - 1 )]['content']);
$error = 'Expected 0 spaces before opening parenthesis; %s found';
$fix = $phpcsFile->addFixableError ($error, $openBracket, 'SpaceBeforeOpenParen', $data);
$phpcsFile->fixer ->replaceToken (($openBracket - 1 ), '');
// Must be one space before and after USE keyword for closures.
if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
$use = $phpcsFile->findNext (T_USE , ($closeBracket + 1 ), $tokens[$stackPtr]['scope_opener']);
if ($tokens[($use + 1 )]['code'] !== T_WHITESPACE ) {
} else if ($tokens[($use + 1 )]['content'] === "\t") {
$length = strlen($tokens[($use + 1 )]['content']);
$error = 'Expected 1 space after USE keyword; found %s';
$fix = $phpcsFile->addFixableError ($error, $use, 'SpaceAfterUse', $data);
$phpcsFile->fixer ->addContent ($use, ' ');
$phpcsFile->fixer ->replaceToken (($use + 1 ), ' ');
if ($tokens[($use - 1 )]['code'] !== T_WHITESPACE ) {
} else if ($tokens[($use - 1 )]['content'] === "\t") {
$length = strlen($tokens[($use - 1 )]['content']);
$error = 'Expected 1 space before USE keyword; found %s';
$fix = $phpcsFile->addFixableError ($error, $use, 'SpaceBeforeUse', $data);
$phpcsFile->fixer ->addContentBefore ($use, ' ');
$phpcsFile->fixer ->replaceToken (($use - 1 ), ' ');
if ($this->isMultiLineDeclaration ($phpcsFile, $stackPtr, $openBracket, $tokens) === true ) {
$this->processMultiLineDeclaration ($phpcsFile, $stackPtr, $tokens);
$this->processSingleLineDeclaration ($phpcsFile, $stackPtr, $tokens);
* Determine if this is a multi-line function declaration.
* @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.
* @param int $openBracket The position of the opening bracket
* in the stack passed in $tokens.
* @param array $tokens The stack of tokens that make up
public function isMultiLineDeclaration ($phpcsFile, $stackPtr, $openBracket, $tokens)
$closeBracket = $tokens[$openBracket]['parenthesis_closer'];
if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) {
// Closures may use the USE keyword and so be multi-line in this way.
if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
$use = $phpcsFile->findNext (T_USE , ($closeBracket + 1 ), $tokens[$stackPtr]['scope_opener']);
// If the opening and closing parenthesis of the use statement
// are also on the same line, this is a single line declaration.
$close = $tokens[$open]['parenthesis_closer'];
if ($tokens[$open]['line'] !== $tokens[$close]['line']) {
}//end isMultiLineDeclaration()
* Processes single-line declarations.
* Just uses the Generic BSD-Allman brace sniff.
* @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.
* @param array $tokens The stack of tokens that make up
public function processSingleLineDeclaration ($phpcsFile, $stackPtr, $tokens)
if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
$sniff = new OpeningFunctionBraceKernighanRitchieSniff ();
$sniff = new OpeningFunctionBraceBsdAllmanSniff ();
$sniff->checkClosures = true;
$sniff->process ($phpcsFile, $stackPtr);
}//end processSingleLineDeclaration()
* Processes multi-line declarations.
* @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.
* @param array $tokens The stack of tokens that make up
public function processMultiLineDeclaration ($phpcsFile, $stackPtr, $tokens)
// We need to work out how far indented the function
// declaration itself is, so we can work out how far to
for ($i = ($stackPtr - 1 ); $i >= 0; $i-- ) {
if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
if ($tokens[$i]['code'] === T_WHITESPACE ) {
$functionIndent = strlen($tokens[$i]['content']);
// The closing parenthesis must be on a new line, even
// when checking abstract function definitions.
$closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
$prev = $phpcsFile->findPrevious (
if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']) {
if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
$error = 'The closing parenthesis of a multi-line function declaration must be on a new line';
$fix = $phpcsFile->addFixableError ($error, $closeBracket, 'CloseBracketLine');
$phpcsFile->fixer ->addNewlineBefore ($closeBracket);
// If this is a closure and is using a USE statement, the closing
// parenthesis we need to look at from now on is the closing parenthesis
if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
$use = $phpcsFile->findNext (T_USE , ($closeBracket + 1 ), $tokens[$stackPtr]['scope_opener']);
$closeBracket = $tokens[$open]['parenthesis_closer'];
$prev = $phpcsFile->findPrevious (
if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']) {
if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
$error = 'The closing parenthesis of a multi-line use declaration must be on a new line';
$fix = $phpcsFile->addFixableError ($error, $closeBracket, 'UseCloseBracketLine');
$phpcsFile->fixer ->addNewlineBefore ($closeBracket);
// Each line between the parenthesis should be indented 4 spaces.
$openBracket = $tokens[$stackPtr]['parenthesis_opener'];
$lastLine = $tokens[$openBracket]['line'];
for ($i = ($openBracket + 1 ); $i < $closeBracket; $i++ ) {
if ($tokens[$i]['line'] !== $lastLine) {
if ($i === $tokens[$stackPtr]['parenthesis_closer']
|| ($tokens[$i]['code'] === T_WHITESPACE
&& (($i + 1 ) === $closeBracket
|| ($i + 1 ) === $tokens[$stackPtr]['parenthesis_closer']))
// Closing braces need to be indented to the same level
$expectedIndent = $functionIndent;
$expectedIndent = ($functionIndent + $this->indent);
// We changed lines, so this should be a whitespace indent token.
if ($tokens[$i]['code'] !== T_WHITESPACE ) {
} else if ($tokens[$i]['line'] !== $tokens[($i + 1 )]['line']) {
// This is an empty line, so don't check the indent.
$foundIndent = $expectedIndent;
$error = 'Blank lines are not allowed in a multi-line function declaration';
$fix = $phpcsFile->addFixableError ($error, $i, 'EmptyLine');
$phpcsFile->fixer ->replaceToken ($i, '');
$foundIndent = strlen($tokens[$i]['content']);
if ($expectedIndent !== $foundIndent) {
$error = 'Multi-line function declaration not indented correctly; expected %s spaces but found %s';
$fix = $phpcsFile->addFixableError ($error, $i, 'Indent', $data);
if ($foundIndent === 0 ) {
$phpcsFile->fixer ->addContentBefore ($i, $spaces);
$phpcsFile->fixer ->replaceToken ($i, $spaces);
$lastLine = $tokens[$i]['line'];
// Skip arrays as they have their own indentation rules.
$i = $tokens[$i]['bracket_closer'];
$i = $tokens[$i]['parenthesis_closer'];
$lastLine = $tokens[$i]['line'];
if (isset ($tokens[$stackPtr]['scope_opener']) === false ) {
// The opening brace needs to be one space away from the closing parenthesis.
$opener = $tokens[$stackPtr]['scope_opener'];
if ($tokens[$opener]['line'] !== $tokens[$closeBracket]['line']) {
$error = 'The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line';
$fix = $phpcsFile->addFixableError ($error, $opener, 'NewlineBeforeOpenBrace');
$prev = $phpcsFile->findPrevious (Tokens ::$emptyTokens, ($opener - 1 ), $closeBracket, true );
$phpcsFile->fixer ->beginChangeset ();
$phpcsFile->fixer ->addContent ($prev, ' {');
// If the opener is on a line by itself, removing it will create
// an empty line, so just remove the entire line instead.
$prev = $phpcsFile->findPrevious (T_WHITESPACE , ($opener - 1 ), $closeBracket, true );
$next = $phpcsFile->findNext (T_WHITESPACE , ($opener + 1 ), null , true );
if ($tokens[$prev]['line'] < $tokens[$opener]['line']
&& $tokens[$next]['line'] > $tokens[$opener]['line']
for ($i = ($prev + 1 ); $i < $next; $i++ ) {
if ($tokens[$i]['line'] === $tokens[$opener]['line']) {
$phpcsFile->fixer ->replaceToken ($i, '');
// Just remove the opener.
$phpcsFile->fixer ->replaceToken ($opener, '');
if ($tokens[$next]['line'] === $tokens[$opener]['line']) {
$phpcsFile->fixer ->replaceToken (($opener + 1 ), '');
$phpcsFile->fixer ->endChangeset ();
$prev = $tokens[($opener - 1 )];
if ($prev['code'] !== T_WHITESPACE ) {
$length = strlen($prev['content']);
$error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found %s spaces';
$fix = $phpcsFile->addFixableError ($error, ($opener - 1 ), 'SpaceBeforeOpenBrace', array ($length));
$phpcsFile->fixer ->addContentBefore ($opener, ' ');
$phpcsFile->fixer ->replaceToken (($opener - 1 ), ' ');
}//end processMultiLineDeclaration()
Documentation generated on Mon, 11 Mar 2019 15:27:32 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|