← Back to branch summary

~ubuntu-branches/ubuntu/saucy/php-codesniffer/saucy

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.1.0/CodeSniffer/Standards/Squiz/Sniffs/Operators/ValidLogicalOperatorsSniff.php

  • Committer: Bazaar Package Importer
  • Author(s): Jack Bates
  • Date: 2008-10-01 17:39:43 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20081001173943-2dy06n1e8zwyw1o8
Tags: 1.1.0-1
* New upstream release
* Acknowledge NMU, thanks Jan

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHP_CodeSniffer-1.1.0/CodeSniffer/Standards/Squiz/Sniffs/Operators/ValidLogicalOperatorsSniff.php
 
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 Squiz Pty Ltd (ABN 77 084 670 600)
 
12
 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
 
13
 * @version   CVS: $Id: ValidLogicalOperatorsSniff.php,v 1.6 2007/10/18 01:14:14 squiz Exp $
 
14
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
15
 */
 
16
 
 
17
/**
 
18
 * Squiz_Sniffs_Operators_ValidLogicalOperatorsSniff.
 
19
 *
 
20
 * Checks to ensure that the logical operators 'and' and 'or' are not used.
 
21
 * Use the && and || operators instead.
 
22
 *
 
23
 * @category  PHP
 
24
 * @package   PHP_CodeSniffer
 
25
 * @author    Greg Sherwood <gsherwood@squiz.net>
 
26
 * @author    Marc McIntyre <mmcintyre@squiz.net>
 
27
 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
 
28
 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
 
29
 * @version   Release: 1.1.0
 
30
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
31
 */
 
32
class Squiz_Sniffs_Operators_ValidLogicalOperatorsSniff implements PHP_CodeSniffer_Sniff
 
33
{
 
34
 
 
35
 
 
36
    /**
 
37
     * Returns an array of tokens this test wants to listen for.
 
38
     *
 
39
     * @return array
 
40
     */
 
41
    public function register()
 
42
    {
 
43
        return array(
 
44
                T_LOGICAL_AND,
 
45
                T_LOGICAL_OR,
 
46
                T_LOGICAL_XOR,
 
47
               );
 
48
 
 
49
    }//end register()
 
50
 
 
51
 
 
52
    /**
 
53
     * Processes this test, when one of its tokens is encountered.
 
54
     *
 
55
     * @param PHP_CodeSniffer_File $phpcsFile The current file being scanned.
 
56
     * @param int                  $stackPtr  The position of the current token in the
 
57
     *                                        stack passed in $tokens.
 
58
     *
 
59
     * @return void
 
60
     */
 
61
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
62
    {
 
63
        $tokens = $phpcsFile->getTokens();
 
64
 
 
65
        $replacements = array(
 
66
                         'and' => '&&',
 
67
                         'or'  => '||',
 
68
                         'xor' => '^',
 
69
                        );
 
70
 
 
71
        $operator = $tokens[$stackPtr]['content'];
 
72
        if (isset($replacements[$operator]) === false) {
 
73
            return;
 
74
        }
 
75
 
 
76
        $replacement = $replacements[$operator];
 
77
        $error       = "Logical operator \"$operator\" is prohibited; use \"$replacement\" instead";
 
78
        $phpcsFile->addError($error, $stackPtr);
 
79
 
 
80
    }//end process()
 
81
 
 
82
 
 
83
}//end class
 
84
 
 
85
?>