Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \Drupal\Sniffs\Semantics\TInHookMenuSniff.
|
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\Util\Tokens;
|
Chris@17
|
14
|
Chris@0
|
15 /**
|
Chris@0
|
16 * Checks that t() is not used in hook_menu().
|
Chris@0
|
17 *
|
Chris@0
|
18 * @category PHP
|
Chris@0
|
19 * @package PHP_CodeSniffer
|
Chris@0
|
20 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
21 */
|
Chris@17
|
22 class TInHookMenuSniff extends FunctionDefinition
|
Chris@0
|
23 {
|
Chris@0
|
24
|
Chris@0
|
25
|
Chris@0
|
26 /**
|
Chris@0
|
27 * Process this function definition.
|
Chris@0
|
28 *
|
Chris@17
|
29 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
30 * @param int $stackPtr The position of the function name in the stack.
|
Chris@17
|
31 * name in the stack.
|
Chris@17
|
32 * @param int $functionPtr The position of the function keyword in the stack.
|
Chris@17
|
33 * keyword in the stack.
|
Chris@0
|
34 *
|
Chris@0
|
35 * @return void
|
Chris@0
|
36 */
|
Chris@17
|
37 public function processFunction(File $phpcsFile, $stackPtr, $functionPtr)
|
Chris@0
|
38 {
|
Chris@0
|
39 $fileExtension = strtolower(substr($phpcsFile->getFilename(), -6));
|
Chris@0
|
40 // Only check in *.module files.
|
Chris@0
|
41 if ($fileExtension !== 'module') {
|
Chris@0
|
42 return;
|
Chris@0
|
43 }
|
Chris@0
|
44
|
Chris@0
|
45 $fileName = substr(basename($phpcsFile->getFilename()), 0, -7);
|
Chris@0
|
46 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
47 if ($tokens[$stackPtr]['content'] !== ($fileName.'_menu')) {
|
Chris@0
|
48 return;
|
Chris@0
|
49 }
|
Chris@0
|
50
|
Chris@0
|
51 // Search in the function body for t() calls.
|
Chris@0
|
52 $string = $phpcsFile->findNext(
|
Chris@0
|
53 T_STRING,
|
Chris@0
|
54 $tokens[$functionPtr]['scope_opener'],
|
Chris@0
|
55 $tokens[$functionPtr]['scope_closer']
|
Chris@0
|
56 );
|
Chris@0
|
57 while ($string !== false) {
|
Chris@0
|
58 if ($tokens[$string]['content'] === 't') {
|
Chris@0
|
59 $opener = $phpcsFile->findNext(
|
Chris@17
|
60 Tokens::$emptyTokens,
|
Chris@0
|
61 ($string + 1),
|
Chris@0
|
62 null,
|
Chris@0
|
63 true
|
Chris@0
|
64 );
|
Chris@0
|
65 if ($opener !== false
|
Chris@0
|
66 && $tokens[$opener]['code'] === T_OPEN_PARENTHESIS
|
Chris@0
|
67 ) {
|
Chris@0
|
68 $error = 'Do not use t() in hook_menu()';
|
Chris@0
|
69 $phpcsFile->addError($error, $string, 'TFound');
|
Chris@0
|
70 }
|
Chris@0
|
71 }
|
Chris@0
|
72
|
Chris@0
|
73 $string = $phpcsFile->findNext(
|
Chris@0
|
74 T_STRING,
|
Chris@0
|
75 ($string + 1),
|
Chris@0
|
76 $tokens[$functionPtr]['scope_closer']
|
Chris@0
|
77 );
|
Chris@0
|
78 }//end while
|
Chris@0
|
79
|
Chris@0
|
80 }//end processFunction()
|
Chris@0
|
81
|
Chris@0
|
82
|
Chris@0
|
83 }//end class
|