Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \DrupalPractice\Sniffs\FunctionCalls\DbQuerySniff
|
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\FunctionCalls;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use Drupal\Sniffs\Semantics\FunctionCall;
|
Chris@17
|
14 use DrupalPractice\Project;
|
Chris@17
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * Check that UPDATE/DELETE queries are not used in db_query() in Drupal 7.
|
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 DbQuerySniff 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('db_query');
|
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 // This check only applies to Drupal 7, not Drupal 6.
|
Chris@17
|
59 if (Project::getCoreVersion($phpcsFile) !== '7.x') {
|
Chris@0
|
60 return;
|
Chris@0
|
61 }
|
Chris@0
|
62
|
Chris@0
|
63 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
64 $argument = $this->getArgument(1);
|
Chris@0
|
65
|
Chris@0
|
66 $query_start = '';
|
Chris@0
|
67 for ($start = $argument['start']; $tokens[$start]['code'] === T_CONSTANT_ENCAPSED_STRING && empty($query_start) === true; $start++) {
|
Chris@0
|
68 // Remove quote and white space from the beginning.
|
Chris@0
|
69 $query_start = trim(substr($tokens[$start]['content'], 1));
|
Chris@0
|
70 // Just look at the first word.
|
Chris@0
|
71 $parts = explode(' ', $query_start);
|
Chris@0
|
72 $query_start = $parts[0];
|
Chris@0
|
73
|
Chris@0
|
74 if (in_array(strtoupper($query_start), array('INSERT', 'UPDATE', 'DELETE', 'TRUNCATE')) === true) {
|
Chris@0
|
75 $warning = 'Do not use %s queries with db_query(), use %s instead';
|
Chris@0
|
76 $phpcsFile->addWarning($warning, $start, 'DbQuery', array($query_start, 'db_'.strtolower($query_start).'()'));
|
Chris@0
|
77 }
|
Chris@0
|
78 }
|
Chris@0
|
79
|
Chris@0
|
80 }//end processFunctionCall()
|
Chris@0
|
81
|
Chris@0
|
82
|
Chris@0
|
83 }//end class
|