Squiz_Sniffs_Arrays_ArrayDeclarationSniff
in package
implements
PHP_CodeSniffer_Sniff
A test to ensure that arrays conform to the array coding standard.
Tags
Interfaces, Classes and Traits
- PHP_CodeSniffer_Sniff
- Represents a PHP_CodeSniffer sniff for sniffing coding standards.
Table of Contents
- 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.
Methods
process()
Processes this sniff, when one of its tokens is encountered.
public
process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_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(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, int $arrayStart, int $arrayEnd) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_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.
Return values
void —processSingleLineArray()
Processes a single-line array definition.
public
processSingleLineArray(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, int $arrayStart, int $arrayEnd) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_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.
Return values
void —register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, mixed>