Documentation

Squiz_Sniffs_WhiteSpace_SuperfluousWhitespaceSniff
in package
implements PHP_CodeSniffer_Sniff

Squiz_Sniffs_WhiteSpace_SuperfluousWhitespaceSniff.

Checks that no whitespace preceeds the first content of the file, exists after the last content of the file, resides after content on any line, or are two empty lines in functions.

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

$ignoreBlankLines  : bool
If TRUE, whitespace rules are not checked for blank lines.
$supportedTokenizers  : array<string|int, mixed>
A list of tokenizers this sniff supports.
process()  : void
Processes this sniff, when one of its tokens is encountered.
register()  : array<string|int, mixed>
Returns an array of tokens this test wants to listen for.

Properties

$ignoreBlankLines

If TRUE, whitespace rules are not checked for blank lines.

public bool $ignoreBlankLines = alse

Blank lines are those that contain only whitespace.

$supportedTokenizers

A list of tokenizers this sniff supports.

public array<string|int, mixed> $supportedTokenizers = array('PHP', 'JS', 'CSS')

Methods

process()

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

public process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : void
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
void

register()

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

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

Search results