Class: MultipleStatementAlignmentSniff
Source Location: /PHP_CodeSniffer-3.0.0RC2/src/Standards/Generic/Sniffs/Formatting/MultipleStatementAlignmentSniff.php
Checks alignment of assignments.
Author(s):
Copyright:
- 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
Inherited Variables
Inherited Methods
Class Details
[line
19]
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.
Class Variables
$error = false
[line 37]
If true, an error will be thrown; otherwise a warning.
$maxPadding = 1000
[line 48]
The maximum amount of padding before the alignment is ignored.
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 = array(
'PHP',
'JS',
)
[line 27]
A list of tokenizers this sniff supports.
Method Detail
checkAlignment [line 102]
int checkAlignment(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)
Processes this test, when one of its tokens is encountered.
Parameters:
PHP_CodeSniffer_File
$phpcsFile
—
The file being scanned.
int
$stackPtr
—
The position of the current token in the stack passed in $tokens.
process [line 74]
int process(
File
$phpcsFile, int
$stackPtr)
Processes this test, when one of its tokens is encountered.
Parameters:
PHP_CodeSniffer_File
$phpcsFile
—
The file being scanned.
int
$stackPtr
—
The position of the current token in the stack passed in $tokens.
register [line 56]
Returns an array of tokens this test wants to listen for.
Documentation generated on 2019年3月11日 14:49:50 -0400 by
phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.