1<?php
2/**
3 * Generic_Sniffs_PHP_UpperCaseConstantSniff.
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 * Generic_Sniffs_PHP_UpperCaseConstantSniff.
18 *
19 * Checks that all uses of TRUE, FALSE and NULL are uppercase.
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 Generic_Sniffs_PHP_UpperCaseConstantSniff implements PHP_CodeSniffer_Sniff
31{
32
33
34    /**
35     * Returns an array of tokens this test wants to listen for.
36     *
37     * @return array
38     */
39    public function register()
40    {
41        return array(
42                T_TRUE,
43                T_FALSE,
44                T_NULL,
45               );
46
47    }//end register()
48
49
50    /**
51     * Processes this sniff, when one of its tokens is encountered.
52     *
53     * @param PHP_CodeSniffer_File $phpcsFile The 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        $keyword  = $tokens[$stackPtr]['content'];
63        $expected = strtoupper($keyword);
64        if ($keyword !== $expected) {
65            if ($keyword === strtolower($keyword)) {
66                $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'lower');
67            } else {
68                $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'mixed');
69            }
70
71            $error = 'TRUE, FALSE and NULL must be uppercase; expected "%s" but found "%s"';
72            $data  = array(
73                      $expected,
74                      $keyword,
75                     );
76
77            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found', $data);
78            if ($fix === true) {
79                $phpcsFile->fixer->replaceToken($stackPtr, $expected);
80            }
81        } else {
82            $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'upper');
83        }
84
85    }//end process()
86
87
88}//end class
89