1<?php
2/**
3 * Generic_Sniffs_PHP_SAPIUsageSniff.
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 * Generic_Sniffs_PHP_SAPIUsageSniff.
17 *
18 * Ensures the PHP_SAPI constant is used instead of php_sapi_name().
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: @package_version@
26 * @link      http://pear.php.net/package/PHP_CodeSniffer
27 */
28class Generic_Sniffs_PHP_SAPIUsageSniff 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 array(T_STRING);
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 in
49     *                                        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
57        $ignore = array(
58                   T_DOUBLE_COLON    => true,
59                   T_OBJECT_OPERATOR => true,
60                   T_FUNCTION        => true,
61                   T_CONST           => true,
62                  );
63
64        $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
65        if (isset($ignore[$tokens[$prevToken]['code']]) === true) {
66            // Not a call to a PHP function.
67            return;
68        }
69
70        $function = strtolower($tokens[$stackPtr]['content']);
71        if ($function === 'php_sapi_name') {
72            $error = 'Use the PHP_SAPI constant instead of calling php_sapi_name()';
73            $phpcsFile->addError($error, $stackPtr, 'FunctionFound');
74        }
75
76    }//end process()
77
78
79}//end class
80