PHP_CodeSniffer
[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Source for file ValidLogicalOperatorsSniff.php

Documentation is available at ValidLogicalOperatorsSniff.php

  1. <?php
  2. /**
  3.  * Ensures logical operators 'and' and 'or' are not used.
  4.  *
  5.  * @author    Greg Sherwood <gsherwood@squiz.net>
  6.  * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
  7.  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
  8.  */
  9.  
  10. namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Operators;
  11.  
  12. use PHP_CodeSniffer\Sniffs\Sniff;
  13. use PHP_CodeSniffer\Files\File;
  14.  
  15. class ValidLogicalOperatorsSniff implements Sniff
  16. {
  17.  
  18.  
  19.     /**
  20.      * Returns an array of tokens this test wants to listen for.
  21.      *
  22.      * @return array 
  23.      */
  24.     public function register()
  25.     {
  26.         return array(
  27.                 T_LOGICAL_AND,
  28.                 T_LOGICAL_OR,
  29.                );
  30.  
  31.     }//end register()
  32.  
  33.  
  34.     /**
  35.      * Processes this test, when one of its tokens is encountered.
  36.      *
  37.      * @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being scanned.
  38.      * @param int                         $stackPtr  The position of the current token in the
  39.      *                                                stack passed in $tokens.
  40.      *
  41.      * @return void 
  42.      */
  43.     public function process(File $phpcsFile$stackPtr)
  44.     {
  45.         $tokens $phpcsFile->getTokens();
  46.  
  47.         $replacements = array(
  48.                          'and' => '&&',
  49.                          'or'  => '||',
  50.                         );
  51.  
  52.         $operator strtolower($tokens[$stackPtr]['content']);
  53.         if (isset($replacements[$operator]=== false{
  54.             return;
  55.         }
  56.  
  57.         $error 'Logical operator "%s" is prohibited; use "%s" instead';
  58.         $data  = array(
  59.                   $operator,
  60.                   $replacements[$operator],
  61.                  );
  62.         $phpcsFile->addError($error$stackPtr'NotAllowed'$data);
  63.  
  64.     }//end process()
  65.  
  66.  
  67. }//end class

Documentation generated on Mon, 11 Mar 2019 15:27:51 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.