Property | Type | Description | |
---|---|---|---|
$tags | array | Tags in correct order and related info. |
Method | Description | |
---|---|---|
process ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : integer | Processes this test, when one of its tokens is encountered. | |
register ( ) : array | Returns an array of tokens this test wants to listen for. |
Method | Description | |
---|---|---|
processAuthor ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | Process the author tag(s) that this header comment has. | |
processCategory ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | Process the category tag. | |
processCopyright ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | Process the copyright tags. | |
processLicense ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | Process the license tag. | |
processPackage ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | Process the package tag. | |
processSubpackage ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | Process the subpackage tag. | |
processTags ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr, integer $commentStart ) : void | Processes each required or optional tag. | |
processVersion ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | Process the version tag. |
protected processAuthor ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | ||
$phpcsFile | PHP_CodeSniffer_File | The file being scanned. |
$tags | array | The tokens for these tags. |
return | void |
protected processCategory ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | ||
$phpcsFile | PHP_CodeSniffer_File | The file being scanned. |
$tags | array | The tokens for these tags. |
return | void |
protected processCopyright ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | ||
$phpcsFile | PHP_CodeSniffer_File | The file being scanned. |
$tags | array | The tokens for these tags. |
return | void |
protected processLicense ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | ||
$phpcsFile | PHP_CodeSniffer_File | The file being scanned. |
$tags | array | The tokens for these tags. |
return | void |
protected processPackage ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | ||
$phpcsFile | PHP_CodeSniffer_File | The file being scanned. |
$tags | array | The tokens for these tags. |
return | void |
protected processSubpackage ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | ||
$phpcsFile | PHP_CodeSniffer_File | The file being scanned. |
$tags | array | The tokens for these tags. |
return | void |
protected processTags ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr, integer $commentStart ) : void | ||
$phpcsFile | PHP_CodeSniffer_File | The file being scanned. |
$stackPtr | integer | The position of the current token in the stack passed in $tokens. |
$commentStart | integer | Position in the stack where the comment started. |
return | void |
protected processVersion ( PHP_CodeSniffer_File $phpcsFile, array $tags ) : void | ||
$phpcsFile | PHP_CodeSniffer_File | The file being scanned. |
$tags | array | The tokens for these tags. |
return | void |
protected array $tags | ||
return | array |