class RequireTrailingCommaInDeclarationSniff
Hierarchy
- class \SlevomatCodingStandard\Sniffs\Functions\RequireTrailingCommaInDeclarationSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of RequireTrailingCommaInDeclarationSniff
File
-
vendor/
slevomat/ coding-standard/ SlevomatCodingStandard/ Sniffs/ Functions/ RequireTrailingCommaInDeclarationSniff.php, line 11
Namespace
SlevomatCodingStandard\Sniffs\FunctionsView source
class RequireTrailingCommaInDeclarationSniff 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 TokenHelper::$functionTokenCodes;
}
/**
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @param int $functionPointer
*/
public function process(File $phpcsFile, $functionPointer) : void {
$this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 80000);
if (!$this->enable) {
return;
}
$tokens = $phpcsFile->getTokens();
$parenthesisOpenerPointer = $tokens[$functionPointer]['parenthesis_opener'];
$parenthesisCloserPointer = $tokens[$functionPointer]['parenthesis_closer'];
if ($tokens[$parenthesisOpenerPointer]['line'] === $tokens[$parenthesisCloserPointer]['line']) {
return;
}
$pointerBeforeParenthesisCloser = TokenHelper::findPreviousEffective($phpcsFile, $parenthesisCloserPointer - 1, $parenthesisOpenerPointer);
if ($pointerBeforeParenthesisCloser === $parenthesisOpenerPointer) {
return;
}
if ($tokens[$pointerBeforeParenthesisCloser]['code'] === T_COMMA) {
return;
}
$fix = $phpcsFile->addFixableError('Multi-line function declaration 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 |
---|---|---|---|---|
RequireTrailingCommaInDeclarationSniff::$enable | public | property | @var bool|null | |
RequireTrailingCommaInDeclarationSniff::CODE_MISSING_TRAILING_COMMA | public | constant | ||
RequireTrailingCommaInDeclarationSniff::process | public | function | * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint * |
Overrides Sniff::process |
RequireTrailingCommaInDeclarationSniff::register | public | function | * | Overrides Sniff::register |