public function RequiredSniff::process in Coder 8.2

Same name and namespace in other branches

1. 8.3 coder_sniffer/Drupal/Sniffs/InfoFiles/RequiredSniff.php \Drupal\Sniffs\InfoFiles\RequiredSniff::process()
2. 8.3.x coder_sniffer/Drupal/Sniffs/InfoFiles/RequiredSniff.php \Drupal\Sniffs\InfoFiles\RequiredSniff::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

int

File

coder_sniffer/Drupal/Sniffs/InfoFiles/RequiredSniff.php, line 49

Class

RequiredSniff

"name", "description" and "core are required fields in Drupal info files. Also checks the "php" minimum requirement for Drupal 7.

Namespace

Drupal\Sniffs\InfoFiles

Code

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

  // Only run this sniff once per info file.
  $fileExtension = strtolower(substr($phpcsFile
    ->getFilename(), -4));
  if ($fileExtension !== 'info') {
    return $phpcsFile->numTokens + 1;
  }
  $contents = file_get_contents($phpcsFile
    ->getFilename());
  $info = ClassFilesSniff::drupalParseInfoFormat($contents);
  if (isset($info['name']) === false) {
    $error = '"name" property is missing in the info file';
    $phpcsFile
      ->addError($error, $stackPtr, 'Name');
  }
  if (isset($info['description']) === false) {
    $error = '"description" property is missing in the info file';
    $phpcsFile
      ->addError($error, $stackPtr, 'Description');
  }
  if (isset($info['core']) === false) {
    $error = '"core" property is missing in the info file';
    $phpcsFile
      ->addError($error, $stackPtr, 'Core');
  }
  else {
    if ($info['core'] === '7.x' && isset($info['php']) === true && $info['php'] <= '5.2') {
      $error = 'Drupal 7 core already requires PHP 5.2';
      $ptr = ClassFilesSniff::getPtr('php', $info['php'], $phpcsFile);
      $phpcsFile
        ->addError($error, $ptr, 'D7PHPVersion');
    }
  }
  return $phpcsFile->numTokens + 1;
}