Chris@0: <?php
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\Constants\GlobalConstantSniff
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 DrupalPractice\Sniffs\Constants;
Chris@17: 
Chris@17: use DrupalPractice\Project;
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@0:  * Checks that globally defined constants are not used in Drupal 8 and higher.
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 GlobalConstantSniff 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_CONST);
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 current file being processed.
Chris@17:      * @param int                         $stackPtr  The position of the current token
Chris@17:      *                                               in the stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         // Only check constants in the global scope.
Chris@0:         if (empty($tokens[$stackPtr]['conditions']) === false) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@17:         $coreVersion = Project::getCoreVersion($phpcsFile);
Chris@0:         if ($coreVersion !== '8.x') {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         // Allow constants if they are deprecated.
Chris@0:         $commentEnd = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
Chris@0:         if ($commentEnd !== null && $tokens[$commentEnd]['code'] === T_DOC_COMMENT_CLOSE_TAG) {
Chris@0:             // Go through all comment tags and check if one is @deprecated.
Chris@0:             $commentTag = $commentEnd;
Chris@0:             while ($commentTag !== null && $commentTag > $tokens[$commentEnd]['comment_opener']) {
Chris@0:                 if ($tokens[$commentTag]['content'] === '@deprecated') {
Chris@0:                     return;
Chris@0:                 }
Chris@0: 
Chris@0:                 $commentTag = $phpcsFile->findPrevious(T_DOC_COMMENT_TAG, ($commentTag - 1), $tokens[$commentEnd]['comment_opener']);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $warning = 'Global constants should not be used, move it to a class or interface';
Chris@0:         $phpcsFile->addWarning($warning, $stackPtr, 'GlobalConstant');
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class