annotate vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/InfoFiles/ClassFilesSniff.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2 /**
Chris@17 3 * \Drupal\Sniffs\InfoFiles\ClassFilesSniff.
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 PHP_CodeSniffer\Files\File;
Chris@17 13 use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17 14
Chris@0 15 /**
Chris@0 16 * Checks files[] entries in info files. Only files containing classes/interfaces
Chris@0 17 * should be listed.
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 ClassFilesSniff 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_INLINE_HTML);
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 the
Chris@17 44 * stack passed in $tokens.
Chris@0 45 *
Chris@0 46 * @return int
Chris@0 47 */
Chris@17 48 public function process(File $phpcsFile, $stackPtr)
Chris@0 49 {
Chris@0 50 // Only run this sniff once per info file.
Chris@0 51 $fileExtension = strtolower(substr($phpcsFile->getFilename(), -4));
Chris@0 52 if ($fileExtension !== 'info') {
Chris@0 53 return ($phpcsFile->numTokens + 1);
Chris@0 54 }
Chris@0 55
Chris@0 56 $contents = file_get_contents($phpcsFile->getFilename());
Chris@0 57 $info = self::drupalParseInfoFormat($contents);
Chris@0 58 if (isset($info['files']) === true && is_array($info['files']) === true) {
Chris@0 59 foreach ($info['files'] as $file) {
Chris@0 60 $fileName = dirname($phpcsFile->getFilename()).'/'.$file;
Chris@0 61 if (file_exists($fileName) === false) {
Chris@0 62 // We need to find the position of the offending line in the
Chris@0 63 // info file.
Chris@0 64 $ptr = self::getPtr('files[]', $file, $phpcsFile);
Chris@0 65 $error = 'Declared file was not found';
Chris@0 66 $phpcsFile->addError($error, $ptr, 'DeclaredFileNotFound');
Chris@0 67 continue;
Chris@0 68 }
Chris@0 69
Chris@0 70 // Read the file, parse its tokens and check if it actually contains
Chris@0 71 // a class or interface definition.
Chris@0 72 $searchTokens = token_get_all(file_get_contents($fileName));
Chris@0 73 foreach ($searchTokens as $token) {
Chris@0 74 if (is_array($token) === true
Chris@0 75 && in_array($token[0], array(T_CLASS, T_INTERFACE, T_TRAIT)) === true
Chris@0 76 ) {
Chris@0 77 continue 2;
Chris@0 78 }
Chris@0 79 }
Chris@0 80
Chris@0 81 $ptr = self::getPtr('files[]', $file, $phpcsFile);
Chris@0 82 $error = "It's only necessary to declare files[] if they declare a class or interface.";
Chris@0 83 $phpcsFile->addError($error, $ptr, 'UnecessaryFileDeclaration');
Chris@0 84 }//end foreach
Chris@0 85 }//end if
Chris@0 86
Chris@0 87 return ($phpcsFile->numTokens + 1);
Chris@0 88
Chris@0 89 }//end process()
Chris@0 90
Chris@0 91
Chris@0 92 /**
Chris@0 93 * Helper function that returns the position of the key in the info file.
Chris@0 94 *
Chris@17 95 * @param string $key Key name to search for.
Chris@17 96 * @param string $value Corresponding value to search for.
Chris@17 97 * @param \PHP_CodeSniffer\Files\File $infoFile Info file to search in.
Chris@0 98 *
Chris@0 99 * @return int|false Returns the stack position if the file name is found, false
Chris@0 100 * otherwise.
Chris@0 101 */
Chris@17 102 public static function getPtr($key, $value, File $infoFile)
Chris@0 103 {
Chris@0 104 foreach ($infoFile->getTokens() as $ptr => $tokenInfo) {
Chris@0 105 if (preg_match('@^[\s]*'.preg_quote($key).'[\s]*=[\s]*["\']?'.preg_quote($value).'["\']?@', $tokenInfo['content']) === 1) {
Chris@0 106 return $ptr;
Chris@0 107 }
Chris@0 108 }
Chris@0 109
Chris@0 110 return false;
Chris@0 111
Chris@0 112 }//end getPtr()
Chris@0 113
Chris@0 114
Chris@0 115 /**
Chris@0 116 * Parses a Drupal info file. Copied from Drupal core drupal_parse_info_format().
Chris@0 117 *
Chris@0 118 * @param string $data The contents of the info file to parse
Chris@0 119 *
Chris@0 120 * @return array The info array.
Chris@0 121 */
Chris@0 122 public static function drupalParseInfoFormat($data)
Chris@0 123 {
Chris@0 124 $info = array();
Chris@0 125 $constants = get_defined_constants();
Chris@0 126
Chris@0 127 if (preg_match_all(
Chris@0 128 '
Chris@0 129 @^\s* # Start at the beginning of a line, ignoring leading whitespace
Chris@0 130 ((?:
Chris@0 131 [^=;\[\]]| # Key names cannot contain equal signs, semi-colons or square brackets,
Chris@0 132 \[[^\[\]]*\] # unless they are balanced and not nested
Chris@0 133 )+?)
Chris@0 134 \s*=\s* # Key/value pairs are separated by equal signs (ignoring white-space)
Chris@0 135 (?:
Chris@0 136 ("(?:[^"]|(?<=\\\\)")*")| # Double-quoted string, which may contain slash-escaped quotes/slashes
Chris@0 137 (\'(?:[^\']|(?<=\\\\)\')*\')| # Single-quoted string, which may contain slash-escaped quotes/slashes
Chris@0 138 ([^\r\n]*?) # Non-quoted string
Chris@0 139 )\s*$ # Stop at the next end of a line, ignoring trailing whitespace
Chris@0 140 @msx',
Chris@0 141 $data,
Chris@0 142 $matches,
Chris@0 143 PREG_SET_ORDER
Chris@0 144 ) !== false
Chris@0 145 ) {
Chris@0 146 foreach ($matches as $match) {
Chris@0 147 // Fetch the key and value string.
Chris@0 148 $i = 0;
Chris@0 149 foreach (array('key', 'value1', 'value2', 'value3') as $var) {
Chris@0 150 if (isset($match[++$i]) === true) {
Chris@0 151 $$var = $match[$i];
Chris@0 152 } else {
Chris@0 153 $$var = '';
Chris@0 154 }
Chris@0 155 }
Chris@0 156
Chris@0 157 $value = stripslashes(substr($value1, 1, -1)).stripslashes(substr($value2, 1, -1)).$value3;
Chris@0 158
Chris@0 159 // Parse array syntax.
Chris@0 160 $keys = preg_split('/\]?\[/', rtrim($key, ']'));
Chris@0 161 $last = array_pop($keys);
Chris@0 162 $parent = &$info;
Chris@0 163
Chris@0 164 // Create nested arrays.
Chris@0 165 foreach ($keys as $key) {
Chris@0 166 if ($key === '') {
Chris@0 167 $key = count($parent);
Chris@0 168 }
Chris@0 169
Chris@0 170 if (isset($parent[$key]) === false || is_array($parent[$key]) === false) {
Chris@0 171 $parent[$key] = array();
Chris@0 172 }
Chris@0 173
Chris@0 174 $parent = &$parent[$key];
Chris@0 175 }
Chris@0 176
Chris@0 177 // Handle PHP constants.
Chris@0 178 if (isset($constants[$value]) === true) {
Chris@0 179 $value = $constants[$value];
Chris@0 180 }
Chris@0 181
Chris@0 182 // Insert actual value.
Chris@0 183 if ($last === '') {
Chris@0 184 $last = count($parent);
Chris@0 185 }
Chris@0 186
Chris@0 187 $parent[$last] = $value;
Chris@0 188 }//end foreach
Chris@0 189 }//end if
Chris@0 190
Chris@0 191 return $info;
Chris@0 192
Chris@0 193 }//end drupalParseInfoFormat()
Chris@0 194
Chris@0 195
Chris@0 196 }//end class