Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\InfoFiles\RequiredSniff.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@17: namespace Drupal\Sniffs\InfoFiles;
Chris@17: 
Chris@17: use Drupal\Sniffs\InfoFiles\ClassFilesSniff;
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@0:  * "name", "description" and "core are required fields in Drupal info files. Also
Chris@0:  * checks the "php" minimum requirement for Drupal 7.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@17: class RequiredSniff implements Sniff
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array of tokens this test wants to listen for.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function register()
Chris@0:     {
Chris@0:         return array(T_INLINE_HTML);
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this test, when one of its tokens is encountered.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17:      * @param int                         $stackPtr  The position of the current token in the
Chris@17:      *                                               stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return int
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         // Only run this sniff once per info file.
Chris@0:         $fileExtension = strtolower(substr($phpcsFile->getFilename(), -4));
Chris@0:         if ($fileExtension !== 'info') {
Chris@0:             return ($phpcsFile->numTokens + 1);
Chris@0:         }
Chris@0: 
Chris@0:         $contents = file_get_contents($phpcsFile->getFilename());
Chris@17:         $info     = ClassFilesSniff::drupalParseInfoFormat($contents);
Chris@0:         if (isset($info['name']) === false) {
Chris@0:             $error = '"name" property is missing in the info file';
Chris@0:             $phpcsFile->addError($error, $stackPtr, 'Name');
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($info['description']) === false) {
Chris@0:             $error = '"description" property is missing in the info file';
Chris@0:             $phpcsFile->addError($error, $stackPtr, 'Description');
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($info['core']) === false) {
Chris@0:             $error = '"core" property is missing in the info file';
Chris@0:             $phpcsFile->addError($error, $stackPtr, 'Core');
Chris@0:         } else if ($info['core'] === '7.x' && isset($info['php']) === true
Chris@0:             && $info['php'] <= '5.2'
Chris@0:         ) {
Chris@0:             $error = 'Drupal 7 core already requires PHP 5.2';
Chris@17:             $ptr   = ClassFilesSniff::getPtr('php', $info['php'], $phpcsFile);
Chris@0:             $phpcsFile->addError($error, $ptr, 'D7PHPVersion');
Chris@0:         }
Chris@0: 
Chris@0:         return ($phpcsFile->numTokens + 1);
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class