function ArbitraryParenthesesSpacingSniff::process

Processes this test, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile All the tokens found in the document.:

int $stackPtr The position of the current token in: the stack passed in $tokens.

Return value

void|int

Overrides Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/WhiteSpace/ArbitraryParenthesesSpacingSniff.php, line 83

Class

ArbitraryParenthesesSpacingSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    if (isset($tokens[$stackPtr]['parenthesis_owner']) === true) {
        // This parenthesis is owned by a function/control structure etc.
        return;
    }
    // More checking for the type of parenthesis we *don't* want to handle.
    $opener = $stackPtr;
    if ($tokens[$stackPtr]['code'] === T_CLOSE_PARENTHESIS) {
        if (isset($tokens[$stackPtr]['parenthesis_opener']) === false) {
            // Parse error.
            return;
        }
        $opener = $tokens[$stackPtr]['parenthesis_opener'];
    }
    $preOpener = $phpcsFile->findPrevious(Tokens::$emptyTokens, $opener - 1, null, true);
    if ($preOpener !== false && isset($this->ignoreTokens[$tokens[$preOpener]['code']]) === true && ($tokens[$preOpener]['code'] !== T_CLOSE_CURLY_BRACKET || isset($tokens[$preOpener]['scope_condition']) === false)) {
        // Function or language construct call.
        return;
    }
    // Check for empty parentheses.
    if ($tokens[$stackPtr]['code'] === T_OPEN_PARENTHESIS && isset($tokens[$stackPtr]['parenthesis_closer']) === true) {
        $nextNonEmpty = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
        if ($nextNonEmpty === $tokens[$stackPtr]['parenthesis_closer']) {
            $phpcsFile->addWarning('Empty set of arbitrary parentheses found.', $stackPtr, 'FoundEmpty');
            return $tokens[$stackPtr]['parenthesis_closer'] + 1;
        }
    }
    // Check the spacing on the inside of the parentheses.
    $this->spacing = (int) $this->spacing;
    if ($tokens[$stackPtr]['code'] === T_OPEN_PARENTHESIS && isset($tokens[$stackPtr + 1], $tokens[$stackPtr + 2]) === true) {
        $nextToken = $tokens[$stackPtr + 1];
        if ($nextToken['code'] !== T_WHITESPACE) {
            $inside = 0;
        }
        else {
            if ($tokens[$stackPtr + 2]['line'] !== $tokens[$stackPtr]['line']) {
                $inside = 'newline';
            }
            else {
                $inside = $nextToken['length'];
            }
        }
        if ($this->spacing !== $inside && ($inside !== 'newline' || $this->ignoreNewlines === false)) {
            $error = 'Expected %s space after open parenthesis; %s found';
            $data = [
                $this->spacing,
                $inside,
            ];
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpen', $data);
            if ($fix === true) {
                $expected = '';
                if ($this->spacing > 0) {
                    $expected = str_repeat(' ', $this->spacing);
                }
                if ($inside === 0) {
                    if ($expected !== '') {
                        $phpcsFile->fixer
                            ->addContent($stackPtr, $expected);
                    }
                }
                else {
                    if ($inside === 'newline') {
                        $phpcsFile->fixer
                            ->beginChangeset();
                        for ($i = $stackPtr + 2; $i < $phpcsFile->numTokens; $i++) {
                            if ($tokens[$i]['code'] !== T_WHITESPACE) {
                                break;
                            }
                            $phpcsFile->fixer
                                ->replaceToken($i, '');
                        }
                        $phpcsFile->fixer
                            ->replaceToken($stackPtr + 1, $expected);
                        $phpcsFile->fixer
                            ->endChangeset();
                    }
                    else {
                        $phpcsFile->fixer
                            ->replaceToken($stackPtr + 1, $expected);
                    }
                }
            }
            
            //end if
        }
        
        //end if
    }
    
    //end if
    if ($tokens[$stackPtr]['code'] === T_CLOSE_PARENTHESIS && isset($tokens[$stackPtr - 1], $tokens[$stackPtr - 2]) === true) {
        $prevToken = $tokens[$stackPtr - 1];
        if ($prevToken['code'] !== T_WHITESPACE) {
            $inside = 0;
        }
        else {
            if ($tokens[$stackPtr - 2]['line'] !== $tokens[$stackPtr]['line']) {
                $inside = 'newline';
            }
            else {
                $inside = $prevToken['length'];
            }
        }
        if ($this->spacing !== $inside && ($inside !== 'newline' || $this->ignoreNewlines === false)) {
            $error = 'Expected %s space before close parenthesis; %s found';
            $data = [
                $this->spacing,
                $inside,
            ];
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose', $data);
            if ($fix === true) {
                $expected = '';
                if ($this->spacing > 0) {
                    $expected = str_repeat(' ', $this->spacing);
                }
                if ($inside === 0) {
                    if ($expected !== '') {
                        $phpcsFile->fixer
                            ->addContentBefore($stackPtr, $expected);
                    }
                }
                else {
                    if ($inside === 'newline') {
                        $phpcsFile->fixer
                            ->beginChangeset();
                        for ($i = $stackPtr - 2; $i > 0; $i--) {
                            if ($tokens[$i]['code'] !== T_WHITESPACE) {
                                break;
                            }
                            $phpcsFile->fixer
                                ->replaceToken($i, '');
                        }
                        $phpcsFile->fixer
                            ->replaceToken($stackPtr - 1, $expected);
                        $phpcsFile->fixer
                            ->endChangeset();
                    }
                    else {
                        $phpcsFile->fixer
                            ->replaceToken($stackPtr - 1, $expected);
                    }
                }
            }
            
            //end if
        }
        
        //end if
    }
    
    //end if
}