public function ClassCommentSniff::process in Coder 8.2

Same name and namespace in other branches

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

void

File

coder_sniffer/Drupal/Sniffs/Commenting/ClassCommentSniff.php, line 57

Class

ClassCommentSniff

Checks that comment doc blocks exist on classes, interfaces and traits. Largely copied from PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\ClassCommentSniff.

Namespace

Drupal\Sniffs\Commenting

Code

public function process(File $phpcsFile, $stackPtr) {
  $tokens = $phpcsFile
    ->getTokens();
  $find = Tokens::$methodPrefixes;
  $find[] = T_WHITESPACE;
  $name = $tokens[$stackPtr]['content'];
  $commentEnd = $phpcsFile
    ->findPrevious($find, $stackPtr - 1, null, true);
  if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG && $tokens[$commentEnd]['code'] !== T_COMMENT) {
    $fix = $phpcsFile
      ->addFixableError('Missing %s doc comment', $stackPtr, 'Missing', array(
      $name,
    ));
    if ($fix === true) {
      $phpcsFile->fixer
        ->addContent($commentEnd, "\n/**\n *\n */");
    }
    return;
  }

  // Try and determine if this is a file comment instead of a class comment.
  if ($tokens[$commentEnd]['code'] === T_DOC_COMMENT_CLOSE_TAG) {
    $start = $tokens[$commentEnd]['comment_opener'] - 1;
  }
  else {
    $start = $commentEnd - 1;
  }
  $fileTag = $phpcsFile
    ->findNext(T_DOC_COMMENT_TAG, $start + 1, $commentEnd, false, '@file');
  if ($fileTag !== false) {

    // This is a file comment.
    $fix = $phpcsFile
      ->addFixableError('Missing %s doc comment', $stackPtr, 'Missing', array(
      $name,
    ));
    if ($fix === true) {
      $phpcsFile->fixer
        ->addContent($commentEnd, "\n/**\n *\n */");
    }
    return;
  }
  if ($tokens[$commentEnd]['code'] === T_COMMENT) {
    $fix = $phpcsFile
      ->addFixableError('You must use "/**" style comments for a %s comment', $stackPtr, 'WrongStyle', array(
      $name,
    ));
    if ($fix === true) {

      // Convert the comment into a doc comment.
      $phpcsFile->fixer
        ->beginChangeset();
      $comment = '';
      for ($i = $commentEnd; $tokens[$i]['code'] === T_COMMENT; $i--) {
        $comment = ' *' . ltrim($tokens[$i]['content'], '/* ') . $comment;
        $phpcsFile->fixer
          ->replaceToken($i, '');
      }
      $phpcsFile->fixer
        ->replaceToken($commentEnd, "/**\n" . rtrim($comment, "*/\n") . "\n */");
      $phpcsFile->fixer
        ->endChangeset();
    }
    return;
  }
  if ($tokens[$commentEnd]['line'] !== $tokens[$stackPtr]['line'] - 1) {
    $error = 'There must be exactly one newline after the %s comment';
    $fix = $phpcsFile
      ->addFixableError($error, $commentEnd, 'SpacingAfter', array(
      $name,
    ));
    if ($fix === true) {
      $phpcsFile->fixer
        ->beginChangeset();
      for ($i = $commentEnd + 1; $tokens[$i]['code'] === T_WHITESPACE && $i < $stackPtr; $i++) {
        $phpcsFile->fixer
          ->replaceToken($i, '');
      }
      $phpcsFile->fixer
        ->addContent($commentEnd, "\n");
      $phpcsFile->fixer
        ->endChangeset();
    }
  }
}