DebugCodeSniff
in package
implements
Sniff, DeprecatedSniff
Table of Contents
Interfaces
Methods
- getDeprecationMessage() : string
- Provide a custom message to display with the deprecation.
- getDeprecationVersion() : string
- Provide the version number in which the sniff was deprecated.
- getRemovalVersion() : string
- Provide the version number in which the sniff will be removed.
- process() : void
- Processes this sniff, when one of its tokens is encountered.
- register() : array<string|int, int|string>
- Returns an array of tokens this test wants to listen for.
Methods
getDeprecationMessage()
Provide a custom message to display with the deprecation.
public
getDeprecationMessage() : string
Return values
stringgetDeprecationVersion()
Provide the version number in which the sniff was deprecated.
public
getDeprecationVersion() : string
Return values
stringgetRemovalVersion()
Provide the version number in which the sniff will be removed.
public
getRemovalVersion() : string
Return values
stringprocess()
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.
register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, int|string>