GlobalConstantSniff.php in Coder 8.2

Namespace

DrupalPractice\Sniffs\Constants

File

coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalConstantSniff.php

<?php

/**
 * \DrupalPractice\Sniffs\Constants\GlobalConstantSniff
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
namespace DrupalPractice\Sniffs\Constants;

use DrupalPractice\Project;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

/**
 * Checks that globally defined constants are not used in Drupal 8 and higher.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class GlobalConstantSniff implements Sniff {

  /**
   * Returns an array of tokens this test wants to listen for.
   *
   * @return array
   */
  public function register() {
    return array(
      T_CONST,
    );
  }

  //end register()

  /**
   * Processes this test, when one of its tokens is encountered.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being processed.
   * @param int                         $stackPtr  The position of the current token
   *                                               in the stack passed in $tokens.
   *
   * @return void
   */
  public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile
      ->getTokens();

    // Only check constants in the global scope.
    if (empty($tokens[$stackPtr]['conditions']) === false) {
      return;
    }
    $coreVersion = Project::getCoreVersion($phpcsFile);
    if ($coreVersion !== '8.x') {
      return;
    }

    // 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');
  }

}

//end class

Classes

Name	Description
GlobalConstantSniff	Checks that globally defined constants are not used in Drupal 8 and higher.