Mercurial > hg > isophonics-drupal-site
view vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/InfoFiles/RequiredSniff.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | 129ea1e6d783 |
children |
line wrap: on
line source
<?php /** * \Drupal\Sniffs\InfoFiles\RequiredSniff. * * @category PHP * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ namespace Drupal\Sniffs\InfoFiles; use Drupal\Sniffs\InfoFiles\ClassFilesSniff; use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Sniffs\Sniff; /** * "name", "description" and "core are required fields in Drupal info files. Also * checks the "php" minimum requirement for Drupal 7. * * @category PHP * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ class RequiredSniff implements Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_INLINE_HTML); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return int */ public function process(File $phpcsFile, $stackPtr) { // Only run this sniff once per info file. $fileExtension = strtolower(substr($phpcsFile->getFilename(), -4)); if ($fileExtension !== 'info') { return ($phpcsFile->numTokens + 1); } $contents = file_get_contents($phpcsFile->getFilename()); $info = ClassFilesSniff::drupalParseInfoFormat($contents); if (isset($info['name']) === false) { $error = '"name" property is missing in the info file'; $phpcsFile->addError($error, $stackPtr, 'Name'); } if (isset($info['description']) === false) { $error = '"description" property is missing in the info file'; $phpcsFile->addError($error, $stackPtr, 'Description'); } if (isset($info['core']) === false) { $error = '"core" property is missing in the info file'; $phpcsFile->addError($error, $stackPtr, 'Core'); } else if ($info['core'] === '7.x' && isset($info['php']) === true && $info['php'] <= '5.2' ) { $error = 'Drupal 7 core already requires PHP 5.2'; $ptr = ClassFilesSniff::getPtr('php', $info['php'], $phpcsFile); $phpcsFile->addError($error, $ptr, 'D7PHPVersion'); } return ($phpcsFile->numTokens + 1); }//end process() }//end class