MySource_Sniffs_Commenting_FunctionCommentSniff
extends Squiz_Sniffs_Commenting_FunctionCommentSniff
in package
Parses and verifies the doc comments for functions.
Same as the Squiz standard, but adds support for API tags.
Tags
Table of Contents
- $_phpVersion : int
- The current PHP version.
- process() : void
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, mixed>
- Returns an array of tokens this test wants to listen for.
- checkSpacingAfterParamName() : void
- Check the spacing after the name of a parameter.
- checkSpacingAfterParamType() : void
- Check the spacing after the type of a parameter.
- processParams() : void
- Process the function parameter comments.
- processReturn() : void
- Process the return comment of this function comment.
- processThrows() : void
- Process any throw tags that this function comment has.
Properties
$_phpVersion
The current PHP version.
private
int
$_phpVersion
=
ull
Methods
process()
Processes this test, when one of its tokens is encountered.
public
process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Return values
void —register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, mixed>
Return values
array<string|int, mixed> —checkSpacingAfterParamName()
Check the spacing after the name of a parameter.
protected
checkSpacingAfterParamName(PHP_CodeSniffer_File $phpcsFile, array<string|int, mixed> $param, int $maxVar[, int $spacing = 1 ]) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $param : array<string|int, mixed>
-
The parameter to be checked.
- $maxVar : int
-
The maxlength of the longest parameter name.
- $spacing : int = 1
-
The number of spaces to add after the type.
Return values
void —checkSpacingAfterParamType()
Check the spacing after the type of a parameter.
protected
checkSpacingAfterParamType(PHP_CodeSniffer_File $phpcsFile, array<string|int, mixed> $param, int $maxType[, int $spacing = 1 ]) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $param : array<string|int, mixed>
-
The parameter to be checked.
- $maxType : int
-
The maxlength of the longest parameter type.
- $spacing : int = 1
-
The number of spaces to add after the type.
Return values
void —processParams()
Process the function parameter comments.
protected
processParams(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, int $commentStart) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $commentStart : int
-
The position in the stack where the comment started.
Return values
void —processReturn()
Process the return comment of this function comment.
protected
processReturn(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, int $commentStart) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $commentStart : int
-
The position in the stack where the comment started.
Return values
void —processThrows()
Process any throw tags that this function comment has.
protected
processThrows(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, int $commentStart) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $commentStart : int
-
The position in the stack where the comment started.