function BooleanOperatorPlacementSniff::process

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

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

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

Return value

void

Overrides Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/PSR12/Sniffs/ControlStructures/BooleanOperatorPlacementSniff.php, line 55

Class

BooleanOperatorPlacementSniff

Namespace

PHP_CodeSniffer\Standards\PSR12\Sniffs\ControlStructures

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    if (isset($tokens[$stackPtr]['parenthesis_opener']) === false || isset($tokens[$stackPtr]['parenthesis_closer']) === false) {
        return;
    }
    $parenOpener = $tokens[$stackPtr]['parenthesis_opener'];
    $parenCloser = $tokens[$stackPtr]['parenthesis_closer'];
    if ($tokens[$parenOpener]['line'] === $tokens[$parenCloser]['line']) {
        // Conditions are all on the same line.
        return;
    }
    $find = [
        T_BOOLEAN_AND,
        T_BOOLEAN_OR,
    ];
    if ($this->allowOnly === 'first' || $this->allowOnly === 'last') {
        $position = $this->allowOnly;
    }
    else {
        $position = null;
    }
    $operator = $parenOpener;
    $error = false;
    $operators = [];
    do {
        $operator = $phpcsFile->findNext($find, $operator + 1, $parenCloser);
        if ($operator === false) {
            break;
        }
        $prev = $phpcsFile->findPrevious(T_WHITESPACE, $operator - 1, $parenOpener, true);
        if ($prev === false) {
            // Parse error.
            return;
        }
        $next = $phpcsFile->findNext(T_WHITESPACE, $operator + 1, $parenCloser, true);
        if ($next === false) {
            // Parse error.
            return;
        }
        $firstOnLine = false;
        $lastOnLine = false;
        if ($tokens[$prev]['line'] < $tokens[$operator]['line']) {
            // The boolean operator is the first content on the line.
            $firstOnLine = true;
        }
        if ($tokens[$next]['line'] > $tokens[$operator]['line']) {
            // The boolean operator is the last content on the line.
            $lastOnLine = true;
        }
        if ($firstOnLine === true && $lastOnLine === true) {
            // The operator is the only content on the line.
            // Don't record it because we can't determine
            // placement information from looking at it.
            continue;
        }
        $operators[] = $operator;
        if ($firstOnLine === false && $lastOnLine === false) {
            // It's in the middle of content, so we can't determine
            // placement information from looking at it, but we may
            // still need to process it.
            continue;
        }
        if ($firstOnLine === true) {
            if ($position === null) {
                $position = 'first';
            }
            if ($position !== 'first') {
                $error = true;
            }
        }
        else {
            if ($position === null) {
                $position = 'last';
            }
            if ($position !== 'last') {
                $error = true;
            }
        }
    } while ($operator !== false);
    if ($error === false) {
        return;
    }
    switch ($this->allowOnly) {
        case 'first':
            $error = 'Boolean operators between conditions must be at the beginning of the line';
            break;
        case 'last':
            $error = 'Boolean operators between conditions must be at the end of the line';
            break;
        default:
            $error = 'Boolean operators between conditions must be at the beginning or end of the line, but not both';
    }
    $fix = $phpcsFile->addFixableError($error, $stackPtr, 'FoundMixed');
    if ($fix === false) {
        return;
    }
    $phpcsFile->fixer
        ->beginChangeset();
    foreach ($operators as $operator) {
        $prev = $phpcsFile->findPrevious(T_WHITESPACE, $operator - 1, $parenOpener, true);
        $next = $phpcsFile->findNext(T_WHITESPACE, $operator + 1, $parenCloser, true);
        if ($position === 'last') {
            if ($tokens[$next]['line'] === $tokens[$operator]['line']) {
                if ($tokens[$prev]['line'] === $tokens[$operator]['line']) {
                    // Move the content after the operator to the next line.
                    if ($tokens[$operator + 1]['code'] === T_WHITESPACE) {
                        $phpcsFile->fixer
                            ->replaceToken($operator + 1, '');
                    }
                    $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $operator, true);
                    $padding = str_repeat(' ', $tokens[$first]['column'] - 1);
                    $phpcsFile->fixer
                        ->addContent($operator, $phpcsFile->eolChar . $padding);
                }
                else {
                    // Move the operator to the end of the previous line.
                    if ($tokens[$operator + 1]['code'] === T_WHITESPACE) {
                        $phpcsFile->fixer
                            ->replaceToken($operator + 1, '');
                    }
                    $phpcsFile->fixer
                        ->addContent($prev, ' ' . $tokens[$operator]['content']);
                    $phpcsFile->fixer
                        ->replaceToken($operator, '');
                }
            }
            
            //end if
        }
        else {
            if ($tokens[$prev]['line'] === $tokens[$operator]['line']) {
                if ($tokens[$next]['line'] === $tokens[$operator]['line']) {
                    // Move the operator, and the rest of the expression, to the next line.
                    if ($tokens[$operator - 1]['code'] === T_WHITESPACE) {
                        $phpcsFile->fixer
                            ->replaceToken($operator - 1, '');
                    }
                    $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $operator, true);
                    $padding = str_repeat(' ', $tokens[$first]['column'] - 1);
                    $phpcsFile->fixer
                        ->addContentBefore($operator, $phpcsFile->eolChar . $padding);
                }
                else {
                    // Move the operator to the start of the next line.
                    if ($tokens[$operator - 1]['code'] === T_WHITESPACE) {
                        $phpcsFile->fixer
                            ->replaceToken($operator - 1, '');
                    }
                    $phpcsFile->fixer
                        ->addContentBefore($next, $tokens[$operator]['content'] . ' ');
                    $phpcsFile->fixer
                        ->replaceToken($operator, '');
                }
            }
            
            //end if
        }
        
        //end if
    }
    
    //end foreach
    $phpcsFile->fixer
        ->endChangeset();
}