PHP_CodeSniffer
[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Class: Generic_Sniffs_Files_LineLengthSniff

Source Location: /PHP_CodeSniffer-1.3.4/CodeSniffer/Standards/Generic/Sniffs/Files/LineLengthSniff.php

Class Overview


Generic_Sniffs_Files_LineLengthSniff.


Author(s):

Version:

  • Release: 1.3.4

Copyright:

  • 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 32]
Generic_Sniffs_Files_LineLengthSniff.

Checks all lines in the file, and throws warnings if they are over 80 characters in length and errors if they are over 100. Both these figures can be changed by extending this sniff in your own standard.



[ Top ]


Class Variables

$absoluteLineLimit =  100

[line 49]

The limit that the length of a line must not exceed.

Set to zero (0) to disable.

  • Access: public

Type:   int


[ Top ]

$lineLimit =  80

[line 40]

The limit that the length of a line should not exceed.
  • Access: public

Type:   int


[ Top ]



Method Detail

checkLineLength   [line 114]

void checkLineLength( PHP_CodeSniffer_File $phpcsFile, int $stackPtr, string $lineContent)

Checks if a line is too long.
  • Access: protected

Parameters:

PHP_CodeSniffer_File   $phpcsFile     The file being scanned.
int   $stackPtr     The token at the end of the line.
string   $lineContent     The content of the line.

[ Top ]

process   [line 73]

void process( PHP_CodeSniffer_File $phpcsFile, int $stackPtr)

Processes this test, when one of its tokens is encountered.
  • Access: public

Parameters:

PHP_CodeSniffer_File   $phpcsFile     The file being scanned.
int   $stackPtr     The position of the current token in the stack passed in $tokens.

[ Top ]

register   [line 57]

array register( )

Returns an array of tokens this test wants to listen for.
  • Access: public

[ Top ]


Documentation generated on Thu, 17 May 2012 05:01:00 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.