• Home
  • SmileElasticsuite_Sniffs_Classes_MultipleClassesOneFileSniff

PHP Class SmileElasticsuite_Sniffs_Classes_MultipleClassesOneFileSniff, elasticsuite

Forbid declaration of several classes into the same file.
Author: Aurelien FOUCRET ([email protected])
Inheritance: implements PHP_CodeSniffer_Sniff
Show file Open project: smile-sa/elasticsuite

Public Properties

Property Type Description
$supportedTokenizers array A list of tokenizers this sniff supports.

Protected Properties

Property Type Description
$classCount integer The number of times the T_CLASS token is encountered in the file.
$currentFile string The current file this class is operating on.

Public Methods

Method Description
process ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : void Processes this test, when one of its tokens is encountered.
register ( ) : array Returns an array of tokens this test wants to listen for.

Method Details

process() public method

Processes this test, when one of its tokens is encountered.
public process ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : void
$phpcsFile PHP_CodeSniffer_File All the tokens found in the document.
$stackPtr integer The position of the current token in the stack passed in $tokens.
return void

register() public method

Returns an array of tokens this test wants to listen for.
public register ( ) : array
return array

Property Details

$classCount protected property

The number of times the T_CLASS token is encountered in the file.
protected int $classCount
return integer

$currentFile protected property

The current file this class is operating on.
protected string $currentFile
return string

$supportedTokenizers public property

A list of tokenizers this sniff supports.
public array $supportedTokenizers
return array