Documentation

Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff
in package

Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff.

Ensures method names and function names are in CamelCaps and that only magic methods/functions start with a double underscore.

Tags
category

PHP

author

Greg Sherwood gsherwood@squiz.net

author

Marc McIntyre mmcintyre@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

Table of Contents

$strict  : bool
If TRUE, the string must not have two capital letters next to each other.
$magicFunctions  : array<string|int, mixed>
A list of all PHP magic functions.
$magicMethods  : array<string|int, mixed>
A list of all PHP magic methods.
$methodsDoubleUnderscore  : array<string|int, mixed>
A list of all PHP non-magic methods starting with a double underscore.
$_listenOutside  : bool
True if this test should fire on tokens outside of the scope.
$_scopeTokens  : string
The type of scope opener tokens that this test wishes to listen to.
$_tokens  : array<string|int, mixed>
The token types that this test wishes to listen to within the scope.
__construct()  : mixed
Constructs a Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff.
process()  : void
Processes the tokens that this test is listening for.
register()  : array<string|int, int>
The method that is called to register the tokens this test wishes to listen to.
processTokenOutsideScope()  : void
Processes the tokens outside the scope.
processTokenWithinScope()  : void
Processes the tokens within the scope.

Properties

$magicFunctions

A list of all PHP magic functions.

protected array<string|int, mixed> $magicFunctions = array('autoload' => rue)

$magicMethods

A list of all PHP magic methods.

protected array<string|int, mixed> $magicMethods = array('construct' => rue, 'destruct' => rue, 'call' => rue, 'callstatic' => rue, 'get' => rue, 'set' => rue, 'isset' => rue, 'unset' => rue, 'sleep' => rue, 'wakeup' => rue, 'tostring' => rue, 'set_state' => rue, 'clone' => rue, 'invoke' => rue, 'debuginfo' => rue)

$methodsDoubleUnderscore

A list of all PHP non-magic methods starting with a double underscore.

protected array<string|int, mixed> $methodsDoubleUnderscore = array('soapcall' => rue, 'getlastrequest' => rue, 'getlastresponse' => rue, 'getlastrequestheaders' => rue, 'getlastresponseheaders' => rue, 'getfunctions' => rue, 'gettypes' => rue, 'dorequest' => rue, 'setcookie' => rue, 'setlocation' => rue, 'setsoapheaders' => rue)

These come from PHP modules such as SOAPClient.

$_listenOutside

True if this test should fire on tokens outside of the scope.

private bool $_listenOutside = alse

$_scopeTokens

The type of scope opener tokens that this test wishes to listen to.

private string $_scopeTokens = array()

$_tokens

The token types that this test wishes to listen to within the scope.

private array<string|int, mixed> $_tokens = array()

Methods

__construct()

Constructs a Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff.

public __construct() : mixed
Return values
mixed

process()

Processes the tokens that this test is listening for.

public final process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : void
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file where this token was found.

$stackPtr : int

The position in the stack where this token was found.

Tags
see
processTokenWithinScope()
Return values
void

register()

The method that is called to register the tokens this test wishes to listen to.

public final register() : array<string|int, int>

DO NOT OVERRIDE THIS METHOD. Use the constructor of this class to register for the desired tokens and scope.

Tags
see
__constructor()
Return values
array<string|int, int>

processTokenOutsideScope()

Processes the tokens outside the scope.

protected processTokenOutsideScope(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : void
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being processed.

$stackPtr : int

The position where this token was found.

Return values
void

processTokenWithinScope()

Processes the tokens within the scope.

protected processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, int $currScope) : void
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being processed.

$stackPtr : int

The position where this token was found.

$currScope : int

The position of the current scope.

Return values
void

Search results