public function ConstantNameSniff::processFunctionCall in Coder 8.3.x

Same name and namespace in other branches

1. 8.3 coder_sniffer/Drupal/Sniffs/Semantics/ConstantNameSniff.php \Drupal\Sniffs\Semantics\ConstantNameSniff::processFunctionCall()
2. 8.2 coder_sniffer/Drupal/Sniffs/Semantics/ConstantNameSniff.php \Drupal\Sniffs\Semantics\ConstantNameSniff::processFunctionCall()

Processes this function call.

Parameters

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

int $stackPtr The position of the function call in: the stack.

int $openBracket The position of the opening: parenthesis in the stack.

int $closeBracket The position of the closing: parenthesis in the stack.

Return value

void

File

coder_sniffer/Drupal/Sniffs/Semantics/ConstantNameSniff.php, line 51

Class

ConstantNameSniff

Checks that constants introduced with define() in module or install files start with the module's name.

Namespace

Drupal\Sniffs\Semantics

Code

public function processFunctionCall(File $phpcsFile, $stackPtr, $openBracket, $closeBracket) {
  $nameParts = explode('.', basename($phpcsFile
    ->getFilename()));
  $fileExtension = end($nameParts);

  // Only check in *.module files.
  if ($fileExtension !== 'module' && $fileExtension !== 'install') {
    return;
  }
  $tokens = $phpcsFile
    ->getTokens();
  $argument = $this
    ->getArgument(1);
  if ($tokens[$argument['start']]['code'] !== T_CONSTANT_ENCAPSED_STRING) {

    // Not a string literal, so this is some obscure constant that we ignore.
    return;
  }
  $moduleName = reset($nameParts);
  $expectedStart = strtoupper($moduleName);

  // Remove the quotes around the string litral.
  $constant = substr($tokens[$argument['start']]['content'], 1, -1);
  if (strpos($constant, $expectedStart) !== 0) {
    $warning = 'All constants defined by a module must be prefixed with the module\'s name, expected "%s" but found "%s"';
    $data = [
      $expectedStart . "_{$constant}",
      $constant,
    ];
    $phpcsFile
      ->addWarning($warning, $stackPtr, 'ConstantStart', $data);
  }
}