PostStatementCommentSniff
in package
implements
Sniff
Interfaces, Classes and Traits
Table of Contents
- $supportedTokenizers : array<string|int, mixed>
- A list of tokenizers this sniff supports.
- $controlStructureExceptions : array<string|int, mixed>
- Exceptions to the rule.
- 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
$supportedTokenizers
A list of tokenizers this sniff supports.
public
array<string|int, mixed>
$supportedTokenizers
= ['PHP', 'JS']
$controlStructureExceptions
Exceptions to the rule.
private
array<string|int, mixed>
$controlStructureExceptions
= [T_IF => true, T_ELSEIF => true, T_SWITCH => true, T_WHILE => true, T_FOR => true, T_FOREACH => true, T_MATCH => true]
If post statement comments are found within the condition parenthesis of these structures, leave them alone.
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>