AbstractVariableSniff
extends AbstractScopeSniff
in package
Table of Contents
- $phpReservedVars : array<string|int, mixed>
- List of PHP Reserved variables.
- $listenOutside : bool
- True if this test should fire on tokens outside of the scope.
- $scopeTokens : string
- The type of scope opener tokens that this test wishes to listen to.
- $tokens : array<string|int, mixed>
- The token types that this test wishes to listen to within the scope.
- __construct() : mixed
- Constructs an AbstractVariableTest.
- process() : void|int
- Processes the tokens that this test is listening for.
- register() : array<string|int, int>
- The method that is called to register the tokens this test wishes to listen to.
- processMemberVar() : void|int
- Called to process class member vars.
- processTokenOutsideScope() : void|int
- Processes the token outside the scope in the file.
- processTokenWithinScope() : void|int
- Processes the token in the specified PHP_CodeSniffer\Files\File.
- processVariable() : void|int
- Called to process normal member vars.
- processVariableInString() : void|int
- Called to process variables found in double quoted strings or heredocs.
Properties
$phpReservedVars
List of PHP Reserved variables.
protected
array<string|int, mixed>
$phpReservedVars
= ['_SERVER' => true, '_GET' => true, '_POST' => true, '_REQUEST' => true, '_SESSION' => true, '_ENV' => true, '_COOKIE' => true, '_FILES' => true, 'GLOBALS' => true, 'http_response_header' => true, 'HTTP_RAW_POST_DATA' => true, 'php_errormsg' => true]
Used by various naming convention sniffs.
$listenOutside
True if this test should fire on tokens outside of the scope.
private
bool
$listenOutside
= false
$scopeTokens
The type of scope opener tokens that this test wishes to listen to.
private
string
$scopeTokens
= []
$tokens
The token types that this test wishes to listen to within the scope.
private
array<string|int, mixed>
$tokens
= []
Methods
__construct()
Constructs an AbstractVariableTest.
public
__construct() : mixed
Return values
mixed —process()
Processes the tokens that this test is listening for.
public
final process(File $phpcsFile, int $stackPtr) : void|int
Parameters
- $phpcsFile : File
-
The file where this token was found.
- $stackPtr : int
-
The position in the stack where this token was found.
Tags
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. Return ($phpcsFile->numTokens + 1) to skip the rest of the file.
register()
The method that is called to register the tokens this test wishes to listen to.
public
final register() : array<string|int, int>
DO NOT OVERRIDE THIS METHOD. Use the constructor of this class to register for the desired tokens and scope.
Tags
Return values
array<string|int, int> —processMemberVar()
Called to process class member vars.
protected
abstract processMemberVar(File $phpcsFile, int $stackPtr) : void|int
Parameters
- $phpcsFile : File
-
The PHP_CodeSniffer file where this token was found.
- $stackPtr : int
-
The position where the token was found.
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. Return ($phpcsFile->numTokens + 1) to skip the rest of the file.
processTokenOutsideScope()
Processes the token outside the scope in the file.
protected
final processTokenOutsideScope(File $phpcsFile, int $stackPtr) : void|int
Parameters
- $phpcsFile : File
-
The PHP_CodeSniffer file where this token was found.
- $stackPtr : int
-
The position where the token was found.
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. Return ($phpcsFile->numTokens + 1) to skip the rest of the file.
processTokenWithinScope()
Processes the token in the specified PHP_CodeSniffer\Files\File.
protected
final processTokenWithinScope(File $phpcsFile, int $stackPtr, int $currScope) : void|int
Parameters
- $phpcsFile : File
-
The PHP_CodeSniffer file where this token was found.
- $stackPtr : int
-
The position where the token was found.
- $currScope : int
-
The current scope opener token.
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. Return ($phpcsFile->numTokens + 1) to skip the rest of the file.
processVariable()
Called to process normal member vars.
protected
abstract processVariable(File $phpcsFile, int $stackPtr) : void|int
Parameters
- $phpcsFile : File
-
The PHP_CodeSniffer file where this token was found.
- $stackPtr : int
-
The position where the token was found.
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. Return ($phpcsFile->numTokens + 1) to skip the rest of the file.
processVariableInString()
Called to process variables found in double quoted strings or heredocs.
protected
abstract processVariableInString(File $phpcsFile, int $stackPtr) : void|int
Note that there may be more than one variable in the string, which will result only in one call for the string or one call per line for heredocs.
Parameters
- $phpcsFile : File
-
The PHP_CodeSniffer file where this token was found.
- $stackPtr : int
-
The position where the double quoted string was found.
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. Return ($phpcsFile->numTokens + 1) to skip the rest of the file.