Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@0
|
3 * Verifies that control statements conform to their coding standards.
|
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\ControlStructures;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use PHP_CodeSniffer\Sniffs\Sniff;
|
Chris@17
|
14
|
Chris@0
|
15 /**
|
Chris@0
|
16 * Checks that "elseif" is used instead of "else if".
|
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 ElseIfSniff implements Sniff
|
Chris@0
|
23 {
|
Chris@0
|
24
|
Chris@0
|
25
|
Chris@0
|
26 /**
|
Chris@0
|
27 * Returns an array of tokens this test wants to listen for.
|
Chris@0
|
28 *
|
Chris@0
|
29 * @return array
|
Chris@0
|
30 */
|
Chris@0
|
31 public function register()
|
Chris@0
|
32 {
|
Chris@0
|
33 return array(T_ELSE);
|
Chris@0
|
34
|
Chris@0
|
35 }//end register()
|
Chris@0
|
36
|
Chris@0
|
37
|
Chris@0
|
38 /**
|
Chris@0
|
39 * Processes this test, when one of its tokens is encountered.
|
Chris@0
|
40 *
|
Chris@17
|
41 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
42 * @param int $stackPtr The position of the current token in the
|
Chris@17
|
43 * stack passed in $tokens.
|
Chris@0
|
44 *
|
Chris@0
|
45 * @return void
|
Chris@0
|
46 */
|
Chris@17
|
47 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
48 {
|
Chris@0
|
49
|
Chris@0
|
50 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
51
|
Chris@0
|
52 $nextNonWhiteSpace = $phpcsFile->findNext(
|
Chris@0
|
53 T_WHITESPACE,
|
Chris@0
|
54 ($stackPtr + 1),
|
Chris@0
|
55 null,
|
Chris@0
|
56 true,
|
Chris@0
|
57 null,
|
Chris@0
|
58 true
|
Chris@0
|
59 );
|
Chris@0
|
60
|
Chris@0
|
61 if ($tokens[$nextNonWhiteSpace]['code'] === T_IF) {
|
Chris@17
|
62 $fix = $phpcsFile->addFixableError('Use "elseif" in place of "else if"', $nextNonWhiteSpace, 'ElseIfDeclaration');
|
Chris@0
|
63 if ($fix === true) {
|
Chris@0
|
64 $phpcsFile->fixer->beginChangeset();
|
Chris@0
|
65 $phpcsFile->fixer->replaceToken($stackPtr, 'elseif');
|
Chris@0
|
66 for ($i = ($stackPtr + 1); $i < $nextNonWhiteSpace; $i++) {
|
Chris@0
|
67 if ($tokens[$i]['code'] === T_WHITESPACE) {
|
Chris@0
|
68 $phpcsFile->fixer->replaceToken($i, '');
|
Chris@0
|
69 }
|
Chris@0
|
70 }
|
Chris@0
|
71
|
Chris@0
|
72 $phpcsFile->fixer->replaceToken($nextNonWhiteSpace, '');
|
Chris@0
|
73 $phpcsFile->fixer->endChangeset();
|
Chris@0
|
74 }
|
Chris@0
|
75 }
|
Chris@0
|
76
|
Chris@0
|
77 }//end process()
|
Chris@0
|
78
|
Chris@0
|
79
|
Chris@0
|
80 }//end class
|