class RequiredSniff in Coder 8.3

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

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

• class \Drupal\Sniffs\InfoFiles\RequiredSniff implements \PHP_CodeSniffer\Sniffs\Sniff

File

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

Namespace

Drupal\Sniffs\InfoFiles

class RequiredSniff implements Sniff {

  /**
   * Returns an array of tokens this test wants to listen for.
   *
   * @return array<int|string>
   */
  public function register() {
    return [
      T_INLINE_HTML,
    ];
  }

  //end register()

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

}

Members

Name	Modifiers	Type	Description	Overrides
RequiredSniff::process	public	function	Processes this test, when one of its tokens is encountered.
RequiredSniff::register	public	function	Returns an array of tokens this test wants to listen for.