\PHP_CodeSniffer\Standards\Squiz\Sniffs\FunctionsMultiLineFunctionDeclarationSniff

Summary

Methods

Properties

Constants

register()
process()
isMultiLineDeclaration()
processSingleLineDeclaration()
processMultiLineDeclaration()
processBracket()

$supportedTokenizers
$indent

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

Properties

$supportedTokenizers

$supportedTokenizers : array

A list of tokenizers this sniff supports.

Type

array

$indent

$indent : integer

The number of spaces code should be indented.

Type

integer

Methods

register()

register() : array

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

An example return value for a sniff that wants to listen for whitespace and any comments would be:

return array( T_WHITESPACE, T_DOC_COMMENT, T_COMMENT, );

Returns

array

process()

process(\PHP_CodeSniffer\Files\File  $phpcsFile, integer  $stackPtr) : void

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

The stackPtr variable indicates where in the stack the token was found. A sniff can acquire information this token, along with all the other tokens within the stack by first acquiring the token stack:

$tokens = $phpcsFile->getTokens(); echo 'Encountered a '.$tokens[$stackPtr]['type'].' token'; echo 'token information: '; print_r($tokens[$stackPtr]);

If the sniff discovers an anomaly in the code, they can raise an error by calling addError() on the \PHP_CodeSniffer\Files\File object, specifying an error message and the position of the offending token:

$phpcsFile->addError('Encountered an error', $stackPtr);

Parameters

\PHP_CodeSniffer\Files\File	$phpcsFile	The file being scanned.
integer	$stackPtr	The position of the current token in the stack passed in $tokens.

isMultiLineDeclaration()

isMultiLineDeclaration(\PHP_CodeSniffer\Files\File  $phpcsFile, integer  $stackPtr, integer  $openBracket, array  $tokens) : void

Determine if this is a multi-line function declaration.

Parameters

\PHP_CodeSniffer\Files\File	$phpcsFile	The file being scanned.
integer	$stackPtr	The position of the current token in the stack passed in $tokens.
integer	$openBracket	The position of the opening bracket in the stack passed in $tokens.
array	$tokens	The stack of tokens that make up the file.

processSingleLineDeclaration()

processSingleLineDeclaration(\PHP_CodeSniffer\Files\File  $phpcsFile, integer  $stackPtr, array  $tokens) : void

Processes single-line declarations.

Just uses the Generic BSD-Allman brace sniff.

Parameters

\PHP_CodeSniffer\Files\File	$phpcsFile	The file being scanned.
integer	$stackPtr	The position of the current token in the stack passed in $tokens.
array	$tokens	The stack of tokens that make up the file.

processMultiLineDeclaration()

processMultiLineDeclaration(\PHP_CodeSniffer\Files\File  $phpcsFile, integer  $stackPtr, array  $tokens) : void

Processes multi-line declarations.

Parameters

\PHP_CodeSniffer\Files\File	$phpcsFile	The file being scanned.
integer	$stackPtr	The position of the current token in the stack passed in $tokens.
array	$tokens	The stack of tokens that make up the file.

processBracket()

processBracket(\PHP_CodeSniffer\Files\File  $phpcsFile, integer  $openBracket, array  $tokens, string  $type = 'function') : void

Processes the contents of a single set of brackets.

Parameters

\PHP_CodeSniffer\Files\File	$phpcsFile	The file being scanned.
integer	$openBracket	The position of the open bracket in the stack passed in $tokens.
array	$tokens	The stack of tokens that make up the file.
string	$type	The type of the token the brackets belong to (function or use).