Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \Drupal\Sniffs\Semantics\ConstantNameSniff
|
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 Drupal\Sniffs\Semantics\FunctionCall;
|
Chris@17
|
13 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
14
|
Chris@0
|
15 /**
|
Chris@0
|
16 * Checks that constants introduced with define() in module or install files start
|
Chris@0
|
17 * with the module's name.
|
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 class ConstantNameSniff extends FunctionCall
|
Chris@0
|
24 {
|
Chris@0
|
25
|
Chris@0
|
26
|
Chris@0
|
27 /**
|
Chris@0
|
28 * Returns an array of function names this test wants to listen for.
|
Chris@0
|
29 *
|
Chris@0
|
30 * @return array
|
Chris@0
|
31 */
|
Chris@0
|
32 public function registerFunctionNames()
|
Chris@0
|
33 {
|
Chris@0
|
34 return array('define');
|
Chris@0
|
35
|
Chris@0
|
36 }//end registerFunctionNames()
|
Chris@0
|
37
|
Chris@0
|
38
|
Chris@0
|
39 /**
|
Chris@0
|
40 * Processes this function call.
|
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 function call in
|
Chris@17
|
44 * the stack.
|
Chris@17
|
45 * @param int $openBracket The position of the opening
|
Chris@17
|
46 * parenthesis in the stack.
|
Chris@17
|
47 * @param int $closeBracket The position of the closing
|
Chris@17
|
48 * parenthesis in the stack.
|
Chris@0
|
49 *
|
Chris@0
|
50 * @return void
|
Chris@0
|
51 */
|
Chris@0
|
52 public function processFunctionCall(
|
Chris@17
|
53 File $phpcsFile,
|
Chris@0
|
54 $stackPtr,
|
Chris@0
|
55 $openBracket,
|
Chris@0
|
56 $closeBracket
|
Chris@0
|
57 ) {
|
Chris@0
|
58 $nameParts = explode('.', basename($phpcsFile->getFilename()));
|
Chris@0
|
59 $fileExtension = end($nameParts);
|
Chris@0
|
60 // Only check in *.module files.
|
Chris@0
|
61 if ($fileExtension !== 'module' && $fileExtension !== 'install') {
|
Chris@0
|
62 return;
|
Chris@0
|
63 }
|
Chris@0
|
64
|
Chris@0
|
65 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
66 $argument = $this->getArgument(1);
|
Chris@0
|
67 if ($tokens[$argument['start']]['code'] !== T_CONSTANT_ENCAPSED_STRING) {
|
Chris@0
|
68 // Not a string literal, so this is some obscure constant that we ignore.
|
Chris@0
|
69 return;
|
Chris@0
|
70 }
|
Chris@0
|
71
|
Chris@0
|
72 $moduleName = reset($nameParts);
|
Chris@0
|
73 $expectedStart = strtoupper($moduleName);
|
Chris@0
|
74 // Remove the quotes around the string litral.
|
Chris@0
|
75 $constant = substr($tokens[$argument['start']]['content'], 1, -1);
|
Chris@0
|
76 if (strpos($constant, $expectedStart) !== 0) {
|
Chris@0
|
77 $warning = 'All constants defined by a module must be prefixed with the module\'s name, expected "%s" but found "%s"';
|
Chris@0
|
78 $data = array(
|
Chris@0
|
79 $expectedStart."_$constant",
|
Chris@0
|
80 $constant,
|
Chris@0
|
81 );
|
Chris@0
|
82 $phpcsFile->addWarning($warning, $stackPtr, 'ConstantStart', $data);
|
Chris@0
|
83 }
|
Chris@0
|
84
|
Chris@0
|
85 }//end processFunctionCall()
|
Chris@0
|
86
|
Chris@0
|
87
|
Chris@0
|
88 }//end class
|