ValidMethodNameSniff
extends AbstractScopeSniff
in package
Valid Method Name Sniff
Checks class methods are lowerCameCase. Checks public methods are not prefixed with "" except methods defined in allowedPublicMethodNames. Checks private and protected methods are prefixed with "". Checks functions are snake_case. Warns if names are longer than 50 characters.
Tags
Table of Contents
- $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
- Defines which token(s) in which scope(s) will be proceed.
- 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.
- processTokenOutsideScope() : void
- Processes a token within the scope that this test is listening to.
- processTokenWithinScope() : void
- Processes the tokens within the scope.
Properties
$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()
Defines which token(s) in which scope(s) will be proceed.
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> —processTokenOutsideScope()
Processes a token within the scope that this test is listening to.
protected
processTokenOutsideScope(File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : File
-
The file where the token was found.
- $stackPtr : int
-
The position in the stack where this token was found.
Return values
void —processTokenWithinScope()
Processes the tokens within the scope.
protected
processTokenWithinScope(File $phpcsFile, int $stackPtr, int $currScope) : void
Parameters
- $phpcsFile : File
-
The file being processed.
- $stackPtr : int
-
The position where this token was found.
- $currScope : int
-
The position of the current scope.