Source for file ClosingDeclarationCommentSniff.php
Documentation is available at ClosingDeclarationCommentSniff.php
* Checks the //end ... comments on classes, interfaces and functions.
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class ClosingDeclarationCommentSniff implements Sniff
* Returns an array of tokens this test wants to listen for.
public function register ()
* Processes this test, when one of its tokens is encountered.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token in the
* stack passed in $tokens..
public function process (File $phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
if ($tokens[$stackPtr]['code'] === T_FUNCTION ) {
$methodProps = $phpcsFile->getMethodProperties ($stackPtr);
// Abstract methods do not require a closing comment.
if ($methodProps['is_abstract'] === true ) {
// If this function is in an interface then we don't require
if ($phpcsFile->hasCondition ($stackPtr, T_INTERFACE ) === true ) {
if (isset ($tokens[$stackPtr]['scope_closer']) === false ) {
$error = 'Possible parse error: non-abstract method defined as abstract';
$phpcsFile->addWarning ($error, $stackPtr, 'Abstract');
$decName = $phpcsFile->getDeclarationName ($stackPtr);
$comment = '//end '. $decName. '()';
} else if ($tokens[$stackPtr]['code'] === T_CLASS ) {
$comment = '//end class';
$comment = '//end interface';
if (isset ($tokens[$stackPtr]['scope_closer']) === false ) {
$error = 'Possible parse error: %s missing opening or closing brace';
$data = array ($tokens[$stackPtr]['content']);
$phpcsFile->addWarning ($error, $stackPtr, 'MissingBrace', $data);
$closingBracket = $tokens[$stackPtr]['scope_closer'];
if ($closingBracket === null ) {
// Possible inline structure. Other tests will handle it.
if (isset ($tokens[($closingBracket + 1 )]) === false || $tokens[($closingBracket + 1 )]['code'] !== T_COMMENT ) {
$next = $phpcsFile->findNext (T_WHITESPACE , ($closingBracket + 1 ), null , true );
if (rtrim($tokens[$next]['content']) === $comment) {
// The comment isn't really missing; it is just in the wrong place.
$fix = $phpcsFile->addFixableError ('Expected %s directly after closing brace', $closingBracket, 'Misplaced', $data);
$phpcsFile->fixer ->beginChangeset ();
for ($i = ($closingBracket + 1 ); $i < $next; $i++ ) {
$phpcsFile->fixer ->replaceToken ($i, '');
// Just in case, because indentation fixes can add indents onto
// these comments and cause us to be unable to fix them.
$phpcsFile->fixer ->replaceToken ($next, $comment. $phpcsFile->eolChar );
$phpcsFile->fixer ->endChangeset ();
$fix = $phpcsFile->addFixableError ('Expected %s', $closingBracket, 'Missing', $data);
$phpcsFile->fixer ->replaceToken ($closingBracket, '}'. $comment. $phpcsFile->eolChar );
if (rtrim($tokens[($closingBracket + 1 )]['content']) !== $comment) {
$fix = $phpcsFile->addFixableError ('Expected %s', $closingBracket, 'Incorrect', $data);
$phpcsFile->fixer ->replaceToken (($closingBracket + 1 ), $comment. $phpcsFile->eolChar );
Documentation generated on Mon, 11 Mar 2019 15:27:17 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|