* @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 */ /** * Detects unconditional if- and elseif-statements. * * This rule is based on the PMD rule catalog. The Unconditional If Statement * sniff detects statement conditions that are only set to one of the constant * values true or false * * * class Foo * { * public function close() * { * if (true) * { * // ... * } * } * } * * * @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_UnconditionalIfStatementSniff implements PHP_CodeSniffer_Sniff { /** * Registers the tokens that this sniff wants to listen for. * * @return int[] */ public function register() { return array( T_IF, T_ELSEIF, ); }//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-loop without body. if (isset($token['parenthesis_opener']) === false) { return; } $next = ++$token['parenthesis_opener']; $end = --$token['parenthesis_closer']; $goodCondition = false; for (; $next <= $end; ++$next) { $code = $tokens[$next]['code']; if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === true) { continue; } else if ($code !== T_TRUE && $code !== T_FALSE) { $goodCondition = true; } } if ($goodCondition === false) { $error = 'Avoid IF statements that are always true or false'; $phpcsFile->addWarning($error, $stackPtr, 'Found'); } }//end process() }//end class