Class: PSR2_Sniffs_Classes_ClassDeclarationSniff

Source Location: /PHP_CodeSniffer-2.0.0a2/CodeSniffer/Standards/PSR2/Sniffs/Classes/ClassDeclarationSniff.php

Class Overview

PEAR_Sniffs_Classes_ClassDeclarationSniff
 |
 --PSR2_Sniffs_Classes_ClassDeclarationSniff

Class Declaration Test.

Author(s):

Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 2.0.0a2

Copyright:

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

Methods

Child classes:

Squiz_Sniffs_Classes_ClassDeclarationSniff: Class Declaration Test.

Inherited Variables

Class: PEAR_Sniffs_Classes_ClassDeclarationSniff

PEAR_Sniffs_Classes_ClassDeclarationSniff::$indent

Inherited Methods

Class: PEAR_Sniffs_Classes_ClassDeclarationSniff

PEAR_Sniffs_Classes_ClassDeclarationSniff::process(): Processes this test, when one of its tokens is encountered.
PEAR_Sniffs_Classes_ClassDeclarationSniff::register(): Returns an array of tokens this test wants to listen for.

Class Details

[line 33]
Class Declaration Test.

Checks the declaration of the class and its inheritance is correct.

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

[ Top ]

Method Detail

process [line 46]

void process(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes this test, when one of its tokens is encountered.

Access: public

Overridden in child classes as:

Squiz_Sniffs_Classes_ClassDeclarationSniff::process(): Processes this test, when one of its tokens is encountered.

Overrides PEAR_Sniffs_Classes_ClassDeclarationSniff::process() (Processes this test, when one of its tokens is encountered.)

Parameters:

PHP_CodeSniffer_File $phpcsFile — The file being scanned.

int $stackPtr — The position of the current token in the stack passed in $tokens.

[ Top ]

processClose [line 353]

void processClose(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes the closing section of a class declaration.

Access: public

Overridden in child classes as:

Squiz_Sniffs_Classes_ClassDeclarationSniff::processClose(): Processes the closing section of a class declaration.

Parameters:

PHP_CodeSniffer_File $phpcsFile — The file being scanned.

int $stackPtr — The position of the current token in the stack passed in $tokens.

[ Top ]

processOpen [line 65]

void processOpen(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes the opening section of a class declaration.

Access: public

Overridden in child classes as:

Squiz_Sniffs_Classes_ClassDeclarationSniff::processOpen(): Processes the opening section of a class declaration.

Parameters:

PHP_CodeSniffer_File $phpcsFile — The file being scanned.

int $stackPtr — The position of the current token in the stack passed in $tokens.

[ Top ]