1<?php
2/**
3 * Squiz_Sniffs_Functions_FunctionDuplicateArgumentSpacingSniff.
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_Functions_FunctionDuplicateArgumentSpacingSniff.
18 *
19 * Checks that duplicate arguments are not used in function declarations.
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_Functions_FunctionDuplicateArgumentSniff 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(T_FUNCTION);
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
51     *                                        in 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        $openBracket  = $tokens[$stackPtr]['parenthesis_opener'];
60        $closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
61
62        $foundVariables = array();
63        for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
64            if ($tokens[$i]['code'] === T_VARIABLE) {
65                $variable = $tokens[$i]['content'];
66                if (in_array($variable, $foundVariables) === true) {
67                    $error = 'Variable "%s" appears more than once in function declaration';
68                    $data  = array($variable);
69                    $phpcsFile->addError($error, $i, 'Found', $data);
70                } else {
71                    $foundVariables[] = $variable;
72                }
73            }
74        }
75
76    }//end process()
77
78
79}//end class
80