~ubuntu-branches/ubuntu/utopic/php-codesniffer/utopic-proposed

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.5.3/CodeSniffer/Standards/Squiz/Sniffs/PHP/DisallowBooleanStatementSniff.php

  • Committer: Package Import Robot
  • Author(s): David Prévot
  • Date: 2014-07-21 14:42:41 UTC
  • mto: This revision was merged to the branch mainline in revision 7.
  • Revision ID: package-import@ubuntu.com-20140721144241-t0v9knmgtzftbsw6
Tags: upstream-1.5.3
Import upstream version 1.5.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?php
 
2
/**
 
3
 * Squiz_Sniffs_PHP_DisallowBooleanStatementSniff.
 
4
 *
 
5
 * PHP version 5
 
6
 *
 
7
 * @category  PHP
 
8
 * @package   PHP_CodeSniffer
 
9
 * @author    Greg Sherwood <gsherwood@squiz.net>
 
10
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
 
11
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 
12
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
13
 */
 
14
 
 
15
/**
 
16
 * Squiz_Sniffs_PHP_DisallowBooleanStatementSniff.
 
17
 *
 
18
 * Ensures that boolean operators are only used inside control structure conditions.
 
19
 *
 
20
 * @category  PHP
 
21
 * @package   PHP_CodeSniffer
 
22
 * @author    Greg Sherwood <gsherwood@squiz.net>
 
23
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
 
24
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 
25
 * @version   Release: 1.5.3
 
26
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
27
 */
 
28
class Squiz_Sniffs_PHP_DisallowBooleanStatementSniff implements PHP_CodeSniffer_Sniff
 
29
{
 
30
 
 
31
 
 
32
    /**
 
33
     * Returns an array of tokens this test wants to listen for.
 
34
     *
 
35
     * @return array
 
36
     */
 
37
    public function register()
 
38
    {
 
39
        return PHP_CodeSniffer_Tokens::$booleanOperators;
 
40
 
 
41
    }//end register()
 
42
 
 
43
 
 
44
    /**
 
45
     * Processes this test, when one of its tokens is encountered.
 
46
     *
 
47
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
 
48
     * @param int                  $stackPtr  The position of the current token
 
49
     *                                        in the stack passed in $tokens.
 
50
     *
 
51
     * @return void
 
52
     */
 
53
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
54
    {
 
55
        $tokens = $phpcsFile->getTokens();
 
56
        if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
 
57
            $foundOwner = false;
 
58
            foreach ($tokens[$stackPtr]['nested_parenthesis'] as $open => $close) {
 
59
                if (isset($tokens[$open]['parenthesis_owner']) === true) {
 
60
                    // Any owner means we are not just a simple statement.
 
61
                    return;
 
62
                }
 
63
            }
 
64
        }
 
65
 
 
66
        $error = 'Boolean operators are not allowed outside of control structure conditions';
 
67
        $phpcsFile->addError($error, $stackPtr, 'Found');
 
68
 
 
69
    }//end process()
 
70
 
 
71
 
 
72
}//end class
 
73
 
 
74
?>