Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. SpaceBeforeCastSniff.php

class SpaceBeforeCastSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\SpaceBeforeCastSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of SpaceBeforeCastSniff

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/Formatting/SpaceBeforeCastSniff.php, line 16

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting
View source
class SpaceBeforeCastSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return Tokens::$castTokens;
    }
    
    //end register()
    
    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param int                         $stackPtr  The position of the current token in
     *                                               the stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        if ($tokens[$stackPtr]['column'] === 1) {
            return;
        }
        if ($tokens[$stackPtr - 1]['code'] !== T_WHITESPACE) {
            $error = 'A cast statement must be preceded by a single space';
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpace');
            if ($fix === true) {
                $phpcsFile->fixer
                    ->addContentBefore($stackPtr, ' ');
            }
            $phpcsFile->recordMetric($stackPtr, 'Spacing before cast statement', 0);
            return;
        }
        $phpcsFile->recordMetric($stackPtr, 'Spacing before cast statement', $tokens[$stackPtr - 1]['length']);
        if ($tokens[$stackPtr - 1]['column'] !== 1 && $tokens[$stackPtr - 1]['length'] !== 1) {
            $error = 'A cast statement must be preceded by a single space';
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'TooMuchSpace');
            if ($fix === true) {
                $phpcsFile->fixer
                    ->replaceToken($stackPtr - 1, ' ');
            }
        }
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
SpaceBeforeCastSniff::process public function Processes this test, when one of its tokens is encountered. Overrides Sniff::process
SpaceBeforeCastSniff::register public function Returns an array of tokens this test wants to listen for. Overrides Sniff::register
RSS feed
Powered by Drupal