Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. DisallowTrailingCommaInCallSniff.php

class DisallowTrailingCommaInCallSniff

Hierarchy

  • class \SlevomatCodingStandard\Sniffs\Functions\DisallowTrailingCommaInCallSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of DisallowTrailingCommaInCallSniff

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInCallSniff.php, line 22

Namespace

SlevomatCodingStandard\Sniffs\Functions
View source
class DisallowTrailingCommaInCallSniff implements Sniff {
    public const CODE_DISALLOWED_TRAILING_COMMA = 'DisallowedTrailingComma';
    
    /** @var bool */
    public $onlySingleLine = false;
    
    /**
     * @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 {
        $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'];
        $pointerBeforeParenthesisCloser = TokenHelper::findPreviousEffective($phpcsFile, $parenthesisCloserPointer - 1);
        if ($tokens[$pointerBeforeParenthesisCloser]['code'] !== T_COMMA) {
            return;
        }
        if ($this->onlySingleLine && $tokens[$parenthesisOpenerPointer]['line'] !== $tokens[$parenthesisCloserPointer]['line']) {
            return;
        }
        $fix = $phpcsFile->addFixableError('Trailing comma after the last parameter in function call is disallowed.', $pointerBeforeParenthesisCloser, self::CODE_DISALLOWED_TRAILING_COMMA);
        if (!$fix) {
            return;
        }
        $phpcsFile->fixer
            ->beginChangeset();
        $phpcsFile->fixer
            ->replaceToken($pointerBeforeParenthesisCloser, '');
        if ($tokens[$pointerBeforeParenthesisCloser]['line'] === $tokens[$parenthesisCloserPointer]['line']) {
            FixerHelper::removeBetween($phpcsFile, $pointerBeforeParenthesisCloser, $parenthesisCloserPointer);
        }
        $phpcsFile->fixer
            ->endChangeset();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
DisallowTrailingCommaInCallSniff::$onlySingleLine public property @var bool
DisallowTrailingCommaInCallSniff::CODE_DISALLOWED_TRAILING_COMMA public constant
DisallowTrailingCommaInCallSniff::process public function * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
*
Overrides Sniff::process
DisallowTrailingCommaInCallSniff::register public function * Overrides Sniff::register

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal