ForbiddenFunctionsSniff
in package
implements
Sniff
Forbidden Functions Sniff
Discourages the use of alias functions that are kept in PHP for compatibility with older versions. Can be used to forbid the use of any function.
Tags
Interfaces, Classes and Traits
Table of Contents
- $error : bool
- If true, an error will be thrown; otherwise a warning.
- $forbiddenFunctions : mixed
- A list of forbidden functions with their alternatives.
- $forbiddenFunctionNames : array<string|int, mixed>|(string)
- A cache of forbidden function names, for faster lookups.
- $patternMatch : bool
- If true, forbidden functions will be considered regular expressions.
- process() : void
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, mixed>
- Returns an array of tokens this test wants to listen for.
- addError() : void
- Generates the error or warning for this sniff.
Properties
$error
If true, an error will be thrown; otherwise a warning.
public
bool
$error
= true
$forbiddenFunctions
A list of forbidden functions with their alternatives.
public
mixed
$forbiddenFunctions
= ['sizeof' => 'count']
The value is NULL if no alternative exists. IE, the function should just not be used.
array|null)
$forbiddenFunctionNames
A cache of forbidden function names, for faster lookups.
protected
array<string|int, mixed>|(string)
$forbiddenFunctionNames
= []
$patternMatch
If true, forbidden functions will be considered regular expressions.
protected
bool
$patternMatch
= false
Methods
process()
Processes this test, 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>
Return values
array<string|int, mixed> —addError()
Generates the error or warning for this sniff.
protected
addError(File $phpcsFile, int $stackPtr, string $function[, string $pattern = null ]) : void
Parameters
- $phpcsFile : File
-
The file being scanned.
- $stackPtr : int
-
The position of the forbidden function in the token array.
- $function : string
-
The name of the forbidden function.
- $pattern : string = null
-
The pattern used for the match.