LineLengthSniff.php in Coder 8.3.x

Namespace

Drupal\Sniffs\Files

File

coder_sniffer/Drupal/Sniffs/Files/LineLengthSniff.php

<?php

/**
 * \Drupal\Sniffs\Files\LineLengthSniff.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
namespace Drupal\Sniffs\Files;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff as GenericLineLengthSniff;
use PHP_CodeSniffer\Util\Tokens;

/**
 * Checks comment lines in the file, and throws warnings if they are over 80
 * characters in length.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class LineLengthSniff extends GenericLineLengthSniff {

  /**
   * The limit that the length of a line should not exceed.
   *
   * @var integer
   */
  public $lineLimit = 80;

  /**
   * The limit that the length of a line must not exceed.
   * But just check the line length of comments....
   *
   * Set to zero (0) to disable.
   *
   * @var integer
   */
  public $absoluteLineLimit = 0;

  /**
   * Checks if a line is too long.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
   * @param array<int, array>           $tokens    The token stack.
   * @param int                         $stackPtr  The first token on the next line.
   *
   * @return void
   */
  protected function checkLineLength($phpcsFile, $tokens, $stackPtr) {
    if (isset(Tokens::$commentTokens[$tokens[$stackPtr - 1]['code']]) === true) {
      $docCommentTag = $phpcsFile
        ->findFirstOnLine(T_DOC_COMMENT_TAG, $stackPtr - 1);
      if ($docCommentTag !== false) {

        // Allow doc comment tags such as long @param tags to exceed the 80
        // character limit.
        return;
      }
      if ($tokens[$stackPtr - 1]['code'] === T_COMMENT && (preg_match('/^[[:space:]]*\\/\\/ @.+/', $tokens[$stackPtr - 1]['content']) === 1 || strpos(trim($tokens[$stackPtr - 1]['content'], "/ \n"), ' ') === false)) {
        return;
      }

      // Code examples between @code and @endcode are allowed to exceed 80
      // characters.
      if (isset($tokens[$stackPtr]) === true && $tokens[$stackPtr]['code'] === T_DOC_COMMENT_WHITESPACE) {
        $tag = $phpcsFile
          ->findPrevious([
          T_DOC_COMMENT_TAG,
          T_DOC_COMMENT_OPEN_TAG,
        ], $stackPtr - 1);
        if ($tokens[$tag]['content'] === '@code') {
          return;
        }
      }

      // Drupal 8 annotations can have long translatable descriptions and we
      // allow them to exceed 80 characters.
      if ($tokens[$stackPtr - 2]['code'] === T_DOC_COMMENT_STRING && (strpos($tokens[$stackPtr - 2]['content'], '@Translation(') !== false || strpos($tokens[$stackPtr - 2]['content'], ' ') === false || preg_match('/^Contains [a-zA-Z_\\\\.]+$/', $tokens[$stackPtr - 2]['content']) === 1 || preg_match('#= ("|\')?\\S+[\\\\/]\\S+("|\')?,*$#', $tokens[$stackPtr - 2]['content']) === 1) || strpos($tokens[$stackPtr - 2]['content'], '- @link') !== false || preg_match('/^Implements hook_[a-zA-Z0-9_]+\\(\\)/', $tokens[$stackPtr - 2]['content']) === 1) {
        return;
      }
      parent::checkLineLength($phpcsFile, $tokens, $stackPtr);
    }

    //end if
  }

  //end checkLineLength()

  /**
   * Returns the length of a defined line.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile   The file being scanned.
   * @param int                         $currentLine The current line.
   *
   * @return int
   */
  public function getLineLength(File $phpcsFile, $currentLine) {
    $tokens = $phpcsFile
      ->getTokens();
    $tokenCount = 0;
    $currentLineContent = '';
    $trim = strlen($phpcsFile->eolChar) * -1;
    for (; $tokenCount < $phpcsFile->numTokens; $tokenCount++) {
      if ($tokens[$tokenCount]['line'] === $currentLine) {
        $currentLineContent .= $tokens[$tokenCount]['content'];
      }
    }
    return strlen($currentLineContent);
  }

}

//end class

Classes

Name	Description
LineLengthSniff	Checks comment lines in the file, and throws warnings if they are over 80 characters in length.