Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \Drupal\Sniffs\Classes\UseLeadingBackslashSniff.
|
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\Classes;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use PHP_CodeSniffer\Sniffs\Sniff;
|
Chris@17
|
14 use PHP_CodeSniffer\Util\Tokens;
|
Chris@17
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * Use statements to import classes must not begin with "\".
|
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 UseLeadingBackslashSniff implements Sniff
|
Chris@0
|
24 {
|
Chris@0
|
25
|
Chris@0
|
26
|
Chris@0
|
27 /**
|
Chris@0
|
28 * Returns an array of tokens this test wants to listen for.
|
Chris@0
|
29 *
|
Chris@0
|
30 * @return array
|
Chris@0
|
31 */
|
Chris@0
|
32 public function register()
|
Chris@0
|
33 {
|
Chris@0
|
34 return array(T_USE);
|
Chris@0
|
35
|
Chris@0
|
36 }//end register()
|
Chris@0
|
37
|
Chris@0
|
38
|
Chris@0
|
39 /**
|
Chris@0
|
40 * Processes this test, when one of its tokens is encountered.
|
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 current token in
|
Chris@17
|
44 * the stack passed in $tokens.
|
Chris@0
|
45 *
|
Chris@0
|
46 * @return void
|
Chris@0
|
47 */
|
Chris@17
|
48 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
49 {
|
Chris@0
|
50 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
51
|
Chris@0
|
52 // Only check use statements in the global scope.
|
Chris@0
|
53 if (empty($tokens[$stackPtr]['conditions']) === false) {
|
Chris@0
|
54 return;
|
Chris@0
|
55 }
|
Chris@0
|
56
|
Chris@0
|
57 $startPtr = $phpcsFile->findNext(
|
Chris@17
|
58 Tokens::$emptyTokens,
|
Chris@0
|
59 ($stackPtr + 1),
|
Chris@0
|
60 null,
|
Chris@0
|
61 true
|
Chris@0
|
62 );
|
Chris@0
|
63
|
Chris@0
|
64 if ($startPtr !== null && $tokens[$startPtr]['code'] === T_NS_SEPARATOR) {
|
Chris@0
|
65 $error = 'When importing a class with "use", do not include a leading \\';
|
Chris@0
|
66 $fix = $phpcsFile->addFixableError($error, $startPtr, 'SeparatorStart');
|
Chris@0
|
67 if ($fix === true) {
|
Chris@0
|
68 $phpcsFile->fixer->replaceToken($startPtr, '');
|
Chris@0
|
69 }
|
Chris@0
|
70 }
|
Chris@0
|
71
|
Chris@0
|
72 }//end process()
|
Chris@0
|
73
|
Chris@0
|
74
|
Chris@0
|
75 }//end class
|