FunctionSpacingSniff
in package
implements
Sniff
Interfaces, Classes and Traits
Table of Contents
- $spacing : int
- The number of blank lines between functions.
- $spacingAfterLast : int
- The number of blank lines after the last function in a class.
- $spacingBeforeFirst : int
- The number of blank lines before the first function in a class.
- $rulesetProperties : array<string|int, mixed>|null
- Original properties as set in a custom ruleset (if any).
- process() : void
- Processes this sniff when one of its tokens is encountered.
- register() : array<string|int, mixed>
- Returns an array of tokens this test wants to listen for.
Properties
$spacing
The number of blank lines between functions.
public
int
$spacing
= 2
$spacingAfterLast
The number of blank lines after the last function in a class.
public
int
$spacingAfterLast
= 2
$spacingBeforeFirst
The number of blank lines before the first function in a class.
public
int
$spacingBeforeFirst
= 2
$rulesetProperties
Original properties as set in a custom ruleset (if any).
private
array<string|int, mixed>|null
$rulesetProperties
= null
Methods
process()
Processes this sniff 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 —register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, mixed>