FileCommentSniff
in package
implements
Sniff
Table of Contents
Interfaces
Constants
- REQUIRED_TAGS = ['@package' => true, '@subpackage' => true, '@author' => true, '@copyright' => true]
- Required tags in correct order.
Methods
- process() : int
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, int|string>
- Returns an array of tokens this test wants to listen for.
Constants
REQUIRED_TAGS
Required tags in correct order.
private
array<string, true>
REQUIRED_TAGS
= ['@package' => true, '@subpackage' => true, '@author' => true, '@copyright' => true]
Methods
process()
Processes this test, when one of its tokens is encountered.
public
process(File $phpcsFile, int $stackPtr) : int
Parameters
- $phpcsFile : File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Return values
intregister()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, int|string>