1<?php
2/**
3 * Generic_Sniffs_Formatting_SpaceAfterCastSniff.
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_Formatting_SpaceAfterCastSniff.
18 *
19 * Ensures there is a single space after cast tokens.
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_Formatting_SpaceAfterCastSniff 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 PHP_CodeSniffer_Tokens::$castTokens;
42
43    }//end register()
44
45
46    /**
47     * Processes this test, when one of its tokens is encountered.
48     *
49     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
50     * @param int                  $stackPtr  The position of the current token in
51     *                                        the stack passed in $tokens.
52     *
53     * @return void
54     */
55    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
56    {
57        $tokens = $phpcsFile->getTokens();
58
59        if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) {
60            $error = 'A cast statement must be followed by a single space';
61            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpace');
62            if ($fix === true) {
63                $phpcsFile->fixer->addContent($stackPtr, ' ');
64            }
65
66            $phpcsFile->recordMetric($stackPtr, 'Spacing after cast statement', 0);
67            return;
68        }
69
70        $phpcsFile->recordMetric($stackPtr, 'Spacing after cast statement', $tokens[($stackPtr + 1)]['length']);
71
72        if ($tokens[($stackPtr + 1)]['length'] !== 1) {
73            $error = 'A cast statement must be followed by a single space';
74            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'TooMuchSpace');
75            if ($fix === true) {
76                $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' ');
77            }
78        }
79
80    }//end process()
81
82
83}//end class
84