You are here

public function NamespacedDependencySniff::process in Coder 8.2

Same name and namespace in other branches
  1. 8.3 coder_sniffer/DrupalPractice/Sniffs/InfoFiles/NamespacedDependencySniff.php \DrupalPractice\Sniffs\InfoFiles\NamespacedDependencySniff::process()
  2. 8.3.x coder_sniffer/DrupalPractice/Sniffs/InfoFiles/NamespacedDependencySniff.php \DrupalPractice\Sniffs\InfoFiles\NamespacedDependencySniff::process()

Processes this test, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The current file being processed.:

int $stackPtr The position of the current token: in the stack passed in $tokens.

Return value

int

File

coder_sniffer/DrupalPractice/Sniffs/InfoFiles/NamespacedDependencySniff.php, line 48

Class

NamespacedDependencySniff
Checks that all declared dependencies are namespaced.

Namespace

DrupalPractice\Sniffs\InfoFiles

Code

public function process(File $phpcsFile, $stackPtr) {
  $tokens = $phpcsFile
    ->getTokens();
  $fileExtension = strtolower(substr($phpcsFile
    ->getFilename(), -9));
  if ($fileExtension !== '.info.yml') {
    return $phpcsFile->numTokens + 1;
  }
  if (preg_match('/^dependencies:/', $tokens[$stackPtr]['content']) === 0) {
    return;
  }
  $nextLine = $stackPtr + 1;
  while (isset($tokens[$nextLine]) === true) {

    // Dependency line without namespace.
    if (preg_match('/^[\\s]+- [^:]+[\\s]*$/', $tokens[$nextLine]['content']) === 1) {
      $error = 'All dependencies must be prefixed with the project name, for example "drupal:"';
      $phpcsFile
        ->addWarning($error, $nextLine, 'NonNamespaced');
    }
    else {
      if (preg_match('/^[\\s]+- [^:]+:[^:]+[\\s]*$/', $tokens[$nextLine]['content']) === 0 && preg_match('/^[\\s]*#.*$/', $tokens[$nextLine]['content']) === 0) {

        // Not a dependency line with namespace or comment - stop.
        return $nextLine;
      }
    }
    $nextLine++;
  }
}