public function OptionsTSniff::process in Coder 8.3.x

Same name and namespace in other branches

1. 8.3 coder_sniffer/DrupalPractice/Sniffs/General/OptionsTSniff.php \DrupalPractice\Sniffs\General\OptionsTSniff::process()
2. 8.2 coder_sniffer/DrupalPractice/Sniffs/General/OptionsTSniff.php \DrupalPractice\Sniffs\General\OptionsTSniff::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 function: name in the stack.

Return value

void

File

coder_sniffer/DrupalPractice/Sniffs/General/OptionsTSniff.php, line 47

Class

OptionsTSniff

Checks that values in #options form arrays are translated.

Namespace

DrupalPractice\Sniffs\General

Code

public function process(File $phpcsFile, $stackPtr) {

  // Look for the string "#options".
  $tokens = $phpcsFile
    ->getTokens();
  if ($tokens[$stackPtr]['content'] !== '"#options"' && $tokens[$stackPtr]['content'] !== "'#options'") {
    return;
  }

  // Look for an opening array pattern that starts to define #options
  // values.
  $statementEnd = $phpcsFile
    ->findNext(T_SEMICOLON, $stackPtr + 1);
  $arrayString = $phpcsFile
    ->getTokensAsString($stackPtr + 1, $statementEnd - $stackPtr);

  // Cut out all the white space.
  $arrayString = preg_replace('/\\s+/', '', $arrayString);
  if (strpos($arrayString, '=>array(') !== 0 && strpos($arrayString, ']=array(') !== 0 && strpos($arrayString, '=>[') !== 0 && strpos($arrayString, ']=[') !== 0) {
    return;
  }

  // We only search within the #options array.
  $arrayToken = $phpcsFile
    ->findNext([
    T_ARRAY,
    T_OPEN_SHORT_ARRAY,
  ], $stackPtr + 1);
  $nestedParenthesis = [];
  if (isset($tokens[$arrayToken]['nested_parenthesis']) === true) {
    $nestedParenthesis = $tokens[$arrayToken]['nested_parenthesis'];
  }
  if ($tokens[$arrayToken]['code'] === T_ARRAY) {
    $statementEnd = $tokens[$arrayToken]['parenthesis_closer'];
    $nestedParenthesis[$tokens[$arrayToken]['parenthesis_opener']] = $tokens[$arrayToken]['parenthesis_closer'];
  }
  else {
    $statementEnd = $tokens[$arrayToken]['bracket_closer'];
  }

  // We want to find if the element "#options" belongs to a form element.
  // Array with selectable options for a form element.
  $formElements = [
    "'checkboxes'",
    "'radios'",
    "'select'",
    "'tableselect'",
  ];

  // Find beginning of the array containing "#options" element.
  $startArray = $phpcsFile
    ->findStartOfStatement($stackPtr, [
    T_DOUBLE_ARROW,
    T_OPEN_SHORT_ARRAY,
    T_OPEN_PARENTHESIS,
    T_COMMA,
  ]);

  // Find next element on array of "#type".
  $findType = $phpcsFile
    ->findNext(T_CONSTANT_ENCAPSED_STRING, $startArray + 1, $statementEnd, false, "'#type'");

  // Stop checking the array if its #type cannot be determined.
  if ($findType === false) {
    return;
  }

  // Get the value of "#type".
  $valueType = $phpcsFile
    ->findNext(T_CONSTANT_ENCAPSED_STRING, $findType + 1, null, false);

  // Go through the array by examining stuff after "=>".
  $arrow = $phpcsFile
    ->findNext(T_DOUBLE_ARROW, $arrayToken + 1, $statementEnd, false, null, true);
  while ($arrow !== false) {
    $arrayValue = $phpcsFile
      ->findNext(T_WHITESPACE, $arrow + 1, $statementEnd, true);
    $valueNestedParenthesis = [];
    if (isset($tokens[$arrayValue]['nested_parenthesis']) === true) {
      $valueNestedParenthesis = $tokens[$arrayValue]['nested_parenthesis'];
    }

    // We are only interested in string literals that are not numbers
    // and more than 3 characters long.
    if ($tokens[$arrayValue]['code'] === T_CONSTANT_ENCAPSED_STRING && is_numeric(substr($tokens[$arrayValue]['content'], 1, -1)) === false && strlen($tokens[$arrayValue]['content']) > 5 && in_array($tokens[$valueType]['content'], $formElements) === true && $valueNestedParenthesis === $nestedParenthesis) {

      // We need to make sure that the string is the one and only part
      // of the array value.
      $afterValue = $phpcsFile
        ->findNext(T_WHITESPACE, $arrayValue + 1, $statementEnd, true);
      if ($tokens[$afterValue]['code'] === T_COMMA || $tokens[$afterValue]['code'] === T_CLOSE_PARENTHESIS) {
        $warning = '#options values usually have to run through t() for translation';
        $phpcsFile
          ->addWarning($warning, $arrayValue, 'TforValue');
      }
    }
    $arrow = $phpcsFile
      ->findNext(T_DOUBLE_ARROW, $arrow + 1, $statementEnd, false, null, true);
  }

  //end while
}