Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \DrupalPractice\Sniffs\FunctionDefinitions\HookInitCssSniff.
|
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 DrupalPractice\Sniffs\FunctionDefinitions;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use Drupal\Sniffs\Semantics\FunctionDefinition;
|
Chris@17
|
14 use DrupalPractice\Project;
|
Chris@17
|
15 use PHP_CodeSniffer\Util\Tokens;
|
Chris@17
|
16
|
Chris@0
|
17 /**
|
Chris@0
|
18 * Checks that drupal_add_css() is not used in hook_init().
|
Chris@0
|
19 *
|
Chris@0
|
20 * @category PHP
|
Chris@0
|
21 * @package PHP_CodeSniffer
|
Chris@0
|
22 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
23 */
|
Chris@17
|
24 class HookInitCssSniff extends FunctionDefinition
|
Chris@0
|
25 {
|
Chris@0
|
26
|
Chris@0
|
27
|
Chris@0
|
28 /**
|
Chris@0
|
29 * Process this function definition.
|
Chris@0
|
30 *
|
Chris@17
|
31 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
32 * @param int $stackPtr The position of the function name
|
Chris@17
|
33 * in the stack.
|
Chris@17
|
34 * @param int $functionPtr The position of the function keyword
|
Chris@17
|
35 * in the stack.
|
Chris@0
|
36 *
|
Chris@0
|
37 * @return void
|
Chris@0
|
38 */
|
Chris@17
|
39 public function processFunction(File $phpcsFile, $stackPtr, $functionPtr)
|
Chris@0
|
40 {
|
Chris@0
|
41 $fileExtension = strtolower(substr($phpcsFile->getFilename(), -6));
|
Chris@0
|
42 // Only check in *.module files.
|
Chris@0
|
43 if ($fileExtension !== 'module') {
|
Chris@0
|
44 return;
|
Chris@0
|
45 }
|
Chris@0
|
46
|
Chris@0
|
47 // This check only applies to Drupal 7, not Drupal 6.
|
Chris@17
|
48 if (Project::getCoreVersion($phpcsFile) !== '7.x') {
|
Chris@0
|
49 return;
|
Chris@0
|
50 }
|
Chris@0
|
51
|
Chris@0
|
52 $fileName = substr(basename($phpcsFile->getFilename()), 0, -7);
|
Chris@0
|
53 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
54 if ($tokens[$stackPtr]['content'] !== ($fileName.'_init') && $tokens[$stackPtr]['content'] !== ($fileName.'_page_build')) {
|
Chris@0
|
55 return;
|
Chris@0
|
56 }
|
Chris@0
|
57
|
Chris@0
|
58 // Search in the function body for drupal_add_css() calls.
|
Chris@0
|
59 $string = $phpcsFile->findNext(
|
Chris@0
|
60 T_STRING,
|
Chris@0
|
61 $tokens[$functionPtr]['scope_opener'],
|
Chris@0
|
62 $tokens[$functionPtr]['scope_closer']
|
Chris@0
|
63 );
|
Chris@0
|
64 while ($string !== false) {
|
Chris@0
|
65 if ($tokens[$string]['content'] === 'drupal_add_css' || $tokens[$string]['content'] === 'drupal_add_js') {
|
Chris@0
|
66 $opener = $phpcsFile->findNext(
|
Chris@17
|
67 Tokens::$emptyTokens,
|
Chris@0
|
68 ($string + 1),
|
Chris@0
|
69 null,
|
Chris@0
|
70 true
|
Chris@0
|
71 );
|
Chris@0
|
72 if ($opener !== false
|
Chris@0
|
73 && $tokens[$opener]['code'] === T_OPEN_PARENTHESIS
|
Chris@0
|
74 ) {
|
Chris@0
|
75 if ($tokens[$stackPtr]['content'] === ($fileName.'_init')) {
|
Chris@0
|
76 $warning = 'Do not use %s() in hook_init(), use #attached for CSS and JS in your page/form callback or in hook_page_build() instead';
|
Chris@0
|
77 $phpcsFile->addWarning($warning, $string, 'AddFunctionFound', array($tokens[$string]['content']));
|
Chris@0
|
78 } else {
|
Chris@0
|
79 $warning = 'Do not use %s() in hook_page_build(), use #attached for CSS and JS on the $page render array instead';
|
Chris@0
|
80 $phpcsFile->addWarning($warning, $string, 'AddFunctionFoundPageBuild', array($tokens[$string]['content']));
|
Chris@0
|
81 }
|
Chris@0
|
82 }
|
Chris@0
|
83 }
|
Chris@0
|
84
|
Chris@0
|
85 $string = $phpcsFile->findNext(
|
Chris@0
|
86 T_STRING,
|
Chris@0
|
87 ($string + 1),
|
Chris@0
|
88 $tokens[$functionPtr]['scope_closer']
|
Chris@0
|
89 );
|
Chris@0
|
90 }//end while
|
Chris@0
|
91
|
Chris@0
|
92 }//end processFunction()
|
Chris@0
|
93
|
Chris@0
|
94
|
Chris@0
|
95 }//end class
|