Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \DrupalPractice\Sniffs\Objects\GlobalClassSniff.
|
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\Objects;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use PHP_CodeSniffer\Sniffs\Sniff;
|
Chris@17
|
14 use DrupalPractice\Project;
|
Chris@17
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * Checks that Node::load() calls and friends are not used in forms, controllers or
|
Chris@0
|
18 * services.
|
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 GlobalClassSniff implements Sniff
|
Chris@0
|
25 {
|
Chris@0
|
26
|
Chris@0
|
27 /**
|
Chris@0
|
28 * Class names that should not be called statically, mostly entity classes.
|
Chris@0
|
29 *
|
Chris@0
|
30 * @var string[]
|
Chris@0
|
31 */
|
Chris@0
|
32 protected $classes = array(
|
Chris@0
|
33 'File',
|
Chris@0
|
34 'Node',
|
Chris@0
|
35 'NodeType',
|
Chris@0
|
36 'Role',
|
Chris@0
|
37 'Term',
|
Chris@0
|
38 'User',
|
Chris@0
|
39 );
|
Chris@0
|
40
|
Chris@0
|
41
|
Chris@0
|
42 /**
|
Chris@0
|
43 * Returns an array of tokens this test wants to listen for.
|
Chris@0
|
44 *
|
Chris@0
|
45 * @return array
|
Chris@0
|
46 */
|
Chris@0
|
47 public function register()
|
Chris@0
|
48 {
|
Chris@0
|
49 return array(T_STRING);
|
Chris@0
|
50
|
Chris@0
|
51 }//end register()
|
Chris@0
|
52
|
Chris@0
|
53
|
Chris@0
|
54 /**
|
Chris@0
|
55 * Processes this test, when one of its tokens is encountered.
|
Chris@0
|
56 *
|
Chris@17
|
57 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
58 * @param int $stackPtr The position of the current token
|
Chris@17
|
59 * in the stack passed in $tokens.
|
Chris@0
|
60 *
|
Chris@0
|
61 * @return void
|
Chris@0
|
62 */
|
Chris@17
|
63 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
64 {
|
Chris@0
|
65 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
66
|
Chris@0
|
67 // We are only interested in static class method calls, not in the global
|
Chris@0
|
68 // scope.
|
Chris@0
|
69 if (in_array($tokens[$stackPtr]['content'], $this->classes) === false
|
Chris@0
|
70 || $tokens[($stackPtr + 1)]['code'] !== T_DOUBLE_COLON
|
Chris@0
|
71 || isset($tokens[($stackPtr + 2)]) === false
|
Chris@0
|
72 || $tokens[($stackPtr + 2)]['code'] !== T_STRING
|
Chris@0
|
73 || in_array($tokens[($stackPtr + 2)]['content'], array('load', 'loadMultiple')) === false
|
Chris@0
|
74 || isset($tokens[($stackPtr + 3)]) === false
|
Chris@0
|
75 || $tokens[($stackPtr + 3)]['code'] !== T_OPEN_PARENTHESIS
|
Chris@0
|
76 || empty($tokens[$stackPtr]['conditions']) === true
|
Chris@0
|
77 ) {
|
Chris@0
|
78 return;
|
Chris@0
|
79 }
|
Chris@0
|
80
|
Chris@0
|
81 // Check that this statement is not in a static function.
|
Chris@0
|
82 foreach ($tokens[$stackPtr]['conditions'] as $conditionPtr => $conditionCode) {
|
Chris@0
|
83 if ($conditionCode === T_FUNCTION && $phpcsFile->getMethodProperties($conditionPtr)['is_static'] === true) {
|
Chris@0
|
84 return;
|
Chris@0
|
85 }
|
Chris@0
|
86 }
|
Chris@0
|
87
|
Chris@0
|
88 // Check if the class extends another class and get the name of the class
|
Chris@0
|
89 // that is extended.
|
Chris@0
|
90 $classPtr = key($tokens[$stackPtr]['conditions']);
|
Chris@0
|
91 $extendsName = $phpcsFile->findExtendedClassName($classPtr);
|
Chris@0
|
92
|
Chris@0
|
93 if (($extendsName === false
|
Chris@17
|
94 || in_array($extendsName, GlobalDrupalSniff::$baseClasses) === false)
|
Chris@17
|
95 && Project::isServiceClass($phpcsFile, $classPtr) === false
|
Chris@0
|
96 ) {
|
Chris@0
|
97 return;
|
Chris@0
|
98 }
|
Chris@0
|
99
|
Chris@0
|
100 $warning = '%s::%s calls should be avoided in classes, use dependency injection instead';
|
Chris@0
|
101 $data = array(
|
Chris@0
|
102 $tokens[$stackPtr]['content'],
|
Chris@0
|
103 $tokens[($stackPtr + 2)]['content'],
|
Chris@0
|
104 );
|
Chris@0
|
105 $phpcsFile->addWarning($warning, $stackPtr, 'GlobalClass', $data);
|
Chris@0
|
106
|
Chris@0
|
107 }//end process()
|
Chris@0
|
108
|
Chris@0
|
109
|
Chris@0
|
110 }//end class
|