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

Source for file SemicolonSpacingSniff.php

Documentation is available at SemicolonSpacingSniff.php

  1. <?php
  2. /**
  3.  * Ensure there is no whitespace before a semicolon.
  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 SemicolonSpacingSniff implements Sniff
  17. {
  18.  
  19.     /**
  20.      * A list of tokenizers this sniff supports.
  21.      *
  22.      * @var array 
  23.      */
  24.     public $supportedTokenizers = array(
  25.                                    'PHP',
  26.                                    'JS',
  27.                                   );
  28.  
  29.  
  30.     /**
  31.      * Returns an array of tokens this test wants to listen for.
  32.      *
  33.      * @return array 
  34.      */
  35.     public function register()
  36.     {
  37.         return array(T_SEMICOLON);
  38.  
  39.     }//end register()
  40.  
  41.  
  42.     /**
  43.      * Processes this test, when one of its tokens is encountered.
  44.      *
  45.      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
  46.      * @param int                         $stackPtr  The position of the current token
  47.      *                                                in the stack passed in $tokens.
  48.      *
  49.      * @return void 
  50.      */
  51.     public function process(File $phpcsFile$stackPtr)
  52.     {
  53.         $tokens $phpcsFile->getTokens();
  54.  
  55.         $prevType $tokens[($stackPtr - 1)]['code'];
  56.         if (isset(Tokens::$emptyTokens[$prevType]=== false{
  57.             return;
  58.         }
  59.  
  60.         $nonSpace $phpcsFile->findPrevious(Tokens::$emptyTokens($stackPtr - 2)nulltrue);
  61.         if ($tokens[$nonSpace]['code'=== T_SEMICOLON{
  62.             // Empty statement.
  63.             return;
  64.         }
  65.  
  66.         $expected $tokens[$nonSpace]['content'].';';
  67.         $found    $phpcsFile->getTokensAsString($nonSpace($stackPtr $nonSpace)).';';
  68.         $error    'Space found before semicolon; expected "%s" but found "%s"';
  69.         $data     = array(
  70.                      $expected,
  71.                      $found,
  72.                     );
  73.  
  74.         $fix $phpcsFile->addFixableError($error$stackPtr'Incorrect'$data);
  75.         if ($fix === true{
  76.             $phpcsFile->fixer->beginChangeset();
  77.             $i ($stackPtr - 1);
  78.             while (($tokens[$i]['code'=== T_WHITESPACE&& ($i $nonSpace)) {
  79.                 $phpcsFile->fixer->replaceToken($i'');
  80.                 $i--;
  81.             }
  82.  
  83.             $phpcsFile->fixer->addContent($nonSpace';');
  84.             $phpcsFile->fixer->replaceToken($stackPtr'');
  85.  
  86.             $phpcsFile->fixer->endChangeset();
  87.         }
  88.  
  89.     }//end process()
  90.  
  91.  
  92. }//end class

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