Class: PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff

Source Location: /PHP_CodeSniffer-1.3.2/CodeSniffer/Standards/PEAR/Sniffs/NamingConventions/ValidFunctionNameSniff.php

Class Overview

PHP_CodeSniffer_Standards_AbstractScopeSniff
   |
   --PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff

PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.

Author(s):

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

Version:

Release: 1.3.2

Copyright:

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

Variables

Methods

Child classes:

Squiz_Sniffs_NamingConventions_ValidFunctionNameSniff: Squiz_Sniffs_NamingConventions_ValidFunctionNameSniff.

Inherited Variables

Class: PHP_CodeSniffer_Standards_AbstractScopeSniff

PHP_CodeSniffer_Standards_AbstractScopeSniff::$currFile
PHP_CodeSniffer_Standards_AbstractScopeSniff::$currScope

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]
PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.

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: 1.3.2
Copyright: 2006-2011 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')

[line 65]

A list of all PHP magic functions.

Access: protected

Type:

array

[ Top ]

$magicMethods = array(
                               'construct',
                               'destruct',
                               'call',
                               'callStatic',
                               'get',
                               'set',
                               'isset',
                               'unset',
                               'sleep',
                               'wakeup',
                               'toString',
                               'set_state',
                               'clone',
                               'invoke',
                              )

[line 43]

A list of all PHP magic methods.

Access: protected

Type:

array

[ Top ]

Method Detail

__construct (Constructor) [line 71]

PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff __construct(
)

Constructs a PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.

Access: public

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

[ Top ]

processTokenOutsideScope [line 182]

void processTokenOutsideScope(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes the tokens outside the scope.

Access: protected

Overridden in child classes as:

Squiz_Sniffs_NamingConventions_ValidFunctionNameSniff::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 88]

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

Processes the tokens within the scope.

Access: protected

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: PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Class: PHP_CodeSniffer_Standards_AbstractScopeSniff

Inherited Methods

Class: PHP_CodeSniffer_Standards_AbstractScopeSniff

Class Details

Class Variables

$magicFunctions = array('autoload')

$magicMethods = array( 'construct', 'destruct', 'call', 'callStatic', 'get', 'set', 'isset', 'unset', 'sleep', 'wakeup', 'toString', 'set_state', 'clone', 'invoke', )

Method Detail

__construct (Constructor) [line 71]

processTokenOutsideScope [line 182]

Parameters:

processTokenWithinScope [line 88]

Parameters:

$magicMethods = array(
'construct',
'destruct',
'call',
'callStatic',
'get',
'set',
'isset',
'unset',
'sleep',
'wakeup',
'toString',
'set_state',
'clone',
'invoke',
)