Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff
in package
implements
PHP_CodeSniffer_Sniff
Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff.
Checks alignment of assignments. If there are multiple adjacent assignments, it will check that the equals signs of each assignment are aligned. It will display a warning to advise that the signs should be aligned.
Tags
Interfaces, Classes and Traits
- PHP_CodeSniffer_Sniff
- Represents a PHP_CodeSniffer sniff for sniffing coding standards.
Table of Contents
- $error : bool
- If true, an error will be thrown; otherwise a warning.
- $maxPadding : int
- The maximum amount of padding before the alignment is ignored.
- $supportedTokenizers : array<string|int, mixed>
- A list of tokenizers this sniff supports.
- checkAlignment() : int
- Processes this test, when one of its tokens is encountered.
- process() : int
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, mixed>
- Returns an array of tokens this test wants to listen for.
Properties
$error
If true, an error will be thrown; otherwise a warning.
public
bool
$error
= alse
$maxPadding
The maximum amount of padding before the alignment is ignored.
public
int
$maxPadding
= 1000
If the amount of padding required to align this assignment with the surrounding assignments exceeds this number, the assignment will be ignored and no errors or warnings will be thrown.
$supportedTokenizers
A list of tokenizers this sniff supports.
public
array<string|int, mixed>
$supportedTokenizers
= array('PHP', 'JS')
Methods
checkAlignment()
Processes this test, when one of its tokens is encountered.
public
checkAlignment(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : int
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
int —process()
Processes this test, when one of its tokens is encountered.
public
process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : int
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
int —register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, mixed>