public function HookCommentSniff::process in Coder 8.3

Same name and namespace in other branches

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

Class

HookCommentSniff

Ensures hook comments on function are correct.

Namespace

Drupal\Sniffs\Commenting

Code

public function process(File $phpcsFile, $stackPtr) {
  $tokens = $phpcsFile
    ->getTokens();

  // We are only interested in the most outer scope, ignore methods in classes for example.
  if (empty($tokens[$stackPtr]['conditions']) === false) {
    return;
  }
  $commentEnd = $phpcsFile
    ->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
  if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG) {
    return;
  }
  $commentStart = $tokens[$commentEnd]['comment_opener'];
  $empty = [
    T_DOC_COMMENT_WHITESPACE,
    T_DOC_COMMENT_STAR,
  ];
  $short = $phpcsFile
    ->findNext($empty, $commentStart + 1, $commentEnd, true);
  if ($short === false) {

    // No content at all.
    return;
  }

  // Account for the fact that a short description might cover
  // multiple lines.
  $shortContent = $tokens[$short]['content'];
  $shortEnd = $short;
  for ($i = $short + 1; $i < $commentEnd; $i++) {
    if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) {
      if ($tokens[$i]['line'] === $tokens[$shortEnd]['line'] + 1) {
        $shortContent .= $tokens[$i]['content'];
        $shortEnd = $i;
      }
      else {
        break;
      }
    }
  }

  // Check if a hook implementation doc block is formatted correctly.
  if (preg_match('/^[\\s]*Implement[^\\n]+?hook_[^\\n]+/i', $shortContent, $matches) === 1) {
    if (strstr($matches[0], 'Implements ') === false || strstr($matches[0], 'Implements of') !== false || preg_match('/ (drush_)?hook_[a-zA-Z0-9_]+\\(\\)( for .+)?\\.$/', $matches[0]) !== 1) {
      $phpcsFile
        ->addWarning('Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "* Implements hook_foo_BAR_ID_bar() for xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."', $short, 'HookCommentFormat');
    }
    else {

      // Check that a hook implementation does not duplicate @param and
      // @return documentation.
      foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) {
        if ($tokens[$tag]['content'] === '@param') {
          $warn = 'Hook implementations should not duplicate @param documentation';
          $phpcsFile
            ->addWarning($warn, $tag, 'HookParamDoc');
        }
        if ($tokens[$tag]['content'] === '@return') {
          $warn = 'Hook implementations should not duplicate @return documentation';
          $phpcsFile
            ->addWarning($warn, $tag, 'HookReturnDoc');
        }
      }
    }

    //end if
    return;
  }

  //end if

  // Check if the doc block just repeats the function name with
  // "Implements example_hook_name()".
  $functionName = $phpcsFile
    ->getDeclarationName($stackPtr);
  if ($functionName !== null && preg_match("/^[\\s]*Implements {$functionName}\\(\\)\\.\$/i", $shortContent) === 1) {
    $error = 'Hook implementations must be documented with "Implements hook_example()."';
    $fix = $phpcsFile
      ->addFixableError($error, $short, 'HookRepeat');
    if ($fix === true) {
      $newComment = preg_replace('/Implements [^_]+/', 'Implements hook', $shortContent);
      $phpcsFile->fixer
        ->replaceToken($short, $newComment);
    }
  }
}