Documentation

OneClassPerFileSniff
in package
implements Sniff

One Class Per File Sniff

Checks that only one class is declared per file. Unless the file is allowed multiple classes.

Tags
author

Louis Linehan louis.linehan@gmail.com

Interfaces, Classes and Traits

Sniff

Table of Contents

$filesAllowedMultiClass  : array<string|int, mixed>
Files that are allowed multiple classes
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.

Properties

$filesAllowedMultiClass

Files that are allowed multiple classes

public array<string|int, mixed> $filesAllowedMultiClass = ['Exception.php', 'Exceptions.php', 'CustomExceptions.php', 'Response.php']

Methods

process()

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

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>

Search results