ConstructorNameSniff
extends AbstractScopeSniff
in package
Table of Contents
- $currentClass : string
- The name of the class we are currently checking.
- $functionList : array<string|int, string>
- A list of functions in the current class.
- $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 the test with the tokens it wishes to listen for.
- 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.
- loadFunctionNamesInScope() : void
- Extracts all the function names found in the given scope.
- processTokenOutsideScope() : void
- Processes a token that is found within the scope that this test is listening to.
- processTokenWithinScope() : void
- Processes this test when one of its tokens is encountered.
Properties
$currentClass
The name of the class we are currently checking.
private
string
$currentClass
= ''
$functionList
A list of functions in the current class.
private
array<string|int, string>
$functionList
= []
$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 the test with the tokens it wishes to listen for.
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> —loadFunctionNamesInScope()
Extracts all the function names found in the given scope.
protected
loadFunctionNamesInScope(File $phpcsFile, int $currScope) : void
Parameters
- $phpcsFile : File
-
The current file being scanned.
- $currScope : int
-
A pointer to the start of the scope.
Return values
void —processTokenOutsideScope()
Processes a token that is found within the scope that this test is listening to.
protected
processTokenOutsideScope(File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : File
-
The file where this token was found.
- $stackPtr : int
-
The position in the stack where this token was found.
Return values
void —processTokenWithinScope()
Processes this test when one of its tokens is encountered.
protected
processTokenWithinScope(File $phpcsFile, int $stackPtr, int $currScope) : void
Parameters
- $phpcsFile : File
-
The current file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $currScope : int
-
A pointer to the start of the scope.