Class: ConstructorNameSniff

Source Location: /PHP_CodeSniffer-3.1.1/src/Standards/Generic/Sniffs/NamingConventions/ConstructorNameSniff.php

AbstractScopeSniff
   |
   --ConstructorNameSniff

Bans PHP 4 style constructors.

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

[line 19]
Bans PHP 4 style constructors.

Favor PHP 5 constructor syntax, which uses "function __construct()". Avoid PHP 4 constructor syntax, which uses "function ClassName()".

[ Top ]

ConstructorNameSniff __construct(
)

Constructs the test with the tokens it wishes to listen for.

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

[ Top ]

void loadFunctionNamesInScope(
File
$phpcsFile, int
$currScope)

Extracts all the function names found in the given scope.

\PHP_CodeSniffer\Files\File	`$phpcsFile`	—	The current file being scanned.
int	`$currScope`	—	A pointer to the start of the scope.

[ Top ]

void processTokenOutsideScope(
File
$phpcsFile, int
$stackPtr)

Processes a token that is found within the scope that this test is listening to.

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

\PHP_CodeSniffer\Files\File	`$phpcsFile`	—	The file where this token was found.
int	`$stackPtr`	—	The position in the stack where this token was found.

[ Top ]

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

Processes this test when one of its tokens is encountered.

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

\PHP_CodeSniffer\Files\File	`$phpcsFile`	—	The current file being scanned.
int	`$stackPtr`	—	The position of the current token in the stack passed in $tokens.
int	`$currScope`	—	A pointer to the start of the scope.

[ Top ]