class ElseIfDeclarationSniff
Same name in this branch
- 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/ControlStructures/ElseIfDeclarationSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\ElseIfDeclarationSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\ElseIfDeclarationSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of ElseIfDeclarationSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ PSR2/ Sniffs/ ControlStructures/ ElseIfDeclarationSniff.php, line 15
Namespace
PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructuresView source
class ElseIfDeclarationSniff implements Sniff {
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register() {
return [
T_ELSE,
T_ELSEIF,
];
}
//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token in the
* stack passed in $tokens.
*
* @return void
*/
public function process(File $phpcsFile, $stackPtr) {
$tokens = $phpcsFile->getTokens();
if ($tokens[$stackPtr]['code'] === T_ELSEIF) {
$phpcsFile->recordMetric($stackPtr, 'Use of ELSE IF or ELSEIF', 'elseif');
return;
}
$next = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
if ($tokens[$next]['code'] === T_IF) {
$phpcsFile->recordMetric($stackPtr, 'Use of ELSE IF or ELSEIF', 'else if');
$error = 'Usage of ELSE IF is discouraged; use ELSEIF instead';
$fix = $phpcsFile->addFixableWarning($error, $stackPtr, 'NotAllowed');
if ($fix === true) {
$phpcsFile->fixer
->beginChangeset();
$phpcsFile->fixer
->replaceToken($stackPtr, 'elseif');
for ($i = $stackPtr + 1; $i <= $next; $i++) {
$phpcsFile->fixer
->replaceToken($i, '');
}
$phpcsFile->fixer
->endChangeset();
}
}
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
ElseIfDeclarationSniff::process | public | function | Processes this test, when one of its tokens is encountered. | Overrides Sniff::process |
ElseIfDeclarationSniff::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |