Documentation

Squiz_Sniffs_WhiteSpace_ObjectOperatorSpacingSniff
in package
implements PHP_CodeSniffer_Sniff

Squiz_Sniffs_WhiteSpace_ObjectOperatorSpacingSniff.

Ensure there is no whitespace before/after an object operator.

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

$ignoreNewlines  : bool
Allow newlines instead of spaces.
process()  : void
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.
checkSpacingAfterOperator()  : bool
Check the spacing after the operator.
checkSpacingBeforeOperator()  : bool
Check the spacing before the operator.

Properties

Methods

process()

Processes this test, 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>

checkSpacingAfterOperator()

Check the spacing after the operator.

protected checkSpacingAfterOperator(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, mixed $after) : bool
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being scanned.

$stackPtr : int

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

$after : mixed

The number of spaces found after the operator or the string 'newline'.

Return values
bool

true if there was no error, false otherwise.

checkSpacingBeforeOperator()

Check the spacing before the operator.

protected checkSpacingBeforeOperator(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, mixed $before) : bool
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being scanned.

$stackPtr : int

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

$before : mixed

The number of spaces found before the operator or the string 'newline'.

Return values
bool

true if there was no error, false otherwise.

Search results