* @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * This sniff class detected empty statement. * * This sniff implements the common algorithm for empty statement body detection. * A body is considered as empty if it is completely empty or it only contains * whitespace characters and|or comments. * * * stmt { * // foo * } * stmt (conditions) { * // foo * } * * * Statements covered by this sniff are catch, do, else, * elsif, for, foreach, if, switch, try * and while. * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: @package_version@ * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_CodeAnalysis_EmptyStatementSniff implements PHP_CodeSniffer_Sniff { /** * List of block tokens that this sniff covers. * * The key of this hash identifies the required token while the boolean * value says mark an error or mark a warning. * * @var array */ protected $checkedTokens = array( T_CATCH => false, T_DO => true, T_ELSE => true, T_ELSEIF => true, T_FOR => true, T_FOREACH => true, T_IF => true, T_SWITCH => true, T_TRY => true, T_WHILE => true, ); /** * Registers the tokens that this sniff wants to listen for. * * @return array(integer) */ public function register() { return array_keys($this->checkedTokens); }//end register() /** * Processes this test, 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) { $tokens = $phpcsFile->getTokens(); $token = $tokens[$stackPtr]; // Skip for-statements without body. if (isset($token['scope_opener']) === false) { return; } $next = ++$token['scope_opener']; $end = --$token['scope_closer']; $emptyBody = true; for (; $next <= $end; ++$next) { if (in_array($tokens[$next]['code'], PHP_CodeSniffer_Tokens::$emptyTokens) === false) { $emptyBody = false; break; } } if ($emptyBody === true) { // Get token identifier. $name = $phpcsFile->getTokensAsString($stackPtr, 1); $error = 'Empty %s statement detected'; $data = array(strtoupper($name)); if ($this->checkedTokens[$token['code']] === true) { $phpcsFile->addError($error, $stackPtr, 'NotAllowed', $data); } else { $phpcsFile->addWarning($error, $stackPtr, 'NotAllowedWarning', $data); } } }//end process() }//end class ?>