1<?php 2/** 3 * Sniffs_Squiz_WhiteSpace_OperatorSpacingSniff. 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 * Sniffs_Squiz_WhiteSpace_OperatorSpacingSniff. 18 * 19 * Verifies that operators have valid spacing surrounding them. 20 * 21 * @category PHP 22 * @package PHP_CodeSniffer 23 * @author Greg Sherwood <gsherwood@squiz.net> 24 * @author Marc McIntyre <mmcintyre@squiz.net> 25 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) 26 * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence 27 * @version Release: @package_version@ 28 * @link http://pear.php.net/package/PHP_CodeSniffer 29 */ 30class Squiz_Sniffs_WhiteSpace_LogicalOperatorSpacingSniff implements PHP_CodeSniffer_Sniff 31{ 32 33 /** 34 * A list of tokenizers this sniff supports. 35 * 36 * @var array 37 */ 38 public $supportedTokenizers = array( 39 'PHP', 40 'JS', 41 ); 42 43 44 /** 45 * Returns an array of tokens this test wants to listen for. 46 * 47 * @return array 48 */ 49 public function register() 50 { 51 return PHP_CodeSniffer_Tokens::$booleanOperators; 52 53 }//end register() 54 55 56 /** 57 * Processes this sniff, when one of its tokens is encountered. 58 * 59 * @param PHP_CodeSniffer_File $phpcsFile The current file being checked. 60 * @param int $stackPtr The position of the current token 61 * in the stack passed in $tokens. 62 * 63 * @return void 64 */ 65 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) 66 { 67 $tokens = $phpcsFile->getTokens(); 68 69 // Check there is one space before the operator. 70 if ($tokens[($stackPtr - 1)]['code'] !== T_WHITESPACE) { 71 $error = 'Expected 1 space before logical operator; 0 found'; 72 $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBefore'); 73 if ($fix === true) { 74 $phpcsFile->fixer->addContentBefore($stackPtr, ' '); 75 } 76 } else { 77 $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); 78 if ($tokens[$stackPtr]['line'] === $tokens[$prev]['line'] 79 && strlen($tokens[($stackPtr - 1)]['content']) !== 1 80 ) { 81 $found = strlen($tokens[($stackPtr - 1)]['content']); 82 $error = 'Expected 1 space before logical operator; %s found'; 83 $data = array($found); 84 $fix = $phpcsFile->addFixableError($error, $stackPtr, 'TooMuchSpaceBefore', $data); 85 if ($fix === true) { 86 $phpcsFile->fixer->replaceToken(($stackPtr - 1), ' '); 87 } 88 } 89 } 90 91 // Check there is one space after the operator. 92 if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) { 93 $error = 'Expected 1 space after logical operator; 0 found'; 94 $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfter'); 95 if ($fix === true) { 96 $phpcsFile->fixer->addContent($stackPtr, ' '); 97 } 98 } else { 99 $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); 100 if ($tokens[$stackPtr]['line'] === $tokens[$next]['line'] 101 && strlen($tokens[($stackPtr + 1)]['content']) !== 1 102 ) { 103 $found = strlen($tokens[($stackPtr + 1)]['content']); 104 $error = 'Expected 1 space after logical operator; %s found'; 105 $data = array($found); 106 $fix = $phpcsFile->addFixableError($error, $stackPtr, 'TooMuchSpaceAfter', $data); 107 if ($fix === true) { 108 $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); 109 } 110 } 111 } 112 113 }//end process() 114 115 116}//end class 117