function MemberVarSpacingSniff::processMemberVar

Processes the function tokens within the class.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.:

int $stackPtr The position where the token was found.:

Return value

void|int Optionally returns a stack pointer. The sniff will not be called again on the current file until the returned stack pointer is reached.

Overrides AbstractVariableSniff::processMemberVar

File

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/WhiteSpace/MemberVarSpacingSniff.php, line 44

Class

MemberVarSpacingSniff

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace

Code

protected function processMemberVar(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $validPrefixes = Tokens::$methodPrefixes;
    $validPrefixes[] = T_VAR;
    $startOfStatement = $phpcsFile->findPrevious($validPrefixes, $stackPtr - 1, null, false, null, true);
    if ($startOfStatement === false) {
        return;
    }
    $endOfStatement = $phpcsFile->findNext(T_SEMICOLON, $stackPtr + 1, null, false, null, true);
    $ignore = $validPrefixes;
    $ignore[T_WHITESPACE] = T_WHITESPACE;
    $start = $startOfStatement;
    for ($prev = $startOfStatement - 1; $prev >= 0; $prev--) {
        if (isset($ignore[$tokens[$prev]['code']]) === true) {
            continue;
        }
        if ($tokens[$prev]['code'] === T_ATTRIBUTE_END && isset($tokens[$prev]['attribute_opener']) === true) {
            $prev = $tokens[$prev]['attribute_opener'];
            $start = $prev;
            continue;
        }
        break;
    }
    if (isset(Tokens::$commentTokens[$tokens[$prev]['code']]) === true) {
        // Assume the comment belongs to the member var if it is on a line by itself.
        $prevContent = $phpcsFile->findPrevious(Tokens::$emptyTokens, $prev - 1, null, true);
        if ($tokens[$prevContent]['line'] !== $tokens[$prev]['line']) {
            // Check the spacing, but then skip it.
            $foundLines = $tokens[$startOfStatement]['line'] - $tokens[$prev]['line'] - 1;
            if ($foundLines > 0) {
                for ($i = $prev + 1; $i < $startOfStatement; $i++) {
                    if ($tokens[$i]['column'] !== 1) {
                        continue;
                    }
                    if ($tokens[$i]['code'] === T_WHITESPACE && $tokens[$i]['line'] !== $tokens[$i + 1]['line']) {
                        $error = 'Expected 0 blank lines after member var comment; %s found';
                        $data = [
                            $foundLines,
                        ];
                        $fix = $phpcsFile->addFixableError($error, $prev, 'AfterComment', $data);
                        if ($fix === true) {
                            $phpcsFile->fixer
                                ->beginChangeset();
                            // Inline comments have the newline included in the content but
                            // docblocks do not.
                            if ($tokens[$prev]['code'] === T_COMMENT) {
                                $phpcsFile->fixer
                                    ->replaceToken($prev, rtrim($tokens[$prev]['content']));
                            }
                            for ($i = $prev + 1; $i <= $startOfStatement; $i++) {
                                if ($tokens[$i]['line'] === $tokens[$startOfStatement]['line']) {
                                    break;
                                }
                                // Remove the newline after the docblock, and any entirely
                                // empty lines before the member var.
                                if ($tokens[$i]['code'] === T_WHITESPACE && $tokens[$i]['line'] === $tokens[$prev]['line'] || $tokens[$i]['column'] === 1 && $tokens[$i]['line'] !== $tokens[$i + 1]['line']) {
                                    $phpcsFile->fixer
                                        ->replaceToken($i, '');
                                }
                            }
                            $phpcsFile->fixer
                                ->addNewline($prev);
                            $phpcsFile->fixer
                                ->endChangeset();
                        }
                        
                        //end if
                        break;
                    }
                    
                    //end if
                }
                
                //end for
            }
            
            //end if
            $start = $prev;
        }
        
        //end if
    }
    
    //end if
    // There needs to be n blank lines before the var, not counting comments.
    if ($start === $startOfStatement) {
        // No comment found.
        $first = $phpcsFile->findFirstOnLine(Tokens::$emptyTokens, $start, true);
        if ($first === false) {
            $first = $start;
        }
    }
    else {
        if ($tokens[$start]['code'] === T_DOC_COMMENT_CLOSE_TAG) {
            $first = $tokens[$start]['comment_opener'];
        }
        else {
            $first = $phpcsFile->findPrevious(Tokens::$emptyTokens, $start - 1, null, true);
            $first = $phpcsFile->findNext(array_merge(Tokens::$commentTokens, [
                T_ATTRIBUTE,
            ]), $first + 1);
        }
    }
    // Determine if this is the first member var.
    $prev = $phpcsFile->findPrevious(T_WHITESPACE, $first - 1, null, true);
    if ($tokens[$prev]['code'] === T_CLOSE_CURLY_BRACKET && isset($tokens[$prev]['scope_condition']) === true && $tokens[$tokens[$prev]['scope_condition']]['code'] === T_FUNCTION) {
        return;
    }
    if ($tokens[$prev]['code'] === T_OPEN_CURLY_BRACKET && isset(Tokens::$ooScopeTokens[$tokens[$tokens[$prev]['scope_condition']]['code']]) === true) {
        $errorMsg = 'Expected %s blank line(s) before first member var; %s found';
        $errorCode = 'FirstIncorrect';
        $spacing = (int) $this->spacingBeforeFirst;
    }
    else {
        $errorMsg = 'Expected %s blank line(s) before member var; %s found';
        $errorCode = 'Incorrect';
        $spacing = (int) $this->spacing;
    }
    $foundLines = $tokens[$first]['line'] - $tokens[$prev]['line'] - 1;
    if ($errorCode === 'FirstIncorrect') {
        $phpcsFile->recordMetric($stackPtr, 'Member var spacing before first', $foundLines);
    }
    else {
        $phpcsFile->recordMetric($stackPtr, 'Member var spacing before', $foundLines);
    }
    if ($foundLines === $spacing) {
        if ($endOfStatement !== false) {
            return $endOfStatement;
        }
        return;
    }
    $data = [
        $spacing,
        $foundLines,
    ];
    $fix = $phpcsFile->addFixableError($errorMsg, $startOfStatement, $errorCode, $data);
    if ($fix === true) {
        $phpcsFile->fixer
            ->beginChangeset();
        for ($i = $prev + 1; $i < $first; $i++) {
            if ($tokens[$i]['line'] === $tokens[$prev]['line']) {
                continue;
            }
            if ($tokens[$i]['line'] === $tokens[$first]['line']) {
                for ($x = 1; $x <= $spacing; $x++) {
                    $phpcsFile->fixer
                        ->addNewlineBefore($i);
                }
                break;
            }
            $phpcsFile->fixer
                ->replaceToken($i, '');
        }
        $phpcsFile->fixer
            ->endChangeset();
    }
    
    //end if
    if ($endOfStatement !== false) {
        return $endOfStatement;
    }
}