public function Drupal_Sniffs_Semantics_ConstantNameSniff::processFunctionCall in Coder 7.2

Processes this function call.

Parameters

PHP_CodeSniffer_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.

Drupal_Sniffs_Semantics_FunctionCallSniff $sniff: Can be used to retreive the function's arguments with the getArgument() method.

Return value

void

Overrides Drupal_Sniffs_Semantics_FunctionCall::processFunctionCall

File

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

Class

Drupal_Sniffs_Semantics_ConstantNameSniff

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

Code

public function processFunctionCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $closeBracket, Drupal_Sniffs_Semantics_FunctionCallSniff $sniff) {
  $fileExtension = strtolower(substr($phpcsFile
    ->getFilename(), -6));

  // Only check in *.module files.
  if ($fileExtension !== 'module') {
    return;
  }
  $tokens = $phpcsFile
    ->getTokens();
  $argument = $sniff
    ->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 = substr(basename($phpcsFile
    ->getFilename()), 0, -7);
  $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 = array(
      $expectedStart . "_{$constant}",
      $constant,
    );
    $phpcsFile
      ->addWarning($warning, $stackPtr, 'ConstantStart', $data);
  }
}