GlobalDrupalSniff.php in Coder 8.2

Namespace

DrupalPractice\Sniffs\Objects

File

coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalDrupalSniff.php

<?php

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

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

/**
 * Checks that \Drupal::service() and friends is not used in forms, controllers, services.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class GlobalDrupalSniff implements Sniff {

  /**
   * List of base classes where \Drupal should not be used in an extending class.
   *
   * @var string[]
   */
  public static $baseClasses = array(
    'BlockBase',
    'ConfigFormBase',
    'ContentEntityForm',
    'ControllerBase',
    'EntityForm',
    'EntityReferenceFormatterBase',
    'FileFormatterBase',
    'FormatterBase',
    'FormBase',
    'ImageFormatter',
    'ImageFormatterBase',
    'WidgetBase',
  );

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

  //end register()

  /**
   * Processes this test, when one of its tokens is encountered.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
   * @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();

    // We are only interested in Drupal:: static method calls, not in the global
    // scope.
    if ($tokens[$stackPtr]['content'] !== 'Drupal' || $tokens[$stackPtr + 1]['code'] !== T_DOUBLE_COLON || isset($tokens[$stackPtr + 2]) === false || $tokens[$stackPtr + 2]['code'] !== T_STRING || isset($tokens[$stackPtr + 3]) === false || $tokens[$stackPtr + 3]['code'] !== T_OPEN_PARENTHESIS || empty($tokens[$stackPtr]['conditions']) === true) {
      return;
    }

    // Check that this statement is not in a static function.
    foreach ($tokens[$stackPtr]['conditions'] as $conditionPtr => $conditionCode) {
      if ($conditionCode === T_FUNCTION && $phpcsFile
        ->getMethodProperties($conditionPtr)['is_static'] === true) {
        return;
      }
    }

    // Check if the class extends another class and get the name of the class
    // that is extended.
    $classPtr = key($tokens[$stackPtr]['conditions']);
    $extendsName = $phpcsFile
      ->findExtendedClassName($classPtr);
    if (($extendsName === false || in_array($extendsName, static::$baseClasses) === false) && Project::isServiceClass($phpcsFile, $classPtr) === false) {
      return;
    }
    $warning = '\\Drupal calls should be avoided in classes, use dependency injection instead';
    $phpcsFile
      ->addWarning($warning, $stackPtr, 'GlobalDrupal');
  }

}

//end class

Classes

Name	Description
GlobalDrupalSniff	Checks that \Drupal::service() and friends is not used in forms, controllers, services.