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

Source for file ClosingTagSniff.php

Documentation is available at ClosingTagSniff.php

  1. <?php
  2. /**
  3.  * Checks that the file does not end with a closing tag.
  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\Zend\Sniffs\Files;
  11.  
  12. use PHP_CodeSniffer\Sniffs\Sniff;
  13. use PHP_CodeSniffer\Files\File;
  14.  
  15. class ClosingTagSniff implements Sniff
  16. {
  17.  
  18.  
  19.     /**
  20.      * Returns an array of tokens this test wants to listen for.
  21.      *
  22.      * @return array 
  23.      */
  24.     public function register()
  25.     {
  26.         return array(T_OPEN_TAG);
  27.  
  28.     }//end register()
  29.  
  30.  
  31.     /**
  32.      * Processes this sniff, when one of its tokens is encountered.
  33.      *
  34.      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
  35.      * @param int                         $stackPtr  The position of the current token in
  36.      *                                                the stack passed in $tokens.
  37.      *
  38.      * @return void 
  39.      */
  40.     public function process(File $phpcsFile$stackPtr)
  41.     {
  42.         // Find the last non-empty token.
  43.         $tokens $phpcsFile->getTokens();
  44.         for ($last ($phpcsFile->numTokens - 1)$last > 0; $last--{
  45.             if (trim($tokens[$last]['content']!== ''{
  46.                 break;
  47.             }
  48.         }
  49.  
  50.         if ($tokens[$last]['code'=== T_CLOSE_TAG{
  51.             $error 'A closing tag is not permitted at the end of a PHP file';
  52.             $fix   $phpcsFile->addFixableError($error$last'NotAllowed');
  53.             if ($fix === true{
  54.                 $phpcsFile->fixer->replaceToken($last'');
  55.             }
  56.  
  57.             $phpcsFile->recordMetric($stackPtr'PHP closing tag at EOF''yes');
  58.         else {
  59.             $phpcsFile->recordMetric($stackPtr'PHP closing tag at EOF''no');
  60.         }
  61.  
  62.         // Ignore the rest of the file.
  63.         return ($phpcsFile->numTokens + 1);
  64.  
  65.     }//end process()
  66.  
  67.  
  68. }//end class

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