class RequireTrailingCommaInCallSniff
Hierarchy
- class \SlevomatCodingStandard\Sniffs\Functions\RequireTrailingCommaInCallSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of RequireTrailingCommaInCallSniff
File
-
vendor/
slevomat/ coding-standard/ SlevomatCodingStandard/ Sniffs/ Functions/ RequireTrailingCommaInCallSniff.php, line 22
Namespace
SlevomatCodingStandard\Sniffs\FunctionsView source
class RequireTrailingCommaInCallSniff implements Sniff {
public const CODE_MISSING_TRAILING_COMMA = 'MissingTrailingComma';
/** @var bool|null */
public $enable = null;
/**
* @return array<int, (int|string)>
*/
public function register() : array {
return [
T_OPEN_PARENTHESIS,
];
}
/**
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @param int $parenthesisOpenerPointer
*/
public function process(File $phpcsFile, $parenthesisOpenerPointer) : void {
$this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 70300);
if (!$this->enable) {
return;
}
$tokens = $phpcsFile->getTokens();
if (array_key_exists('parenthesis_owner', $tokens[$parenthesisOpenerPointer])) {
return;
}
$pointerBeforeParenthesisOpener = TokenHelper::findPreviousEffective($phpcsFile, $parenthesisOpenerPointer - 1);
if (!in_array($tokens[$pointerBeforeParenthesisOpener]['code'], array_merge(TokenHelper::getOnlyNameTokenCodes(), [
T_VARIABLE,
T_ISSET,
T_UNSET,
T_CLOSE_PARENTHESIS,
T_SELF,
T_STATIC,
T_PARENT,
]), true)) {
return;
}
$parenthesisCloserPointer = $tokens[$parenthesisOpenerPointer]['parenthesis_closer'];
if ($tokens[$parenthesisOpenerPointer]['line'] === $tokens[$parenthesisCloserPointer]['line']) {
return;
}
$pointerBeforeParenthesisCloser = TokenHelper::findPreviousEffective($phpcsFile, $parenthesisCloserPointer - 1);
if ($pointerBeforeParenthesisCloser === $parenthesisOpenerPointer) {
return;
}
if ($tokens[$parenthesisCloserPointer]['line'] === $tokens[$pointerBeforeParenthesisCloser]['line']) {
return;
}
if ($tokens[$pointerBeforeParenthesisCloser]['code'] === T_COMMA) {
return;
}
$fix = $phpcsFile->addFixableError('Multi-line function calls must have a trailing comma after the last parameter.', $pointerBeforeParenthesisCloser, self::CODE_MISSING_TRAILING_COMMA);
if (!$fix) {
return;
}
$phpcsFile->fixer
->beginChangeset();
$phpcsFile->fixer
->addContent($pointerBeforeParenthesisCloser, ',');
$phpcsFile->fixer
->endChangeset();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
RequireTrailingCommaInCallSniff::$enable | public | property | @var bool|null | |
RequireTrailingCommaInCallSniff::CODE_MISSING_TRAILING_COMMA | public | constant | ||
RequireTrailingCommaInCallSniff::process | public | function | * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint * |
Overrides Sniff::process |
RequireTrailingCommaInCallSniff::register | public | function | * | Overrides Sniff::register |