Class: Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff

Source Location: /PHP_CodeSniffer-0.6.0/CodeSniffer/Standards/Squiz/Sniffs/Commenting/FunctionCommentThrowTagSniff.php

PHP_CodeSniffer_Standards_AbstractScopeSniff
   |
   --Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff

Verifies that a @throws tag exists for a function that throws exceptions.

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.

[line 35]
Verifies that a @throws tag exists for a function that throws exceptions.

Verifies the number of @throws tags and the number of throw tokens matches. Verifies the exception type.

[ Top ]

Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff __construct(
)

Constructs a Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff.

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

[ Top ]

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

Processes the function tokens within the class.

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

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

[ Top ]