Squiz_Sniffs_Functions_FunctionDeclarationArgumentSpacingSniff
in package
implements
PHP_CodeSniffer_Sniff
Squiz_Sniffs_Functions_FunctionDeclarationArgumentSpacingSniff.
Checks that arguments in function declarations are spaced correctly.
Tags
Interfaces, Classes and Traits
- PHP_CodeSniffer_Sniff
- Represents a PHP_CodeSniffer sniff for sniffing coding standards.
Table of Contents
- $equalsSpacing : int
- How many spaces should surround the equals signs.
- $requiredSpacesAfterOpen : int
- How many spaces should follow the opening bracket.
- $requiredSpacesBeforeClose : int
- How many spaces should precede the closing bracket.
- process() : void
- Processes this test, when one of its tokens is encountered.
- processBracket() : void
- Processes the contents of a single set of brackets.
- register() : array<string|int, mixed>
- Returns an array of tokens this test wants to listen for.
Properties
$equalsSpacing
How many spaces should surround the equals signs.
public
int
$equalsSpacing
= 0
$requiredSpacesAfterOpen
How many spaces should follow the opening bracket.
public
int
$requiredSpacesAfterOpen
= 0
$requiredSpacesBeforeClose
How many spaces should precede the closing bracket.
public
int
$requiredSpacesBeforeClose
= 0
Methods
process()
Processes this test, when one of its tokens is encountered.
public
process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Return values
void —processBracket()
Processes the contents of a single set of brackets.
public
processBracket(PHP_CodeSniffer_File $phpcsFile, int $openBracket) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $openBracket : int
-
The position of the open bracket in the stack passed in $tokens.
Return values
void —register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, mixed>