function TrailingArrayCommaSniff::process

* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint *

Parameters

int $stackPointer:

Overrides Sniff::process

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/TrailingArrayCommaSniff.php, line 35

Class

TrailingArrayCommaSniff

Namespace

SlevomatCodingStandard\Sniffs\Arrays

Code

public function process(File $phpcsFile, $stackPointer) : void {
    $this->enableAfterHeredoc = SniffSettingsHelper::isEnabledByPhpVersion($this->enableAfterHeredoc, 70300);
    $tokens = $phpcsFile->getTokens();
    [
        $arrayOpenerPointer,
        $arrayCloserPointer,
    ] = ArrayHelper::openClosePointers($tokens[$stackPointer]);
    if ($tokens[$arrayOpenerPointer]['line'] === $tokens[$arrayCloserPointer]['line']) {
        return;
    }
    
    /** @var int $pointerPreviousToClose */
    $pointerPreviousToClose = TokenHelper::findPreviousEffective($phpcsFile, $arrayCloserPointer - 1);
    $tokenPreviousToClose = $tokens[$pointerPreviousToClose];
    if ($pointerPreviousToClose === $arrayOpenerPointer || $tokenPreviousToClose['code'] === T_COMMA || $tokens[$arrayCloserPointer]['line'] === $tokenPreviousToClose['line']) {
        return;
    }
    if (!$this->enableAfterHeredoc && in_array($tokenPreviousToClose['code'], [
        T_END_HEREDOC,
        T_END_NOWDOC,
    ], true)) {
        return;
    }
    $fix = $phpcsFile->addFixableError('Multi-line arrays must have a trailing comma after the last element.', $pointerPreviousToClose, self::CODE_MISSING_TRAILING_COMMA);
    if (!$fix) {
        return;
    }
    $phpcsFile->fixer
        ->beginChangeset();
    $phpcsFile->fixer
        ->addContent($pointerPreviousToClose, ',');
    $phpcsFile->fixer
        ->endChangeset();
}