AbstractArraySniffTestable
extends AbstractArraySniff
in package
Table of Contents
- $indicies : array<string|int, mixed>
- The array indicies that were found during processing.
- process() : void
- Processes this sniff, when one of its tokens is encountered.
- processMultiLineArray() : void
- Processes a multi-line array definition.
- processSingleLineArray() : void
- Processes a single-line array definition.
- register() : array<string|int, mixed>
- Returns an array of tokens this test wants to listen for.
- getNext() : int
- Find next separator in array - either: comma or double arrow.
Properties
$indicies
The array indicies that were found during processing.
public
array<string|int, mixed>
$indicies
= []
Methods
process()
Processes this sniff, when one of its tokens is encountered.
public
process(File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : File
-
The current file being checked.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Return values
void —processMultiLineArray()
Processes a multi-line array definition.
public
processMultiLineArray(File $phpcsFile, int $stackPtr, int $arrayStart, int $arrayEnd, array<string|int, mixed> $indices) : void
Parameters
- $phpcsFile : File
-
The current file being checked.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $arrayStart : int
-
The token that starts the array definition.
- $arrayEnd : int
-
The token that ends the array definition.
- $indices : array<string|int, mixed>
-
An array of token positions for the array keys, double arrows, and values.
Return values
void —processSingleLineArray()
Processes a single-line array definition.
public
processSingleLineArray(File $phpcsFile, int $stackPtr, int $arrayStart, int $arrayEnd, array<string|int, mixed> $indices) : void
Parameters
- $phpcsFile : File
-
The current file being checked.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $arrayStart : int
-
The token that starts the array definition.
- $arrayEnd : int
-
The token that ends the array definition.
- $indices : array<string|int, mixed>
-
An array of token positions for the array keys, double arrows, and values.
Return values
void —register()
Returns an array of tokens this test wants to listen for.
public
final register() : array<string|int, mixed>
Return values
array<string|int, mixed> —getNext()
Find next separator in array - either: comma or double arrow.
private
getNext(File $phpcsFile, int $ptr, int $arrayEnd) : int
Parameters
- $phpcsFile : File
-
The current file being checked.
- $ptr : int
-
The position of current token.
- $arrayEnd : int
-
The token that ends the array definition.