annotate vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalDefineSniff.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 * \DrupalPractice\Sniffs\Constants\GlobalDefineSniff
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 DrupalPractice\Sniffs\Constants;
Chris@17 11
Chris@17 12 use PHP_CodeSniffer\Files\File;
Chris@17 13 use Drupal\Sniffs\Semantics\FunctionCall;
Chris@17 14 use DrupalPractice\Project;
Chris@17 15
Chris@0 16 /**
Chris@0 17 * Checks that global define() constants are not used in modules in Drupal 8.
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 GlobalDefineSniff extends FunctionCall
Chris@0 24 {
Chris@0 25
Chris@0 26
Chris@0 27 /**
Chris@0 28 * Returns an array of function names this test wants to listen for.
Chris@0 29 *
Chris@0 30 * @return array
Chris@0 31 */
Chris@0 32 public function registerFunctionNames()
Chris@0 33 {
Chris@0 34 return array('define');
Chris@0 35
Chris@0 36 }//end registerFunctionNames()
Chris@0 37
Chris@0 38
Chris@0 39 /**
Chris@0 40 * Processes this function call.
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 function call in
Chris@17 44 * the stack.
Chris@17 45 * @param int $openBracket The position of the opening
Chris@17 46 * parenthesis in the stack.
Chris@17 47 * @param int $closeBracket The position of the closing
Chris@17 48 * parenthesis in the stack.
Chris@0 49 *
Chris@0 50 * @return void
Chris@0 51 */
Chris@0 52 public function processFunctionCall(
Chris@17 53 File $phpcsFile,
Chris@0 54 $stackPtr,
Chris@0 55 $openBracket,
Chris@0 56 $closeBracket
Chris@0 57 ) {
Chris@0 58 $tokens = $phpcsFile->getTokens();
Chris@0 59
Chris@0 60 // Only check constants in the global scope in module files.
Chris@0 61 if (empty($tokens[$stackPtr]['conditions']) === false || substr($phpcsFile->getFilename(), -7) !== '.module') {
Chris@0 62 return;
Chris@0 63 }
Chris@0 64
Chris@17 65 $coreVersion = Project::getCoreVersion($phpcsFile);
Chris@0 66 if ($coreVersion !== '8.x') {
Chris@0 67 return;
Chris@0 68 }
Chris@0 69
Chris@0 70 // Allow constants if they are deprecated.
Chris@0 71 $commentEnd = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
Chris@0 72 if ($commentEnd !== null && $tokens[$commentEnd]['code'] === T_DOC_COMMENT_CLOSE_TAG) {
Chris@0 73 // Go through all comment tags and check if one is @deprecated.
Chris@0 74 $commentTag = $commentEnd;
Chris@0 75 while ($commentTag !== null && $commentTag > $tokens[$commentEnd]['comment_opener']) {
Chris@0 76 if ($tokens[$commentTag]['content'] === '@deprecated') {
Chris@0 77 return;
Chris@0 78 }
Chris@0 79
Chris@0 80 $commentTag = $phpcsFile->findPrevious(T_DOC_COMMENT_TAG, ($commentTag - 1), $tokens[$commentEnd]['comment_opener']);
Chris@0 81 }
Chris@0 82 }
Chris@0 83
Chris@0 84 $warning = 'Global constants should not be used, move it to a class or interface';
Chris@0 85 $phpcsFile->addWarning($warning, $stackPtr, 'GlobalConstant');
Chris@0 86
Chris@0 87 }//end processFunctionCall()
Chris@0 88
Chris@0 89
Chris@0 90 }//end class