public function Drupal_Sniffs_Commenting_FileCommentSniff::process in Coder 7.2

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

Parameters

PHP_CodeSniffer_File $phpcsFile The file being scanned.:

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

Return value

void

File

coder_sniffer/Drupal/Sniffs/Commenting/FileCommentSniff.php, line 55

Parses and verifies the doc comments for files.

Class

Drupal_Sniffs_Commenting_FileCommentSniff

Parses and verifies the doc comments for files.

Code

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

  // We are only interested if this is the first open tag.
  if ($stackPtr !== 0) {
    if ($phpcsFile
      ->findPrevious(T_OPEN_TAG, $stackPtr - 1) !== false) {
      return;
    }
  }
  $tokens = $phpcsFile
    ->getTokens();

  // Find the next non whitespace token.
  $commentStart = $phpcsFile
    ->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
  $errorToken = $stackPtr + 1;
  if (isset($tokens[$errorToken]) === false) {
    $errorToken--;
  }
  if ($tokens[$commentStart]['code'] === T_CLOSE_TAG) {

    // We are only interested if this is the first open tag.
    return;
  }
  else {
    if ($tokens[$commentStart]['code'] === T_COMMENT) {
      $error = 'You must use "/**" style comments for a file comment';
      $phpcsFile
        ->addError($error, $errorToken, 'WrongStyle');
      return;
    }
    else {
      if ($commentStart === false || $tokens[$commentStart]['code'] !== T_DOC_COMMENT) {
        $phpcsFile
          ->addError('Missing file doc comment', $errorToken, 'Missing');
        return;
      }
      else {

        // Extract the header comment docblock.
        $commentEnd = $phpcsFile
          ->findNext(T_DOC_COMMENT, $commentStart + 1, null, true);
        $commentEnd--;
        if ($tokens[$commentStart]['content'] !== '/**' . $phpcsFile->eolChar) {
          $phpcsFile
            ->addError('The first line in the file doc comment must only be "/**"', $commentStart);
          return;
        }
        $fileLine = $phpcsFile
          ->findNext(T_DOC_COMMENT, $commentStart + 1);
        if ($tokens[$fileLine]['content'] !== ' * @file' . $phpcsFile->eolChar) {

          // If the comment is not followed by whitespace, it is probably not a file doc comment.
          if ($tokens[$commentEnd]['line'] + 1 === $tokens[$phpcsFile
            ->findNext(T_WHITESPACE, $commentEnd + 1, null, true)]['line']) {
            $phpcsFile
              ->addError('Missing file doc comment', $errorToken, 'Missing');
            return;
          }
          else {
            $phpcsFile
              ->addError('The second line in the file doc comment must be " * @file"', $fileLine);
          }
        }
        $descriptionLine = $phpcsFile
          ->findNext(T_DOC_COMMENT, $fileLine + 1, $commentEnd + 1);
        if ($descriptionLine !== false && preg_match('/^ \\* [^\\s]+/', $tokens[$descriptionLine]['content']) === 0) {
          $error = 'The third line in the file doc comment must contain a description and must not be indented';
          $phpcsFile
            ->addError($error, $descriptionLine, 'DescriptionMissing');
        }
        if ($tokens[$commentEnd]['content'] !== ' */') {
          $phpcsFile
            ->addError('The last line in the file doc comment must be " */"', $commentEnd);
        }
        if ($tokens[$commentEnd]['line'] + 1 === $tokens[$phpcsFile
          ->findNext(T_WHITESPACE, $commentEnd + 1, null, true)]['line']) {
          $phpcsFile
            ->addError('File doc comments must be followed by a blank line.', $commentEnd + 1, 'SpacingAfter');
        }
      }
    }
  }

  //end if
}