PHP_CodeSniffer
[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Source for file ScopeKeywordSpacingSniff.php

Documentation is available at ScopeKeywordSpacingSniff.php

  1. <?php
  2. /**
  3.  * Ensure there is a single space after scope keywords.
  4.  *
  5.  * @author    Greg Sherwood <gsherwood@squiz.net>
  6.  * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
  7.  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
  8.  */
  9.  
  10. namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace;
  11.  
  12. use PHP_CodeSniffer\Sniffs\Sniff;
  13. use PHP_CodeSniffer\Files\File;
  14. use PHP_CodeSniffer\Util\Tokens;
  15.  
  16. class ScopeKeywordSpacingSniff implements Sniff
  17. {
  18.  
  19.  
  20.     /**
  21.      * Returns an array of tokens this test wants to listen for.
  22.      *
  23.      * @return array 
  24.      */
  25.     public function register()
  26.     {
  27.         $register   = Tokens::$scopeModifiers;
  28.         $register[= T_STATIC;
  29.         return $register;
  30.  
  31.     }//end register()
  32.  
  33.  
  34.     /**
  35.      * Processes this test, when one of its tokens is encountered.
  36.      *
  37.      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
  38.      * @param int                         $stackPtr  The position of the current token
  39.      *                                                in the stack passed in $tokens.
  40.      *
  41.      * @return void 
  42.      */
  43.     public function process(File $phpcsFile$stackPtr)
  44.     {
  45.         $tokens $phpcsFile->getTokens();
  46.  
  47.         $prevToken $phpcsFile->findPrevious(T_WHITESPACE($stackPtr - 1)nulltrue);
  48.         $nextToken $phpcsFile->findNext(T_WHITESPACE($stackPtr + 1)nulltrue);
  49.  
  50.         if ($tokens[$stackPtr]['code'=== T_STATIC
  51.             && ($tokens[$nextToken]['code'=== T_DOUBLE_COLON
  52.             || $tokens[$prevToken]['code'=== T_NEW)
  53.         {
  54.             // Late static binding, e.g., static:: OR new static() usage.
  55.             return;
  56.         }
  57.  
  58.         if ($tokens[$prevToken]['code'=== T_AS{
  59.             // Trait visibilty change, e.g., "use HelloWorld { sayHello as private; }".
  60.             return;
  61.         }
  62.  
  63.         $nextToken $tokens[($stackPtr + 1)];
  64.         if (strlen($nextToken['content']!== 1
  65.             || $nextToken['content'=== $phpcsFile->eolChar
  66.         {
  67.             $error 'Scope keyword "%s" must be followed by a single space';
  68.             $data  = array($tokens[$stackPtr]['content']);
  69.             $fix   $phpcsFile->addFixableError($error$stackPtr'Incorrect'$data);
  70.             if ($fix === true{
  71.                 $phpcsFile->fixer->replaceToken(($stackPtr + 1)' ');
  72.             }
  73.         }
  74.  
  75.     }//end process()
  76.  
  77.  
  78. }//end class

Documentation generated on Mon, 11 Mar 2019 15:27:46 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.