Documentation

AssignThisSniff
in package
implements Sniff, DeprecatedSniff

Table of Contents

Interfaces

Sniff
DeprecatedSniff

Properties

$supportedTokenizers  : array<string|int, mixed>
A list of tokenizers this sniff supports.

Methods

getDeprecationMessage()  : string
Provide a custom message to display with the deprecation.
getDeprecationVersion()  : string
Provide the version number in which the sniff was deprecated.
getRemovalVersion()  : string
Provide the version number in which the sniff will be removed.
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.

Properties

$supportedTokenizers

A list of tokenizers this sniff supports.

public array<string|int, mixed> $supportedTokenizers = ['JS']

Methods

getDeprecationMessage()

Provide a custom message to display with the deprecation.

public getDeprecationMessage() : string
Return values
string

getDeprecationVersion()

Provide the version number in which the sniff was deprecated.

public getDeprecationVersion() : string
Return values
string

getRemovalVersion()

Provide the version number in which the sniff will be removed.

public getRemovalVersion() : string
Return values
string

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.

register()

Returns an array of tokens this test wants to listen for.

public register() : array<string|int, int|string>
Return values
array<string|int, int|string>
On this page

Search results