<?php
/**
* Generic_Sniffs_PHP_CharacterBeforePHPOpeningTagSniff.
*
* PHP version 5
*
* @category PHP
* @package PHP_CodeSniffer
* @author Andy Grunwald <andygrunwald@gmail.com>
* @copyright 2010-2014 Andy Grunwald
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
/**
* Checks that the opening PHP tag is the first content in a file.
*
* @category PHP
* @package PHP_CodeSniffer
* @author Andy Grunwald <andygrunwald@gmail.com>
* @copyright 2010-2014 Andy Grunwald
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
* @version Release: 1.5.5
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
class Generic_Sniffs_PHP_CharacterBeforePHPOpeningTagSniff implements PHP_CodeSniffer_Sniff
{
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return array(T_OPEN_TAG);
}//end register()
/**
* Processes this sniff, when one of its tokens is encountered.
*
* @param PHP_CodeSniffer_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(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
{
if ($stackPtr > 0) {
$error = 'The opening PHP tag must be the first content in the file';
$phpcsFile->addError($error, $stackPtr, 'Found');
}
}//end process()
}//end class
?>