function FunctionClosingBraceSpaceSniff::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/Squiz/Sniffs/WhiteSpace/FunctionClosingBraceSpaceSniff.php, line 53

Class

FunctionClosingBraceSpaceSniff

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    if (isset($tokens[$stackPtr]['scope_closer']) === false) {
        // Probably an interface method.
        return;
    }
    $closeBrace = $tokens[$stackPtr]['scope_closer'];
    $prevContent = $phpcsFile->findPrevious(T_WHITESPACE, $closeBrace - 1, null, true);
    // Special case for empty JS functions.
    if ($phpcsFile->tokenizerType === 'JS' && $prevContent === $tokens[$stackPtr]['scope_opener']) {
        // In this case, the opening and closing brace must be
        // right next to each other.
        if ($tokens[$stackPtr]['scope_closer'] !== $tokens[$stackPtr]['scope_opener'] + 1) {
            $error = 'The opening and closing braces of empty functions must be directly next to each other; e.g., function () {}';
            $fix = $phpcsFile->addFixableError($error, $closeBrace, 'SpacingBetween');
            if ($fix === true) {
                $phpcsFile->fixer
                    ->beginChangeset();
                for ($i = $tokens[$stackPtr]['scope_opener'] + 1; $i < $closeBrace; $i++) {
                    $phpcsFile->fixer
                        ->replaceToken($i, '');
                }
                $phpcsFile->fixer
                    ->endChangeset();
            }
        }
        return;
    }
    $nestedFunction = false;
    if ($phpcsFile->hasCondition($stackPtr, [
        T_FUNCTION,
        T_CLOSURE,
    ]) === true || isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
        $nestedFunction = true;
    }
    $braceLine = $tokens[$closeBrace]['line'];
    $prevLine = $tokens[$prevContent]['line'];
    $found = $braceLine - $prevLine - 1;
    if ($nestedFunction === true) {
        if ($found < 0) {
            $error = 'Closing brace of nested function must be on a new line';
            $fix = $phpcsFile->addFixableError($error, $closeBrace, 'ContentBeforeClose');
            if ($fix === true) {
                $phpcsFile->fixer
                    ->addNewlineBefore($closeBrace);
            }
        }
        else {
            if ($found > 0) {
                $error = 'Expected 0 blank lines before closing brace of nested function; %s found';
                $data = [
                    $found,
                ];
                $fix = $phpcsFile->addFixableError($error, $closeBrace, 'SpacingBeforeNestedClose', $data);
                if ($fix === true) {
                    $phpcsFile->fixer
                        ->beginChangeset();
                    $changeMade = false;
                    for ($i = $prevContent + 1; $i < $closeBrace; $i++) {
                        // Try and maintain indentation.
                        if ($tokens[$i]['line'] === $braceLine - 1) {
                            break;
                        }
                        $phpcsFile->fixer
                            ->replaceToken($i, '');
                        $changeMade = true;
                    }
                    // Special case for when the last content contains the newline
                    // token as well, like with a comment.
                    if ($changeMade === false) {
                        $phpcsFile->fixer
                            ->replaceToken($prevContent + 1, '');
                    }
                    $phpcsFile->fixer
                        ->endChangeset();
                }
                
                //end if
            }
        }
        
        //end if
    }
    else {
        if ($found !== 1) {
            if ($found < 0) {
                $found = 0;
            }
            $error = 'Expected 1 blank line before closing function brace; %s found';
            $data = [
                $found,
            ];
            $fix = $phpcsFile->addFixableError($error, $closeBrace, 'SpacingBeforeClose', $data);
            if ($fix === true) {
                if ($found > 1) {
                    $phpcsFile->fixer
                        ->beginChangeset();
                    for ($i = $prevContent + 1; $i < $closeBrace - 1; $i++) {
                        $phpcsFile->fixer
                            ->replaceToken($i, '');
                    }
                    $phpcsFile->fixer
                        ->replaceToken($i, $phpcsFile->eolChar);
                    $phpcsFile->fixer
                        ->endChangeset();
                }
                else {
                    // Try and maintain indentation.
                    if ($tokens[$closeBrace - 1]['code'] === T_WHITESPACE) {
                        $phpcsFile->fixer
                            ->addNewlineBefore($closeBrace - 1);
                    }
                    else {
                        $phpcsFile->fixer
                            ->addNewlineBefore($closeBrace);
                    }
                }
            }
        }
        
        //end if
    }
    
    //end if
}