Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \Drupal\Sniffs\InfoFiles\RequiredSniff.
|
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\InfoFiles;
|
Chris@17
|
11
|
Chris@17
|
12 use Drupal\Sniffs\InfoFiles\ClassFilesSniff;
|
Chris@17
|
13 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
14 use PHP_CodeSniffer\Sniffs\Sniff;
|
Chris@17
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * "name", "description" and "core are required fields in Drupal info files. Also
|
Chris@0
|
18 * checks the "php" minimum requirement for Drupal 7.
|
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 RequiredSniff implements Sniff
|
Chris@0
|
25 {
|
Chris@0
|
26
|
Chris@0
|
27
|
Chris@0
|
28 /**
|
Chris@0
|
29 * Returns an array of tokens this test wants to listen for.
|
Chris@0
|
30 *
|
Chris@0
|
31 * @return array
|
Chris@0
|
32 */
|
Chris@0
|
33 public function register()
|
Chris@0
|
34 {
|
Chris@0
|
35 return array(T_INLINE_HTML);
|
Chris@0
|
36
|
Chris@0
|
37 }//end register()
|
Chris@0
|
38
|
Chris@0
|
39
|
Chris@0
|
40 /**
|
Chris@0
|
41 * Processes this test, when one of its tokens is encountered.
|
Chris@0
|
42 *
|
Chris@17
|
43 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
44 * @param int $stackPtr The position of the current token in the
|
Chris@17
|
45 * stack passed in $tokens.
|
Chris@0
|
46 *
|
Chris@0
|
47 * @return int
|
Chris@0
|
48 */
|
Chris@17
|
49 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
50 {
|
Chris@0
|
51 // Only run this sniff once per info file.
|
Chris@0
|
52 $fileExtension = strtolower(substr($phpcsFile->getFilename(), -4));
|
Chris@0
|
53 if ($fileExtension !== 'info') {
|
Chris@0
|
54 return ($phpcsFile->numTokens + 1);
|
Chris@0
|
55 }
|
Chris@0
|
56
|
Chris@0
|
57 $contents = file_get_contents($phpcsFile->getFilename());
|
Chris@17
|
58 $info = ClassFilesSniff::drupalParseInfoFormat($contents);
|
Chris@0
|
59 if (isset($info['name']) === false) {
|
Chris@0
|
60 $error = '"name" property is missing in the info file';
|
Chris@0
|
61 $phpcsFile->addError($error, $stackPtr, 'Name');
|
Chris@0
|
62 }
|
Chris@0
|
63
|
Chris@0
|
64 if (isset($info['description']) === false) {
|
Chris@0
|
65 $error = '"description" property is missing in the info file';
|
Chris@0
|
66 $phpcsFile->addError($error, $stackPtr, 'Description');
|
Chris@0
|
67 }
|
Chris@0
|
68
|
Chris@0
|
69 if (isset($info['core']) === false) {
|
Chris@0
|
70 $error = '"core" property is missing in the info file';
|
Chris@0
|
71 $phpcsFile->addError($error, $stackPtr, 'Core');
|
Chris@0
|
72 } else if ($info['core'] === '7.x' && isset($info['php']) === true
|
Chris@0
|
73 && $info['php'] <= '5.2'
|
Chris@0
|
74 ) {
|
Chris@0
|
75 $error = 'Drupal 7 core already requires PHP 5.2';
|
Chris@17
|
76 $ptr = ClassFilesSniff::getPtr('php', $info['php'], $phpcsFile);
|
Chris@0
|
77 $phpcsFile->addError($error, $ptr, 'D7PHPVersion');
|
Chris@0
|
78 }
|
Chris@0
|
79
|
Chris@0
|
80 return ($phpcsFile->numTokens + 1);
|
Chris@0
|
81
|
Chris@0
|
82 }//end process()
|
Chris@0
|
83
|
Chris@0
|
84
|
Chris@0
|
85 }//end class
|