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:  * "version", "project" and "timestamp" are added automatically by drupal.org
Chris@0:  * packaging scripts.
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 AutoAddedKeysSniff 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:         if (preg_match('/\.info$/', $phpcsFile->getFilename()) === 1) {
Chris@0:             // Drupal 7 style info file.
Chris@0:             $contents = file_get_contents($phpcsFile->getFilename());
Chris@17:             $info     = ClassFilesSniff::drupalParseInfoFormat($contents);
Chris@0:         } else if (preg_match('/\.info\.yml$/', $phpcsFile->getFilename()) === 1) {
Chris@0:             // Drupal 8 style info.yml file.
Chris@0:             $contents = file_get_contents($phpcsFile->getFilename());
Chris@0:             try {
Chris@0:                 $info = \Symfony\Component\Yaml\Yaml::parse($contents);
Chris@0:             } catch (\Symfony\Component\Yaml\Exception\ParseException $e) {
Chris@0:                 // If the YAML is invalid we ignore this file.
Chris@0:                 return ($phpcsFile->numTokens + 1);
Chris@0:             }
Chris@0:         } else {
Chris@0:             return ($phpcsFile->numTokens + 1);
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($info['project']) === true) {
Chris@0:             $warning = 'Remove "project" from the info file, it will be added by drupal.org packaging automatically';
Chris@0:             $phpcsFile->addWarning($warning, $stackPtr, 'Project');
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($info['timestamp']) === true) {
Chris@0:             $warning = 'Remove "timestamp" from the info file, it will be added by drupal.org packaging automatically';
Chris@0:             $phpcsFile->addWarning($warning, $stackPtr, 'Timestamp');
Chris@0:         }
Chris@0: 
Chris@0:         // "version" is special: we want to allow it in core, but not anywhere else.
Chris@0:         if (isset($info['version']) === true && strpos($phpcsFile->getFilename(), '/core/') === false) {
Chris@0:             $warning = 'Remove "version" from the info file, it will be added by drupal.org packaging automatically';
Chris@0:             $phpcsFile->addWarning($warning, $stackPtr, 'Version');
Chris@0:         }
Chris@0: 
Chris@0:         return ($phpcsFile->numTokens + 1);
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class