class Drupal_Sniffs_Files_LineLengthSniff in Coder 7.2

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

Hierarchy

• class \Drupal_Sniffs_Files_LineLengthSniff extends \Generic_Sniffs_Files_LineLengthSniff

File

coder_sniffer/Drupal/Sniffs/Files/LineLengthSniff.php, line 20

class Drupal_Sniffs_Files_LineLengthSniff extends Generic_Sniffs_Files_LineLengthSniff {

  /**
   * The limit that the length of a line should not exceed.
   *
   * @var int
   */
  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 int
   */
  public $absoluteLineLimit = 0;

  /**
   * Checks if a line is too long.
   *
   * @param PHP_CodeSniffer_File $phpcsFile   The file being scanned.
   * @param int                  $stackPtr    The token at the end of the line.
   * @param string               $lineContent The content of the line.
   *
   * @return void
   */
  protected function checkLineLength(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $lineContent) {
    $tokens = $phpcsFile
      ->getTokens();
    if ($tokens[$stackPtr]['code'] === T_DOC_COMMENT || $tokens[$stackPtr]['code'] === T_COMMENT) {
      if (preg_match('/^[[:space:]]*(\\/\\*)?\\*[[:space:]]*@link.*@endlink[[:space:]]*/', $lineContent) === 1) {

        // Allow @link documentation to exceed the 80 character limit.
        return;
      }
      if (preg_match('/^[[:space:]]*((\\/\\*)?\\*|\\/\\/)[[:space:]]*@see.*/', $lineContent) === 1) {

        // Allow @see documentation to exceed the 80 character limit.
        return;
      }
      parent::checkLineLength($phpcsFile, $stackPtr, $lineContent);
    }
  }

  //end checkLineLength()

  /**
   * Returns the length of a defined line.
   *
   * @return integer
   */
  public function getLineLength(PHP_CodeSniffer_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);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Drupal_Sniffs_Files_LineLengthSniff::$absoluteLineLimit	public	property	The limit that the length of a line must not exceed. But just check the line length of comments....
Drupal_Sniffs_Files_LineLengthSniff::$lineLimit	public	property	The limit that the length of a line should not exceed.
Drupal_Sniffs_Files_LineLengthSniff::checkLineLength	protected	function	Checks if a line is too long.
Drupal_Sniffs_Files_LineLengthSniff::getLineLength	public	function	Returns the length of a defined line.