public function GlobalFunctionSniff::process in Coder 8.2

Same name and namespace in other branches

1. 8.3 coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalFunctionSniff.php \DrupalPractice\Sniffs\Objects\GlobalFunctionSniff::process()
2. 8.3.x coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalFunctionSniff.php \DrupalPractice\Sniffs\Objects\GlobalFunctionSniff::process()

Processes this test, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the current token: in the stack passed in $tokens.

Return value

void

File

coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalFunctionSniff.php, line 70

Class

GlobalFunctionSniff

Checks that global functions like t() are not used in forms or controllers.

Namespace

DrupalPractice\Sniffs\Objects

Code

public function process(File $phpcsFile, $stackPtr) {
  $tokens = $phpcsFile
    ->getTokens();

  // We are only interested in function calls, which are not in the global
  // scope.
  if (isset($this->functions[$tokens[$stackPtr]['content']]) === false || isset($tokens[$stackPtr + 1]) === false || $tokens[$stackPtr + 1]['code'] !== T_OPEN_PARENTHESIS || empty($tokens[$stackPtr]['conditions']) === true) {
    return;
  }

  // If there is an object operator before the call then this is a method
  // invocation, not a function call.
  $previous = $phpcsFile
    ->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
  if ($tokens[$previous]['code'] === T_OBJECT_OPERATOR) {
    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, GlobalDrupalSniff::$baseClasses) === false) && Project::isServiceClass($phpcsFile, $classPtr) === false) {
    return;
  }
  $warning = '%s() calls should be avoided in classes, use dependency injection and %s instead';
  $data = array(
    $tokens[$stackPtr]['content'],
    $this->functions[$tokens[$stackPtr]['content']],
  );
  $phpcsFile
    ->addWarning($warning, $stackPtr, 'GlobalFunction', $data);
}