public function Drupal_Sniffs_Commenting_InlineCommentSniff::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/InlineCommentSniff.php, line 60

Class

Drupal_Sniffs_Commenting_InlineCommentSniff

PHP_CodeSniffer_Sniffs_Drupal_Commenting_InlineCommentSniff.

Code

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

  // If this is a function/class/interface doc block comment, skip it.
  // We are only interested in inline doc block comments, which are
  // not allowed.
  if ($tokens[$stackPtr]['code'] === T_DOC_COMMENT) {
    $nextToken = $phpcsFile
      ->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, $stackPtr + 1, null, true);
    $ignore = array(
      T_CLASS,
      T_INTERFACE,
      T_FUNCTION,
      T_PUBLIC,
      T_PRIVATE,
      T_PROTECTED,
      T_FINAL,
      T_STATIC,
      T_ABSTRACT,
      T_CONST,
      T_OBJECT,
      T_PROPERTY,
    );

    // Also ignore all doc blocks defined in the outer scope (no scope
    // conditions are set).
    if (in_array($tokens[$nextToken]['code'], $ignore) === true || empty($tokens[$stackPtr]['conditions']) === true) {
      return;
    }
    else {
      $prevToken = $phpcsFile
        ->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, $stackPtr - 1, null, true);
      if ($tokens[$prevToken]['code'] === T_OPEN_TAG) {
        return;
      }

      // Only error once per comment.
      if (substr($tokens[$stackPtr]['content'], 0, 3) === '/**') {
        $error = 'Inline doc block comments are not allowed; use "// Comment" instead';
        $phpcsFile
          ->addError($error, $stackPtr, 'DocBlock');
      }
    }

    //end if
  }

  //end if
  if ($tokens[$stackPtr]['content'][0] === '#') {
    $error = 'Perl-style comments are not allowed; use "// Comment" instead';
    $phpcsFile
      ->addError($error, $stackPtr, 'WrongStyle');
  }
  $comment = rtrim($tokens[$stackPtr]['content']);

  // Only want inline comments.
  if (substr($comment, 0, 2) !== '//') {
    return;
  }

  // Ignore code example lines.
  if ($this
    ->isInCodeExample($phpcsFile, $stackPtr) === true) {
    return;
  }

  // Verify the indentation of this comment line.
  $this
    ->processIndentation($phpcsFile, $stackPtr);

  // The below section determines if a comment block is correctly capitalised,
  // and ends in a full-stop. It will find the last comment in a block, and
  // work its way up.
  $nextComment = $phpcsFile
    ->findNext(array(
    T_COMMENT,
  ), $stackPtr + 1, null, false);
  if ($nextComment !== false && $tokens[$nextComment]['line'] === $tokens[$stackPtr]['line'] + 1) {
    return;
  }
  $topComment = $stackPtr;
  $lastComment = $stackPtr;
  while (($topComment = $phpcsFile
    ->findPrevious(array(
    T_COMMENT,
  ), $lastComment - 1, null, false)) !== false) {
    if ($tokens[$topComment]['line'] !== $tokens[$lastComment]['line'] - 1) {
      break;
    }
    $lastComment = $topComment;
  }
  $topComment = $lastComment;
  $commentText = '';
  for ($i = $topComment; $i <= $stackPtr; $i++) {
    if ($tokens[$i]['code'] === T_COMMENT) {
      $commentText .= trim(substr($tokens[$i]['content'], 2));
    }
  }
  if ($commentText === '') {
    $error = 'Blank comments are not allowed';
    $phpcsFile
      ->addError($error, $stackPtr, 'Empty');
    return;
  }
  $words = preg_split('/\\s+/', $commentText);
  if ($commentText[0] !== strtoupper($commentText[0])) {

    // Allow special lower cased words that contain non-alpha characters
    // (function references, machine names with underscores etc.).
    $matches = array();
    preg_match('/[a-z]+/', $words[0], $matches);
    if ($matches[0] === $words[0]) {
      $error = 'Inline comments must start with a capital letter';
      $phpcsFile
        ->addError($error, $topComment, 'NotCapital');
    }
  }
  $commentCloser = $commentText[strlen($commentText) - 1];
  $acceptedClosers = array(
    'full-stops' => '.',
    'exclamation marks' => '!',
    'or question marks' => '?',
  );
  if (in_array($commentCloser, $acceptedClosers) === false) {

    // Allow @tag style comments without punctuation
    $firstWord = $words[0];
    if (strpos($firstWord, '@') !== 0) {

      // Allow special last words like URLs or function references
      // without punctuation.
      $lastWord = $words[count($words) - 1];
      $matches = array();
      preg_match('/((\\()?[$a-zA-Z]+\\)|([$a-zA-Z]+))/', $lastWord, $matches);
      if (isset($matches[0]) === true && $matches[0] === $lastWord) {
        $error = 'Inline comments must end in %s';
        $ender = '';
        foreach ($acceptedClosers as $closerName => $symbol) {
          $ender .= $closerName . ', ';
        }
        $ender = rtrim($ender, ', ');
        $data = array(
          $ender,
        );
        $phpcsFile
          ->addError($error, $stackPtr, 'InvalidEndChar', $data);
      }
    }
  }
}