Documentation

PEAR_Sniffs_Functions_FunctionDeclarationSniff
in package
implements PHP_CodeSniffer_Sniff

PEAR_Sniffs_Functions_FunctionDeclarationSniff.

Ensure single and multi-line function declarations are defined correctly.

Tags
category

PHP

author

Greg Sherwood gsherwood@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

$indent  : int
The number of spaces code should be indented.
isMultiLineDeclaration()  : void
Determine if this is a multi-line function declaration.
process()  : void
Processes this test, when one of its tokens is encountered.
processMultiLineDeclaration()  : void
Processes multi-line declarations.
processSingleLineDeclaration()  : void
Processes single-line declarations.
register()  : array<string|int, mixed>
Returns an array of tokens this test wants to listen for.

Properties

Methods

isMultiLineDeclaration()

Determine if this is a multi-line function declaration.

public isMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, int $openBracket, array<string|int, mixed> $tokens) : void
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being scanned.

$stackPtr : int

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

$openBracket : int

The position of the opening bracket in the stack passed in $tokens.

$tokens : array<string|int, mixed>

The stack of tokens that make up the file.

Return values
void

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

processMultiLineDeclaration()

Processes multi-line declarations.

public processMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, array<string|int, mixed> $tokens) : void
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being scanned.

$stackPtr : int

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

$tokens : array<string|int, mixed>

The stack of tokens that make up the file.

Return values
void

processSingleLineDeclaration()

Processes single-line declarations.

public processSingleLineDeclaration(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, array<string|int, mixed> $tokens) : void

Just uses the Generic BSD-Allman brace sniff.

Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being scanned.

$stackPtr : int

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

$tokens : array<string|int, mixed>

The stack of tokens that make up the file.

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