Source for file FunctionDeclarationArgumentSpacingSniff.php
Documentation is available at FunctionDeclarationArgumentSpacingSniff.php
* Checks that arguments in function declarations are spaced 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\Squiz\Sniffs\Functions;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class FunctionDeclarationArgumentSpacingSniff implements Sniff
* How many spaces should surround the equals signs.
public $equalsSpacing = 0;
* How many spaces should follow the opening bracket.
public $requiredSpacesAfterOpen = 0;
* How many spaces should precede the closing bracket.
public $requiredSpacesBeforeClose = 0;
* 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
$this->equalsSpacing = (int) $this->equalsSpacing;
$this->requiredSpacesAfterOpen = (int) $this->requiredSpacesAfterOpen;
$this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose;
$openBracket = $tokens[$stackPtr]['parenthesis_opener'];
$this->processBracket ($phpcsFile, $openBracket);
if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
$use = $phpcsFile->findNext (T_USE , ($tokens[$openBracket]['parenthesis_closer'] + 1 ), $tokens[$stackPtr]['scope_opener']);
$this->processBracket ($phpcsFile, $openBracket);
* Processes the contents of a single set of brackets.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $openBracket The position of the open bracket
* in the stack passed in $tokens.
public function processBracket ($phpcsFile, $openBracket)
$tokens = $phpcsFile->getTokens ();
$closeBracket = $tokens[$openBracket]['parenthesis_closer'];
$multiLine = ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']);
$nextParam = $openBracket;
while (($nextParam = $phpcsFile->findNext (T_VARIABLE , ($nextParam + 1 ), $closeBracket)) !== false ) {
$nextToken = $phpcsFile->findNext (T_WHITESPACE , ($nextParam + 1 ), ($closeBracket + 1 ), true );
if ($nextToken === false ) {
$nextCode = $tokens[$nextToken]['code'];
// Check parameter default spacing.
if (($nextToken - $nextParam) > 1 ) {
$spacesBefore = strlen($tokens[($nextParam + 1 )]['content']);
if ($spacesBefore !== $this->equalsSpacing) {
$error = 'Incorrect spacing between argument "%s" and equals sign; expected '. $this->equalsSpacing. ' but found %s';
$tokens[$nextParam]['content'],
$fix = $phpcsFile->addFixableError ($error, $nextToken, 'SpaceBeforeEquals', $data);
if ($spacesBefore === 0 ) {
$phpcsFile->fixer ->addContentBefore ($nextToken, $padding);
$phpcsFile->fixer ->replaceToken (($nextToken - 1 ), $padding);
if ($tokens[($nextToken + 1 )]['code'] === T_WHITESPACE ) {
$spacesAfter = strlen($tokens[($nextToken + 1 )]['content']);
if ($spacesAfter !== $this->equalsSpacing) {
$error = 'Incorrect spacing between default value and equals sign for argument "%s"; expected '. $this->equalsSpacing. ' but found %s';
$tokens[$nextParam]['content'],
$fix = $phpcsFile->addFixableError ($error, $nextToken, 'SpaceAfterDefault', $data);
if ($spacesAfter === 0 ) {
$phpcsFile->fixer ->addContent ($nextToken, $padding);
$phpcsFile->fixer ->replaceToken (($nextToken + 1 ), $padding);
// Find and check the comma (if there is one).
$nextComma = $phpcsFile->findNext (T_COMMA, ($nextParam + 1 ), $closeBracket);
if ($nextComma !== false ) {
if ($tokens[($nextComma - 1 )]['code'] === T_WHITESPACE ) {
$error = 'Expected 0 spaces between argument "%s" and comma; %s found';
$tokens[$nextParam]['content'],
strlen($tokens[($nextComma - 1 )]['content']),
$fix = $phpcsFile->addFixableError ($error, $nextToken, 'SpaceBeforeComma', $data);
$phpcsFile->fixer ->replaceToken (($nextComma - 1 ), '');
$checkToken = ($nextParam - 1 );
$prev = $phpcsFile->findPrevious (T_WHITESPACE , $checkToken, null , true );
$checkToken = ($prev - 1 );
// Take references into account when expecting the
// location of whitespace.
if ($phpcsFile->isReference ($checkToken) === true ) {
$whitespace = ($checkToken - 1 );
$whitespace = $checkToken;
if (empty ($params) === false ) {
// This is not the first argument in the function declaration.
$arg = $tokens[$nextParam]['content'];
// Before we throw an error, make sure there is no type hint.
$comma = $phpcsFile->findPrevious (T_COMMA, ($nextParam - 1 ));
$nextToken = $phpcsFile->findNext (T_WHITESPACE , ($comma + 1 ), null , true );
if ($phpcsFile->isReference ($nextToken) === true ) {
if ($tokens[$whitespace]['code'] === T_WHITESPACE ) {
$gap = strlen($tokens[$whitespace]['content']);
if ($nextToken !== $nextParam) {
// There was a type hint, so check the spacing between
// the hint and the variable as well.
$hint = $tokens[$nextToken]['content'];
$error = 'Expected 1 space between type hint and argument "%s"; %s found';
$fix = $phpcsFile->addFixableError ($error, $nextToken, 'SpacingAfterHint', $data);
$phpcsFile->fixer ->addContent ($whitespace, ' ');
$phpcsFile->fixer ->replaceToken ($whitespace, ' ');
if ($multiLine === false ) {
if ($tokens[($comma + 1 )]['code'] !== T_WHITESPACE ) {
$error = 'Expected 1 space between comma and type hint "%s"; 0 found';
$fix = $phpcsFile->addFixableError ($error, $nextToken, 'NoSpaceBeforeHint', $data);
$phpcsFile->fixer ->addContent ($comma, ' ');
$gap = strlen($tokens[($comma + 1 )]['content']);
$error = 'Expected 1 space between comma and type hint "%s"; %s found';
$fix = $phpcsFile->addFixableError ($error, $nextToken, 'SpacingBeforeHint', $data);
$phpcsFile->fixer ->replaceToken (($comma + 1 ), ' ');
$error = 'Expected 1 space between comma and argument "%s"; 0 found';
$fix = $phpcsFile->addFixableError ($error, $nextToken, 'NoSpaceBeforeArg', $data);
$phpcsFile->fixer ->addContent ($whitespace, ' ');
// Just make sure this is not actually an indent.
if ($tokens[$whitespace]['line'] === $tokens[($whitespace - 1 )]['line']) {
$error = 'Expected 1 space between comma and argument "%s"; %s found';
$fix = $phpcsFile->addFixableError ($error, $nextToken, 'SpacingBeforeArg', $data);
$phpcsFile->fixer ->replaceToken ($whitespace, ' ');
if ($tokens[$whitespace]['code'] === T_WHITESPACE ) {
$gap = strlen($tokens[$whitespace]['content']);
$arg = $tokens[$nextParam]['content'];
// Before we throw an error, make sure there is no type hint.
$nextToken = $phpcsFile->findNext (T_WHITESPACE , ($bracket + 1 ), null , true );
if ($phpcsFile->isReference ($nextToken) === true ) {
if ($tokens[$nextToken]['code'] !== T_ELLIPSIS && $nextToken !== $nextParam) {
// There was a type hint, so check the spacing between
// the hint and the variable as well.
$hint = $tokens[$nextToken]['content'];
$error = 'Expected 1 space between type hint and argument "%s"; %s found';
$fix = $phpcsFile->addFixableError ($error, $nextToken, 'SpacingAfterHint', $data);
$phpcsFile->fixer ->addContent ($nextToken, ' ');
$phpcsFile->fixer ->replaceToken (($nextToken + 1 ), ' ');
if ($tokens[($bracket + 1 )]['code'] === T_WHITESPACE ) {
$spaceAfterOpen = strlen($tokens[($bracket + 1 )]['content']);
if ($multiLine === false && $spaceAfterOpen !== $this->requiredSpacesAfterOpen) {
$error = 'Expected %s spaces between opening bracket and type hint "%s"; %s found';
$this->requiredSpacesAfterOpen,
$fix = $phpcsFile->addFixableError ($error, $nextToken, 'SpacingAfterOpenHint', $data);
$padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
if ($spaceAfterOpen === 0 ) {
$phpcsFile->fixer ->addContent ($openBracket, $padding);
$phpcsFile->fixer ->replaceToken (($openBracket + 1 ), $padding);
} else if ($multiLine === false && $gap !== $this->requiredSpacesAfterOpen) {
$error = 'Expected %s spaces between opening bracket and argument "%s"; %s found';
$this->requiredSpacesAfterOpen,
$fix = $phpcsFile->addFixableError ($error, $nextToken, 'SpacingAfterOpen', $data);
$padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
$phpcsFile->fixer ->addContent ($openBracket, $padding);
$phpcsFile->fixer ->replaceToken (($openBracket + 1 ), $padding);
if ($tokens[($closeBracket - 1 )]['code'] === T_WHITESPACE ) {
$gap = strlen($tokens[($closeBracket - 1 )]['content']);
if (empty ($params) === true ) {
// There are no parameters for this function.
if (($closeBracket - $openBracket) !== 1 ) {
$error = 'Expected 0 spaces between brackets of function declaration; %s found';
$fix = $phpcsFile->addFixableError ($error, $openBracket, 'SpacingBetween', $data);
$phpcsFile->fixer ->replaceToken (($openBracket + 1 ), '');
} else if ($multiLine === false && $gap !== $this->requiredSpacesBeforeClose) {
$error = 'Expected %s spaces between argument "%s" and closing bracket; %s found';
$this->requiredSpacesBeforeClose,
$tokens[$lastParam]['content'],
$fix = $phpcsFile->addFixableError ($error, $closeBracket, 'SpacingBeforeClose', $data);
$padding = str_repeat(' ', $this->requiredSpacesBeforeClose);
$phpcsFile->fixer ->addContentBefore ($closeBracket, $padding);
$phpcsFile->fixer ->replaceToken (($closeBracket - 1 ), $padding);
Documentation generated on Mon, 11 Mar 2019 15:27:32 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|