Documentation

Generic_Sniffs_Files_LineLengthSniff
in package
implements PHP_CodeSniffer_Sniff

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.

Tags
category

PHP

author

Greg Sherwood gsherwood@squiz.net

author

Marc McIntyre mmcintyre@squiz.net

copyright

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

license

https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence

version

Release: @package_version@

link
http://pear.php.net/package/PHP_CodeSniffer

Interfaces, Classes and Traits

PHP_CodeSniffer_Sniff
Represents a PHP_CodeSniffer sniff for sniffing coding standards.

Table of Contents

$absoluteLineLimit  : int
The limit that the length of a line must not exceed.
$lineLimit  : int
The limit that the length of a line should not exceed.
process()  : int
Processes this test, when one of its tokens is encountered.
register()  : array<string|int, mixed>
Returns an array of tokens this test wants to listen for.
checkLineLength()  : null|false
Checks if a line is too long.

Properties

$absoluteLineLimit

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

public int $absoluteLineLimit = 100

Set to zero (0) to disable.

$lineLimit

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

public int $lineLimit = 80

Methods

process()

Processes this test, when one of its tokens is encountered.

public process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : int
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being scanned.

$stackPtr : int

The position of the current token in the stack passed in $tokens.

Return values
int

register()

Returns an array of tokens this test wants to listen for.

public register() : array<string|int, mixed>
Return values
array<string|int, mixed>

checkLineLength()

Checks if a line is too long.

protected checkLineLength(PHP_CodeSniffer_File $phpcsFile, array<string|int, mixed> $tokens, int $stackPtr) : null|false
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being scanned.

$tokens : array<string|int, mixed>

The token stack.

$stackPtr : int

The first token on the next line.

Return values
null|false

Search results