NamespacedDependencySniff.php in Coder 8.2

Namespace

DrupalPractice\Sniffs\InfoFiles

File

coder_sniffer/DrupalPractice/Sniffs/InfoFiles/NamespacedDependencySniff.php

<?php

/**
 * \DrupalPractice\Sniffs\InfoFiles\NamespacedDependencySniff.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
namespace DrupalPractice\Sniffs\InfoFiles;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

/**
 * Checks that all declared dependencies are namespaced.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class NamespacedDependencySniff implements Sniff {

  /**
   * Returns an array of tokens this test wants to listen for.
   *
   * @return array
   */
  public function register() {
    return array(
      T_INLINE_HTML,
    );
  }

  //end register()

  /**
   * Processes this test, when one of its tokens is encountered.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being processed.
   * @param int                         $stackPtr  The position of the current token
   *                                               in the stack passed in $tokens.
   *
   * @return int
   */
  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++;
    }
  }

}

//end class

Classes

Name	Description
NamespacedDependencySniff	Checks that all declared dependencies are namespaced.