1<?php
2/**
3 * Squiz_Sniffs_WhiteSpace_ScopeKeywordSpacingSniff.
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 * Squiz_Sniffs_WhiteSpace_ScopeKeywordSpacingSniff.
18 *
19 * Ensure there is a single space after scope keywords.
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 Squiz_Sniffs_WhiteSpace_ScopeKeywordSpacingSniff 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        $register   = PHP_CodeSniffer_Tokens::$scopeModifiers;
42        $register[] = T_STATIC;
43        return $register;
44
45    }//end register()
46
47
48    /**
49     * Processes this test, when one of its tokens is encountered.
50     *
51     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
52     * @param int                  $stackPtr  The position of the current token
53     *                                        in the stack passed in $tokens.
54     *
55     * @return void
56     */
57    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
58    {
59        $tokens = $phpcsFile->getTokens();
60
61        $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
62        $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
63
64        if ($tokens[$stackPtr]['code'] === T_STATIC
65            && ($tokens[$nextToken]['code'] === T_DOUBLE_COLON
66            || $tokens[$prevToken]['code'] === T_NEW)
67        ) {
68            // Late static binding, e.g., static:: OR new static() usage.
69            return;
70        }
71
72        if ($tokens[$prevToken]['code'] === T_AS) {
73            // Trait visibilty change, e.g., "use HelloWorld { sayHello as private; }".
74            return;
75        }
76
77        $nextToken = $tokens[($stackPtr + 1)];
78        if (strlen($nextToken['content']) !== 1
79            || $nextToken['content'] === $phpcsFile->eolChar
80        ) {
81            $error = 'Scope keyword "%s" must be followed by a single space';
82            $data  = array($tokens[$stackPtr]['content']);
83            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'Incorrect', $data);
84            if ($fix === true) {
85                $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' ');
86            }
87        }
88
89    }//end process()
90
91
92}//end class
93