HelperFileSniff
in package
implements
Sniff
Helper File Sniff
Checks *_helper.php files only contain functions and that the filename is lower snake_case.
Tags
Interfaces, Classes and Traits
Table of Contents
- $unwantedTokens : array<string|int, mixed>
- Files that are allowed multiple classes
- $badFilename : bool
- If the file has a bad filename.
- process() : void
- Processes this sniff, when one of its tokens is encountered.
- register() : array<string|int, mixed>
- Returns an array of tokens this test wants to listen for.
Properties
$unwantedTokens
Files that are allowed multiple classes
public
array<string|int, mixed>
$unwantedTokens
= [T_CLASS, T_ANON_CLASS, T_INTERFACE, T_TRAIT]
$badFilename
If the file has a bad filename.
protected
bool
$badFilename
= false
Change to true and check it later to avoid displaying multiple errors.
Methods
process()
Processes this sniff, when one of its tokens is encountered.
public
process(File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Return values
void —register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, mixed>