1<?php 2/** 3 * Squiz_Sniffs_Operators_ValidLogicalOperatorsSniff. 4 * 5 * PHP version 5 6 * 7 * @category PHP 8 * @package PHP_CodeSniffer 9 * @author Greg Sherwood <gsherwood@squiz.net> 10 * @author Marc McIntyre <mmcintyre@squiz.net> 11 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) 12 * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence 13 * @link http://pear.php.net/package/PHP_CodeSniffer 14 */ 15 16/** 17 * Squiz_Sniffs_Operators_ValidLogicalOperatorsSniff. 18 * 19 * Checks to ensure that the logical operators 'and' and 'or' are not used. 20 * Use the && and || operators instead. 21 * 22 * @category PHP 23 * @package PHP_CodeSniffer 24 * @author Greg Sherwood <gsherwood@squiz.net> 25 * @author Marc McIntyre <mmcintyre@squiz.net> 26 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) 27 * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence 28 * @version Release: @package_version@ 29 * @link http://pear.php.net/package/PHP_CodeSniffer 30 */ 31class Squiz_Sniffs_Operators_ValidLogicalOperatorsSniff implements PHP_CodeSniffer_Sniff 32{ 33 34 35 /** 36 * Returns an array of tokens this test wants to listen for. 37 * 38 * @return array 39 */ 40 public function register() 41 { 42 return array( 43 T_LOGICAL_AND, 44 T_LOGICAL_OR, 45 ); 46 47 }//end register() 48 49 50 /** 51 * Processes this test, when one of its tokens is encountered. 52 * 53 * @param PHP_CodeSniffer_File $phpcsFile The current file being scanned. 54 * @param int $stackPtr The position of the current token in the 55 * stack passed in $tokens. 56 * 57 * @return void 58 */ 59 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) 60 { 61 $tokens = $phpcsFile->getTokens(); 62 63 $replacements = array( 64 'and' => '&&', 65 'or' => '||', 66 ); 67 68 $operator = strtolower($tokens[$stackPtr]['content']); 69 if (isset($replacements[$operator]) === false) { 70 return; 71 } 72 73 $error = 'Logical operator "%s" is prohibited; use "%s" instead'; 74 $data = array( 75 $operator, 76 $replacements[$operator], 77 ); 78 $phpcsFile->addError($error, $stackPtr, 'NotAllowed', $data); 79 80 }//end process() 81 82 83}//end class 84