Documentation

FilenameMatchesClassSniff
in package
implements Sniff

Filename Matches Class Sniff

Checks that the filename matches the class name.

Tags
author

Louis Linehan louis.linehan@gmail.com

Interfaces, Classes and Traits

Sniff

Table of Contents

$badFilename  : bool
If the file has a bad filename.
process()  : int
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.

Properties

$badFilename

If the file has a bad filename.

protected bool $badFilename = false

Change to true and check it later to avoid displaying multiple errors.

Methods

process()

Processes this sniff, when one of its tokens is encountered.

public process(File $phpcsFile, int $stackPtr) : int
Parameters
$phpcsFile : File

The file being scanned.

$stackPtr : int

The position of the current token in the stack passed in $tokens.

Return values
int

register()

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

public register() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results