class GlobalDefineSniff in Coder 8.3.x

Checks that global define() constants are not used in modules in Drupal 8.

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

• class \Drupal\Sniffs\Semantics\FunctionCall implements \PHP_CodeSniffer\Sniffs\Sniff
  • class \DrupalPractice\Sniffs\Constants\GlobalDefineSniff

File

coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalDefineSniff.php, line 23

Namespace

DrupalPractice\Sniffs\Constants

class GlobalDefineSniff extends FunctionCall {

  /**
   * Returns an array of function names this test wants to listen for.
   *
   * @return array<string>
   */
  public function registerFunctionNames() {
    return [
      'define',
    ];
  }

  //end registerFunctionNames()

  /**
   * Processes this function call.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile    The file being scanned.
   * @param int                         $stackPtr     The position of the function call in
   *                                                  the stack.
   * @param int                         $openBracket  The position of the opening
   *                                                  parenthesis in the stack.
   * @param int                         $closeBracket The position of the closing
   *                                                  parenthesis in the stack.
   *
   * @return void|int
   */
  public function processFunctionCall(File $phpcsFile, $stackPtr, $openBracket, $closeBracket) {
    $tokens = $phpcsFile
      ->getTokens();

    // Only check constants in the global scope in module files.
    if (empty($tokens[$stackPtr]['conditions']) === false || substr($phpcsFile
      ->getFilename(), -7) !== '.module') {
      return;
    }
    $coreVersion = Project::getCoreVersion($phpcsFile);
    if ($coreVersion < 8) {

      // No need to check this file again, mark it as done.
      return $phpcsFile->numTokens + 1;
    }

    // Allow constants if they are deprecated.
    $commentEnd = $phpcsFile
      ->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
    if ($commentEnd !== null && $tokens[$commentEnd]['code'] === T_DOC_COMMENT_CLOSE_TAG) {

      // Go through all comment tags and check if one is @deprecated.
      $commentTag = $commentEnd;
      while ($commentTag !== null && $commentTag > $tokens[$commentEnd]['comment_opener']) {
        if ($tokens[$commentTag]['content'] === '@deprecated') {
          return;
        }
        $commentTag = $phpcsFile
          ->findPrevious(T_DOC_COMMENT_TAG, $commentTag - 1, $tokens[$commentEnd]['comment_opener']);
      }
    }
    $warning = 'Global constants should not be used, move it to a class or interface';
    $phpcsFile
      ->addWarning($warning, $stackPtr, 'GlobalConstant');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FunctionCall::$arguments	protected	property	Internal cache to save the calculated arguments of the function call.
FunctionCall::$closeBracket	protected	property	The token position of the closing bracket of the function call.
FunctionCall::$functionCall	protected	property	The token position of the function call.
FunctionCall::$includeMethodCalls	protected	property	Whether method invocations with the same function name should be processed, too.	1
FunctionCall::$openBracket	protected	property	The token position of the opening bracket of the function call.
FunctionCall::$phpcsFile	protected	property	The currently processed file.
FunctionCall::getArgument	public	function	Returns start and end token for a given argument number.
FunctionCall::isFunctionCall	protected	function	Checks if this is a function call.
FunctionCall::process	public	function	Processes this test, when one of its tokens is encountered.	2
FunctionCall::register	public	function	Returns an array of tokens this test wants to listen for.
GlobalDefineSniff::processFunctionCall	public	function	Processes this function call.
GlobalDefineSniff::registerFunctionNames	public	function	Returns an array of function names this test wants to listen for.