Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \Drupal\Sniffs\Functions\FunctionDeclarationSniff.
|
Chris@0
|
4 *
|
Chris@0
|
5 * @category PHP
|
Chris@0
|
6 * @package PHP_CodeSniffer
|
Chris@0
|
7 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
8 */
|
Chris@0
|
9
|
Chris@17
|
10 namespace Drupal\Sniffs\Functions;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use PHP_CodeSniffer\Sniffs\Sniff;
|
Chris@17
|
14
|
Chris@0
|
15 /**
|
Chris@0
|
16 * Ensure that there is only one space after the function keyword and no space
|
Chris@0
|
17 * before the opening parenthesis.
|
Chris@0
|
18 *
|
Chris@0
|
19 * @deprecated in Coder 8.x, will be removed in Coder 9.x.
|
Chris@0
|
20 * Squiz.Functions.MultiLineFunctionDeclaration is used instead, see ruleset.xml.
|
Chris@0
|
21 *
|
Chris@0
|
22 * @category PHP
|
Chris@0
|
23 * @package PHP_CodeSniffer
|
Chris@0
|
24 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
25 */
|
Chris@17
|
26 class FunctionDeclarationSniff implements Sniff
|
Chris@0
|
27 {
|
Chris@0
|
28
|
Chris@0
|
29
|
Chris@0
|
30 /**
|
Chris@0
|
31 * Returns an array of tokens this test wants to listen for.
|
Chris@0
|
32 *
|
Chris@0
|
33 * @return array
|
Chris@0
|
34 */
|
Chris@0
|
35 public function register()
|
Chris@0
|
36 {
|
Chris@0
|
37 return array(T_FUNCTION);
|
Chris@0
|
38
|
Chris@0
|
39 }//end register()
|
Chris@0
|
40
|
Chris@0
|
41
|
Chris@0
|
42 /**
|
Chris@0
|
43 * Processes this test, when one of its tokens is encountered.
|
Chris@0
|
44 *
|
Chris@17
|
45 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
46 * @param int $stackPtr The position of the current token
|
Chris@17
|
47 * in the stack passed in $tokens.
|
Chris@0
|
48 *
|
Chris@0
|
49 * @return void
|
Chris@0
|
50 */
|
Chris@17
|
51 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
52 {
|
Chris@0
|
53 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
54
|
Chris@0
|
55 if ($tokens[($stackPtr + 1)]['content'] !== ' ') {
|
Chris@0
|
56 $error = 'Expected exactly one space after the function keyword';
|
Chris@0
|
57 $phpcsFile->addError($error, ($stackPtr + 1), 'SpaceAfter');
|
Chris@0
|
58 }
|
Chris@0
|
59
|
Chris@0
|
60 if (isset($tokens[($stackPtr + 3)]) === true
|
Chris@0
|
61 && $tokens[($stackPtr + 3)]['code'] === T_WHITESPACE
|
Chris@0
|
62 ) {
|
Chris@0
|
63 $error = 'Space before opening parenthesis of function definition prohibited';
|
Chris@0
|
64 $phpcsFile->addError($error, ($stackPtr + 3), 'SpaceBeforeParenthesis');
|
Chris@0
|
65 }
|
Chris@0
|
66
|
Chris@0
|
67 }//end process()
|
Chris@0
|
68
|
Chris@0
|
69
|
Chris@0
|
70 }//end class
|