class UnsilencedDeprecationSniff
Checks that the trigger_error deprecation is silenced by a preceding '@'.
@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer
Hierarchy
- class \Drupal\Sniffs\Semantics\FunctionCall implements \PHP_CodeSniffer\Sniffs\Sniff
- class \Drupal\Sniffs\Semantics\UnsilencedDeprecationSniff extends \Drupal\Sniffs\Semantics\FunctionCall
Expanded class hierarchy of UnsilencedDeprecationSniff
File
-
vendor/
drupal/ coder/ coder_sniffer/ Drupal/ Sniffs/ Semantics/ UnsilencedDeprecationSniff.php, line 21
Namespace
Drupal\Sniffs\SemanticsView source
class UnsilencedDeprecationSniff extends FunctionCall {
/**
* Returns an array of function names this test wants to listen for.
*
* @return array<string>
*/
public function registerFunctionNames() {
return [
'trigger_error',
];
}
//end registerFunctionNames()
/**
* Processes this function call.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the function call in
* the stack.
* @param int $openBracket The position of the opening
* parenthesis in the stack.
* @param int $closeBracket The position of the closing
* parenthesis in the stack.
*
* @return void
*/
public function processFunctionCall(file $phpcsFile, $stackPtr, $openBracket, $closeBracket) {
$tokens = $phpcsFile->getTokens();
$argument = $this->getArgument(2);
// If no second argument then quit.
if ($argument === false) {
return;
}
// Only check deprecation messages.
if (strcasecmp($tokens[$argument['start']]['content'], 'E_USER_DEPRECATED') !== 0) {
return;
}
if ($tokens[$stackPtr - 1]['type'] !== 'T_ASPERAND') {
$error = 'All trigger_error calls used for deprecation must be prefixed by an "@"';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'UnsilencedDeprecation');
if ($fix === true) {
$phpcsFile->fixer
->addContentBefore($stackPtr, '@');
}
}
}
//end processFunctionCall()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
FunctionCall::$arguments | protected | property | Internal cache to save the calculated arguments of the function call. | ||
FunctionCall::$closeBracket | protected | property | The token position of the closing bracket of the function call. | ||
FunctionCall::$functionCall | protected | property | The token position of the function call. | ||
FunctionCall::$includeMethodCalls | protected | property | Whether method invocations with the same function name should be processed, too. |
1 | |
FunctionCall::$openBracket | protected | property | The token position of the opening bracket of the function call. | ||
FunctionCall::$phpcsFile | protected | property | The currently processed file. | ||
FunctionCall::getArgument | public | function | Returns start and end token for a given argument number. | ||
FunctionCall::isFunctionCall | protected | function | Checks if this is a function call. | ||
FunctionCall::process | public | function | Processes this test, when one of its tokens is encountered. | Overrides Sniff::process | 2 |
FunctionCall::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register | |
UnsilencedDeprecationSniff::processFunctionCall | public | function | Processes this function call. | ||
UnsilencedDeprecationSniff::registerFunctionNames | public | function | Returns an array of function names this test wants to listen for. |