Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \Drupal\Sniffs\Semantics\FunctionDefinition.
|
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\Semantics;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use PHP_CodeSniffer\Sniffs\Sniff;
|
Chris@17
|
14 use PHP_CodeSniffer\Util\Tokens;
|
Chris@17
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * Helper class to sniff for function definitions.
|
Chris@0
|
18 *
|
Chris@0
|
19 * @category PHP
|
Chris@0
|
20 * @package PHP_CodeSniffer
|
Chris@0
|
21 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
22 */
|
Chris@17
|
23 abstract class FunctionDefinition implements Sniff
|
Chris@0
|
24 {
|
Chris@0
|
25
|
Chris@0
|
26
|
Chris@0
|
27 /**
|
Chris@0
|
28 * Returns an array of tokens this test wants to listen for.
|
Chris@0
|
29 *
|
Chris@0
|
30 * @return array
|
Chris@0
|
31 */
|
Chris@0
|
32 public function register()
|
Chris@0
|
33 {
|
Chris@0
|
34 return array(T_STRING);
|
Chris@0
|
35
|
Chris@0
|
36 }//end register()
|
Chris@0
|
37
|
Chris@0
|
38
|
Chris@0
|
39 /**
|
Chris@0
|
40 * Processes this test, when one of its tokens is encountered.
|
Chris@0
|
41 *
|
Chris@17
|
42 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
43 * @param int $stackPtr The position of the current token
|
Chris@17
|
44 * in the stack passed in $tokens.
|
Chris@0
|
45 *
|
Chris@0
|
46 * @return void
|
Chris@0
|
47 */
|
Chris@17
|
48 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
49 {
|
Chris@0
|
50 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
51 // Check if this is a function definition.
|
Chris@0
|
52 $functionPtr = $phpcsFile->findPrevious(
|
Chris@17
|
53 Tokens::$emptyTokens,
|
Chris@0
|
54 ($stackPtr - 1),
|
Chris@0
|
55 null,
|
Chris@0
|
56 true
|
Chris@0
|
57 );
|
Chris@0
|
58 if ($tokens[$functionPtr]['code'] === T_FUNCTION) {
|
Chris@0
|
59 $this->processFunction($phpcsFile, $stackPtr, $functionPtr);
|
Chris@0
|
60 }
|
Chris@0
|
61
|
Chris@0
|
62 }//end process()
|
Chris@0
|
63
|
Chris@0
|
64
|
Chris@0
|
65 /**
|
Chris@0
|
66 * Process this function definition.
|
Chris@0
|
67 *
|
Chris@17
|
68 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
69 * @param int $stackPtr The position of the function name in the stack.
|
Chris@17
|
70 * name in the stack.
|
Chris@17
|
71 * @param int $functionPtr The position of the function keyword in the stack.
|
Chris@17
|
72 * keyword in the stack.
|
Chris@0
|
73 *
|
Chris@0
|
74 * @return void
|
Chris@0
|
75 */
|
Chris@17
|
76 public abstract function processFunction(File $phpcsFile, $stackPtr, $functionPtr);
|
Chris@0
|
77
|
Chris@0
|
78
|
Chris@0
|
79 }//end class
|