1<?php 2/** 3 * Generic_Sniffs_PHP_CharacterBeforePHPOpeningTagSniff. 4 * 5 * PHP version 5 6 * 7 * @category PHP 8 * @package PHP_CodeSniffer 9 * @author Andy Grunwald <andygrunwald@gmail.com> 10 * @copyright 2010-2014 Andy Grunwald 11 * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence 12 * @link http://pear.php.net/package/PHP_CodeSniffer 13 */ 14 15/** 16 * Checks that the opening PHP tag is the first content in a file. 17 * 18 * @category PHP 19 * @package PHP_CodeSniffer 20 * @author Andy Grunwald <andygrunwald@gmail.com> 21 * @copyright 2010-2014 Andy Grunwald 22 * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence 23 * @version Release: @package_version@ 24 * @link http://pear.php.net/package/PHP_CodeSniffer 25 */ 26class Generic_Sniffs_PHP_CharacterBeforePHPOpeningTagSniff implements PHP_CodeSniffer_Sniff 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_OPEN_TAG); 38 39 }//end register() 40 41 42 /** 43 * Processes this sniff, when one of its tokens is encountered. 44 * 45 * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. 46 * @param int $stackPtr The position of the current token in 47 * the stack passed in $tokens. 48 * 49 * @return void 50 */ 51 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) 52 { 53 $expected = 0; 54 if ($stackPtr > 0) { 55 // Allow a shebang line. 56 $tokens = $phpcsFile->getTokens(); 57 if (substr($tokens[0]['content'], 0, 2) === '#!') { 58 $expected = 1; 59 } 60 } 61 62 if ($stackPtr !== $expected) { 63 $error = 'The opening PHP tag must be the first content in the file'; 64 $phpcsFile->addError($error, $stackPtr, 'Found'); 65 } 66 67 // Skip the rest of the file so we don't pick up additional 68 // open tags, typically embedded in HTML. 69 return $phpcsFile->numTokens; 70 71 }//end process() 72 73 74}//end class 75