1<?php
2/**
3 * Generic_Sniffs_PHP_LowerCaseConstantSniff.
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_LowerCaseConstantSniff.
18 *
19 * Checks that all uses of true, false and null are lowercase.
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_LowerCaseConstantSniff 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 array(
52                T_TRUE,
53                T_FALSE,
54                T_NULL,
55               );
56
57    }//end register()
58
59
60    /**
61     * Processes this sniff, when one of its tokens is encountered.
62     *
63     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
64     * @param int                  $stackPtr  The position of the current token in the
65     *                                        stack passed in $tokens.
66     *
67     * @return void
68     */
69    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
70    {
71        $tokens   = $phpcsFile->getTokens();
72        $keyword  = $tokens[$stackPtr]['content'];
73        $expected = strtolower($keyword);
74        if ($keyword !== $expected) {
75            if ($keyword === strtoupper($keyword)) {
76                $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'upper');
77            } else {
78                $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'mixed');
79            }
80
81            $error = 'TRUE, FALSE and NULL must be lowercase; expected "%s" but found "%s"';
82            $data  = array(
83                      $expected,
84                      $keyword,
85                     );
86
87            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found', $data);
88            if ($fix === true) {
89                $phpcsFile->fixer->replaceToken($stackPtr, $expected);
90            }
91        } else {
92            $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'lower');
93        }
94
95    }//end process()
96
97
98}//end class
99