public function VariableNameSniff::processFunctionCall in Coder 8.2

Same name and namespace in other branches

1. 8.3 coder_sniffer/DrupalPractice/Sniffs/General/VariableNameSniff.php \DrupalPractice\Sniffs\General\VariableNameSniff::processFunctionCall()
2. 8.3.x coder_sniffer/DrupalPractice/Sniffs/General/VariableNameSniff.php \DrupalPractice\Sniffs\General\VariableNameSniff::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/DrupalPractice/Sniffs/General/VariableNameSniff.php, line 53

Class

VariableNameSniff

Checks the usage of variable_get() in forms and the variable name.

Namespace

DrupalPractice\Sniffs\General

Code

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

  // We assume that the sequence '#default_value' => variable_get(...)
  // indicates a variable that the module owns.
  $arrow = $phpcsFile
    ->findPrevious(Tokens::$emptyTokens, $stackPtr - 1, null, true);
  if ($arrow === false || $tokens[$arrow]['code'] !== T_DOUBLE_ARROW) {
    return;
  }
  $arrayKey = $phpcsFile
    ->findPrevious(Tokens::$emptyTokens, $arrow - 1, null, true);
  if ($arrayKey === false || $tokens[$arrayKey]['code'] !== T_CONSTANT_ENCAPSED_STRING || substr($tokens[$arrayKey]['content'], 1, -1) !== '#default_value') {
    return;
  }
  $argument = $this
    ->getArgument(1);

  // Variable name is not a literal string, so we return early.
  if ($argument === false || $tokens[$argument['start']]['code'] !== T_CONSTANT_ENCAPSED_STRING) {
    return;
  }
  $moduleName = Project::getName($phpcsFile);
  if ($moduleName === false) {
    return;
  }
  $variableName = substr($tokens[$argument['start']]['content'], 1, -1);
  if (strpos($variableName, $moduleName) !== 0) {
    $warning = 'All variables defined by your module must be prefixed with your module\'s name to avoid name collisions with others. Expected start with "%s" but found "%s"';
    $data = array(
      $moduleName,
      $variableName,
    );
    $phpcsFile
      ->addWarning($warning, $argument['start'], 'VariableName', $data);
  }
}