Documentation

MySource_Sniffs_Channels_IncludeOwnSystemSniff
in package
implements PHP_CodeSniffer_Sniff

Ensures that a system does not include itself.

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

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.
getIncludedClassFromToken()  : string
Determines the included class name from given token.

Methods

process()

Processes this sniff, 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>

getIncludedClassFromToken()

Determines the included class name from given token.

protected getIncludedClassFromToken(PHP_CodeSniffer_File $phpcsFile, array<string|int, mixed> $tokens, int $stackPtr) : string
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file where this token was found.

$tokens : array<string|int, mixed>

The array of file tokens.

$stackPtr : int

The position in the tokens array of the potentially included class.

Return values
string

Search results