Squiz_Sniffs_PHP_EmbeddedPhpSniff
in package
implements
PHP_CodeSniffer_Sniff
Squiz_Sniffs_PHP_EmbeddedPhpSniff.
Checks the indentation of embedded PHP code segments.
Tags
Interfaces, Classes and Traits
- PHP_CodeSniffer_Sniff
- Represents a PHP_CodeSniffer sniff for sniffing coding standards.
Table of Contents
- process() : void
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, mixed>
- Returns an array of tokens this test wants to listen for.
- _validateInlineEmbeddedPhp() : void
- Validates embedded PHP that exists on one line.
- _validateMultilineEmbeddedPhp() : void
- Validates embedded PHP that exists on multiple lines.
Methods
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 —register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, mixed>
Return values
array<string|int, mixed> —_validateInlineEmbeddedPhp()
Validates embedded PHP that exists on one line.
private
_validateInlineEmbeddedPhp(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 —_validateMultilineEmbeddedPhp()
Validates embedded PHP that exists on multiple lines.
private
_validateMultilineEmbeddedPhp(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.