ObjectOperatorSpacingSniff
extends ObjectOperatorSpacingSniff
in package
Ensure there is no whitespace before/after an object operator.
Difference with the upstream sniff:
- When the
::operator is used in::class, no new line(s) before or after the object operator are allowed.
Tags
Table of Contents
Properties
- $ignoreNewlines : bool
- Allow newlines instead of spaces.
Methods
- process() : void|int
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, int|string>
- Returns an array of tokens this test wants to listen for.
- checkSpacingAfterOperator() : bool
- Check the spacing after the operator.
- checkSpacingBeforeOperator() : bool
- Check the spacing before the operator.
Properties
$ignoreNewlines
Allow newlines instead of spaces.
public
bool
$ignoreNewlines
= false
Methods
process()
Processes this test, when one of its tokens is encountered.
public
process(File $phpcsFile, int $stackPtr) : void|int
Parameters
- $phpcsFile : File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Return values
void|int —Optionally returns a stack pointer. The sniff will not be called again on the current file until the returned stack pointer is reached.
register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, int|string>
Return values
array<string|int, int|string>checkSpacingAfterOperator()
Check the spacing after the operator.
protected
checkSpacingAfterOperator(File $phpcsFile, int $stackPtr, mixed $after) : bool
Parameters
- $phpcsFile : File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $after : mixed
-
The number of spaces found after the operator or the string 'newline'.
Return values
bool —true if there was no error, false otherwise.
checkSpacingBeforeOperator()
Check the spacing before the operator.
protected
checkSpacingBeforeOperator(File $phpcsFile, int $stackPtr, mixed $before) : bool
Parameters
- $phpcsFile : File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $before : mixed
-
The number of spaces found before the operator or the string 'newline'.
Return values
bool —true if there was no error, false otherwise.