DisallowAlternativeSyntaxSniff
in package
implements
Sniff
FinalYes
Forbid the use of the alternative syntax for control structures.
Tags
Table of Contents
Interfaces
Constants
- METRIC_NAME = 'Control Structure Style'
- Name of the metric.
Properties
- $allowWithInlineHTML : bool
- Whether to allow the alternative syntax when it is wrapped around inline HTML, as is often seen in views.
Methods
- process() : void
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, int|string>
- Returns an array of tokens this test wants to listen for.
Constants
METRIC_NAME
Name of the metric.
public
string
METRIC_NAME
= 'Control Structure Style'
Tags
Properties
$allowWithInlineHTML
Whether to allow the alternative syntax when it is wrapped around inline HTML, as is often seen in views.
public
bool
$allowWithInlineHTML
= false
Note: inline HTML within "closed scopes" - like function declarations -, within the control structure body will not be taken into account.
Tags
Methods
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.
Tags
register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, int|string>