MultiLineFunctionDeclarationSniff
extends FunctionDeclarationSniff
in package
Table of Contents
- $indent : int
- The number of spaces code should be indented.
- $supportedTokenizers : array<string|int, mixed>
- A list of tokenizers this sniff supports.
- isMultiLineDeclaration() : void
- Determine if this is a multi-line function declaration.
- process() : void
- Processes this test, when one of its tokens is encountered.
- processArgumentList() : void
- Processes multi-line argument list declarations.
- processBracket() : void
- Processes the contents of a single set of brackets.
- 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
$indent
The number of spaces code should be indented.
public
int
$indent
= 4
$supportedTokenizers
A list of tokenizers this sniff supports.
public
array<string|int, mixed>
$supportedTokenizers
= ['PHP', 'JS']
Methods
isMultiLineDeclaration()
Determine if this is a multi-line function declaration.
public
isMultiLineDeclaration(File $phpcsFile, int $stackPtr, int $openBracket, array<string|int, mixed> $tokens) : void
Parameters
- $phpcsFile : 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(File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Return values
void —processArgumentList()
Processes multi-line argument list declarations.
public
processArgumentList(File $phpcsFile, int $stackPtr, int $indent[, string $type = 'function' ]) : void
Parameters
- $phpcsFile : File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $indent : int
-
The number of spaces code should be indented.
- $type : string = 'function'
-
The type of the token the brackets belong to.
Return values
void —processBracket()
Processes the contents of a single set of brackets.
public
processBracket(File $phpcsFile, int $openBracket, array<string|int, mixed> $tokens[, string $type = 'function' ]) : void
Parameters
- $phpcsFile : File
-
The file being scanned.
- $openBracket : int
-
The position of the open bracket in the stack passed in $tokens.
- $tokens : array<string|int, mixed>
-
The stack of tokens that make up the file.
- $type : string = 'function'
-
The type of the token the brackets belong to (function or use).
Return values
void —processMultiLineDeclaration()
Processes multi-line declarations.
public
processMultiLineDeclaration(File $phpcsFile, int $stackPtr, array<string|int, mixed> $tokens) : void
Parameters
- $phpcsFile : 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(File $phpcsFile, int $stackPtr, array<string|int, mixed> $tokens) : void
Just uses the Generic BSD-Allman brace sniff.
Parameters
- $phpcsFile : 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>