Documentation

PSR2_Sniffs_ControlStructures_SwitchDeclarationSniff
in package
implements PHP_CodeSniffer_Sniff

PSR2_Sniffs_ControlStructures_SwitchDeclarationSniff.

Ensures all switch statements are defined correctly.

Tags
category

PHP

author

Greg Sherwood gsherwood@squiz.net

copyright

2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)

license

https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence

version

Release: @package_version@

link
http://pear.php.net/package/PHP_CodeSniffer

Interfaces, Classes and Traits

PHP_CodeSniffer_Sniff
Represents a PHP_CodeSniffer sniff for sniffing coding standards.

Table of Contents

$indent  : int
The number of spaces code should be indented.
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.
_findNextCase()  : int
Find the next CASE or DEFAULT statement from a point in the file.

Properties

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>

_findNextCase()

Find the next CASE or DEFAULT statement from a point in the file.

private _findNextCase(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, int $end) : int

Note that nested switches are ignored.

Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being scanned.

$stackPtr : int

The position to start looking at.

$end : int

The position to stop looking at.

Return values
int

| bool

Search results