Docs For Class FunctionDeclarationSniff

$indent = 4

[line 36]

The number of spaces code should be indented.

Access: public

Type:

integer

[ Top ]

$supportedTokenizers = array(
                                   'PHP',
                                   'JS',
                                  )

[line 26]

A list of tokenizers this sniff supports.

Access: public

Type:

array

[ Top ]

isMultiLineDeclaration [line 194]

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

Determine if this is a multi-line function declaration.

Access: public

Parameters:

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

[ Top ]

process [line 63]

void process(
File
$phpcsFile, int
$stackPtr)

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

Access: public

Parameters:

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

[ Top ]

processMultiLineDeclaration [line 258]

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

Processes multi-line declarations.

Access: public

Parameters:

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

[ Top ]

processSingleLineDeclaration [line 233]

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

Processes single-line declarations.

Just uses the Generic BSD-Allman brace sniff.

Access: public

Parameters:

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

[ Top ]

register [line 44]

array register(
)

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

Access: public

[ Top ]

Class: FunctionDeclarationSniff

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$indent = 4

$supportedTokenizers = array(
                                   'PHP',
                                   'JS',
                                  )

Method Detail

isMultiLineDeclaration [line 194]

Parameters:

process [line 63]

Parameters:

processMultiLineDeclaration [line 258]

Parameters:

processSingleLineDeclaration [line 233]

Parameters:

register [line 44]

Class: FunctionDeclarationSniff

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$indent = 4

$supportedTokenizers = array( 'PHP', 'JS', )

Method Detail

isMultiLineDeclaration [line 194]

Parameters:

process [line 63]

Parameters:

processMultiLineDeclaration [line 258]

Parameters:

processSingleLineDeclaration [line 233]

Parameters:

register [line 44]

$supportedTokenizers = array(
'PHP',
'JS',
)