Class: Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff

Source Location: /PHP_CodeSniffer-2.7.1/CodeSniffer/Standards/Generic/Sniffs/NamingConventions/CamelCapsFunctionNameSniff.php

Class Overview

PHP_CodeSniffer_Standards_AbstractScopeSniff
   |
   --Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff

Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff.

Author(s):

Marc McIntyre <mmcintyre at squiz.net>
Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 2.7.1

Copyright:

2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

Methods

Child classes:

PSR1_Sniffs_Methods_CamelCapsMethodNameSniff: PSR1_Sniffs_Methods_CamelCapsMethodNameSniff.

Inherited Variables

Inherited Methods

Class: PHP_CodeSniffer_Standards_AbstractScopeSniff

PHP_CodeSniffer_Standards_AbstractScopeSniff::__construct(): Constructs a new AbstractScopeTest.
PHP_CodeSniffer_Standards_AbstractScopeSniff::process(): Processes the tokens that this test is listening for.
PHP_CodeSniffer_Standards_AbstractScopeSniff::processTokenOutsideScope(): Processes a token that is found within the scope that this test is listening to.
PHP_CodeSniffer_Standards_AbstractScopeSniff::processTokenWithinScope(): Processes a token that is found within the scope that this test is listening to.
PHP_CodeSniffer_Standards_AbstractScopeSniff::register(): The method that is called to register the tokens this test wishes to listen to.

Class Details

[line 35]
Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff.

Ensures method names are correct depending on whether they are public or private, and that functions are named correctly.

Author: Marc McIntyre <mmcintyre@squiz.net>
Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 2.7.1
Copyright: 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
License: BSD Licence

[ Top ]

Class Variables

$magicFunctions = array('autoload' => true)

[line 87]

A list of all PHP magic functions.

Access: protected

Type:

array

[ Top ]

$magicMethods = array(
                               'construct'  => true,
                               'destruct'   => true,
                               'call'       => true,
                               'callstatic' => true,
                               'get'        => true,
                               'set'        => true,
                               'isset'      => true,
                               'unset'      => true,
                               'sleep'      => true,
                               'wakeup'     => true,
                               'tostring'   => true,
                               'set_state'  => true,
                               'clone'      => true,
                               'invoke'     => true,
                               'debuginfo'  => true,
                              )

[line 43]

A list of all PHP magic methods.

Access: protected

Type:

array

[ Top ]

$methodsDoubleUnderscore = array(
                                          'soapcall'               => true,
                                          'getlastrequest'         => true,
                                          'getlastresponse'        => true,
                                          'getlastrequestheaders'  => true,
                                          'getlastresponseheaders' => true,
                                          'getfunctions'           => true,
                                          'gettypes'               => true,
                                          'dorequest'              => true,
                                          'setcookie'              => true,
                                          'setlocation'            => true,
                                          'setsoapheaders'         => true,
                                         )

[line 68]

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

These come from PHP modules such as SOAPClient.

Access: protected

Type:

array

[ Top ]

$strict = true

[line 94]

If TRUE, the string must not have two capital letters next to each other.

Access: public

Type:

bool

[ Top ]

Method Detail

__construct (Constructor) [line 100]

Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff __construct(
)

Constructs a Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff.

Access: public

Overrides PHP_CodeSniffer_Standards_AbstractScopeSniff::__construct() (Constructs a new AbstractScopeTest.)

[ Top ]

processTokenOutsideScope [line 186]

void processTokenOutsideScope(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes the tokens outside the scope.

Access: protected

Overridden in child classes as:

PSR1_Sniffs_Methods_CamelCapsMethodNameSniff::processTokenOutsideScope(): Processes the tokens outside the scope.

Overrides PHP_CodeSniffer_Standards_AbstractScopeSniff::processTokenOutsideScope() (Processes a token that is found within the scope that this test is listening to.)

Parameters:

PHP_CodeSniffer_File	`$phpcsFile`	—	The file being processed.
int	`$stackPtr`	—	The position where this token was found.

[ Top ]

processTokenWithinScope [line 117]

void processTokenWithinScope(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, int
$currScope)

Processes the tokens within the scope.

Access: protected

Overridden in child classes as:

PSR1_Sniffs_Methods_CamelCapsMethodNameSniff::processTokenWithinScope(): Processes the tokens within the scope.

Overrides PHP_CodeSniffer_Standards_AbstractScopeSniff::processTokenWithinScope() (Processes a token that is found within the scope that this test is listening to.)

Parameters:

PHP_CodeSniffer_File	`$phpcsFile`	—	The file being processed.
int	`$stackPtr`	—	The position where this token was found.
int	`$currScope`	—	The position of the current scope.

[ Top ]

Class: Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class: PHP_CodeSniffer_Standards_AbstractScopeSniff

Class Details

Class Variables

$magicFunctions = array('autoload' => true)

$magicMethods = array( 'construct' => true, 'destruct' => true, 'call' => true, 'callstatic' => true, 'get' => true, 'set' => true, 'isset' => true, 'unset' => true, 'sleep' => true, 'wakeup' => true, 'tostring' => true, 'set_state' => true, 'clone' => true, 'invoke' => true, 'debuginfo' => true, )

$strict = true

Method Detail

__construct (Constructor) [line 100]

processTokenOutsideScope [line 186]

Parameters:

processTokenWithinScope [line 117]

Parameters:

$magicMethods = array(
'construct' => true,
'destruct' => true,
'call' => true,
'callstatic' => true,
'get' => true,
'set' => true,
'isset' => true,
'unset' => true,
'sleep' => true,
'wakeup' => true,
'tostring' => true,
'set_state' => true,
'clone' => true,
'invoke' => true,
'debuginfo' => true,
)