class DisallowMultipleStatementsSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\DisallowMultipleStatementsSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of DisallowMultipleStatementsSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ Generic/ Sniffs/ Formatting/ DisallowMultipleStatementsSniff.php, line 15
Namespace
PHP_CodeSniffer\Standards\Generic\Sniffs\FormattingView source
class DisallowMultipleStatementsSniff implements Sniff {
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register() {
return [
T_SEMICOLON,
];
}
//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();
$fixable = true;
$prev = $stackPtr;
do {
$prev = $phpcsFile->findPrevious([
T_SEMICOLON,
T_OPEN_TAG,
T_OPEN_TAG_WITH_ECHO,
T_PHPCS_IGNORE,
], $prev - 1);
if ($prev === false || $tokens[$prev]['code'] === T_OPEN_TAG || $tokens[$prev]['code'] === T_OPEN_TAG_WITH_ECHO) {
$phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no');
return;
}
if ($tokens[$prev]['code'] === T_PHPCS_IGNORE) {
$fixable = false;
}
} while ($tokens[$prev]['code'] === T_PHPCS_IGNORE);
// Ignore multiple statements in a FOR condition.
foreach ([
$stackPtr,
$prev,
] as $checkToken) {
if (isset($tokens[$checkToken]['nested_parenthesis']) === true) {
foreach ($tokens[$checkToken]['nested_parenthesis'] as $bracket) {
if (isset($tokens[$bracket]['parenthesis_owner']) === false) {
// Probably a closure sitting inside a function call.
continue;
}
$owner = $tokens[$bracket]['parenthesis_owner'];
if ($tokens[$owner]['code'] === T_FOR) {
return;
}
}
}
}
if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
$phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'yes');
$error = 'Each PHP statement must be on a line by itself';
$code = 'SameLine';
if ($fixable === false) {
$phpcsFile->addError($error, $stackPtr, $code);
return;
}
$fix = $phpcsFile->addFixableError($error, $stackPtr, $code);
if ($fix === true) {
$phpcsFile->fixer
->beginChangeset();
$phpcsFile->fixer
->addNewline($prev);
if ($tokens[$prev + 1]['code'] === T_WHITESPACE) {
$phpcsFile->fixer
->replaceToken($prev + 1, '');
}
$phpcsFile->fixer
->endChangeset();
}
}
else {
$phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no');
}
//end if
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
DisallowMultipleStatementsSniff::process | public | function | Processes this test, when one of its tokens is encountered. | Overrides Sniff::process |
DisallowMultipleStatementsSniff::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |