West/Sniffs/Commenting/FileCommentSniff.php
public function process(File $phpcsFile, $stackPtr)
    {
        $tokens       = $phpcsFile->getTokens();
        $commentStart = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);

        if ($tokens[$commentStart]['code'] === T_COMMENT) {
            $phpcsFile->addError('You must use "/**" style comments for a file comment', $commentStart, 'WrongStyle');
            $phpcsFile->recordMetric($stackPtr, 'File has doc comment', 'yes');
            return ($phpcsFile->numTokens + 1);
        } else if ($commentStart === false || $tokens[$commentStart]['code'] !== T_DOC_COMMENT_OPEN_TAG) {
            $phpcsFile->addError('Missing file doc comment', $stackPtr, 'Missing');
            $phpcsFile->recordMetric($stackPtr, 'File has doc comment', 'no');
            return ($phpcsFile->numTokens + 1);
        }

        if (isset($tokens[$commentStart]['comment_closer']) === false
            || ($tokens[$tokens[$commentStart]['comment_closer']]['content'] === ''
            && $tokens[$commentStart]['comment_closer'] === ($phpcsFile->numTokens - 1))
        ) {
            // Don't process an unfinished file comment during live coding.
            return ($phpcsFile->numTokens + 1);
        }

        $commentEnd = $tokens[$commentStart]['comment_closer'];

        $nextToken = $phpcsFile->findNext(
            T_WHITESPACE,
            ($commentEnd + 1),
            null,
            true
        );

        $ignore = [
            T_CLASS,
            T_INTERFACE,
            T_TRAIT,
            T_FUNCTION,
            T_CLOSURE,
            T_PUBLIC,
            T_PRIVATE,
            T_PROTECTED,
            T_FINAL,
            T_STATIC,
            T_ABSTRACT,
            T_CONST,
            T_PROPERTY,
            T_INCLUDE,
            T_INCLUDE_ONCE,
            T_REQUIRE,
            T_REQUIRE_ONCE,
        ];

        if (in_array($tokens[$nextToken]['code'], $ignore) === true) {
            $phpcsFile->addError('Missing file doc comment', $stackPtr, 'Missing');
            $phpcsFile->recordMetric($stackPtr, 'File has doc comment', 'no');
            return ($phpcsFile->numTokens + 1);
        }

        $phpcsFile->recordMetric($stackPtr, 'File has doc comment', 'yes');

        // No blank line between the open tag and the file comment.
        if ($tokens[$commentStart]['line'] > ($tokens[$stackPtr]['line'] + 1)) {
            $error = 'There must be no blank lines before the file comment';
            $phpcsFile->addError($error, $stackPtr, 'SpacingAfterOpen');
        }

        // Exactly one blank line after the file comment.
        $next = $phpcsFile->findNext(T_WHITESPACE, ($commentEnd + 1), null, true);
        if ($tokens[$next]['line'] !== ($tokens[$commentEnd]['line'] + 2)) {
            $error = 'There must be exactly one blank line after the file comment';
            $phpcsFile->addError($error, $commentEnd, 'SpacingAfterComment');
        }

        // Ignore the rest of the file.
        return ($phpcsFile->numTokens + 1);
    }
public function process(File $phpcsFile, $stackPtr)
    {
        $tokens       = $phpcsFile->getTokens();
        $commentStart = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);

        if ($tokens[$commentStart]['code'] === T_COMMENT) {
            $phpcsFile->addError('You must use "/**" style comments for a file comment', $commentStart, 'WrongStyle');
            $phpcsFile->recordMetric($stackPtr, 'File has doc comment', 'yes');
            return ($phpcsFile->numTokens + 1);
        } else if ($commentStart === false || $tokens[$commentStart]['code'] !== T_DOC_COMMENT_OPEN_TAG) {
            $phpcsFile->addError('Missing file doc comment', $stackPtr, 'Missing');
            $phpcsFile->recordMetric($stackPtr, 'File has doc comment', 'no');
            return ($phpcsFile->numTokens + 1);
        }

        if (isset($tokens[$commentStart]['comment_closer']) === false
            || ($tokens[$tokens[$commentStart]['comment_closer']]['content'] === ''
            && $tokens[$commentStart]['comment_closer'] === ($phpcsFile->numTokens - 1))
        ) {
            // Don't process an unfinished file comment during live coding.
            return ($phpcsFile->numTokens + 1);
        }

        $commentEnd = $tokens[$commentStart]['comment_closer'];

        $nextToken = $phpcsFile->findNext(
            T_WHITESPACE,
            ($commentEnd + 1),
            null,
            true
        );

        $ignore = [
            T_CLASS,
            T_INTERFACE,
            T_TRAIT,
            T_FUNCTION,
            T_CLOSURE,
            T_PUBLIC,
            T_PRIVATE,
            T_PROTECTED,
            T_FINAL,
            T_STATIC,
            T_ABSTRACT,
            T_CONST,
            T_PROPERTY,
            T_INCLUDE,
            T_INCLUDE_ONCE,
            T_REQUIRE,
            T_REQUIRE_ONCE,
        ];

        if (in_array($tokens[$nextToken]['code'], $ignore) === true) {
            $phpcsFile->addError('Missing file doc comment', $stackPtr, 'Missing');
            $phpcsFile->recordMetric($stackPtr, 'File has doc comment', 'no');
            return ($phpcsFile->numTokens + 1);
        }

        $phpcsFile->recordMetric($stackPtr, 'File has doc comment', 'yes');

        // No blank line between the open tag and the file comment.
        if ($tokens[$commentStart]['line'] > ($tokens[$stackPtr]['line'] + 1)) {
            $error = 'There must be no blank lines before the file comment';
            $phpcsFile->addError($error, $stackPtr, 'SpacingAfterOpen');
        }

        // Exactly one blank line after the file comment.
        $next = $phpcsFile->findNext(T_WHITESPACE, ($commentEnd + 1), null, true);
        if ($tokens[$next]['line'] !== ($tokens[$commentEnd]['line'] + 2)) {
            $error = 'There must be exactly one blank line after the file comment';
            $phpcsFile->addError($error, $commentEnd, 'SpacingAfterComment');
        }

        // Ignore the rest of the file.
        return ($phpcsFile->numTokens + 1);
    }
public function process ( File $ phpcsFile , $ stackPtr ) { $ tokens = $ phpcsFile -> getTokens ( ) ; $ commentStart = $ phpcsFile -> findNext ( T_WHITESPACE , ( $ stackPtr + 1 ) , null , true ) ; if ( $ tokens [ $ commentStart ] [ 'code' ] === T_COMMENT ) { $ phpcsFile -> addError ( 'You must use "/**" style comments for a file comment' , $ commentStart , 'WrongStyle' ) ; $ phpcsFile -> recordMetric ( $ stackPtr , 'File has doc comment' , 'yes' ) ; return ( $ phpcsFile -> numTokens + 1 ) ; } else if ( $ commentStart === false || $ tokens [ $ commentStart ] [ 'code' ] !== T_DOC_COMMENT_OPEN_TAG ) { $ phpcsFile -> addError ( 'Missing file doc comment' , $ stackPtr , 'Missing' ) ; $ phpcsFile -> recordMetric ( $ stackPtr , 'File has doc comment' , 'no' ) ; return ( $ phpcsFile -> numTokens + 1 ) ; } if ( isset ( $ tokens [ $ commentStart ] [ 'comment_closer' ] ) === false || ( $ tokens [ $ tokens [ $ commentStart ] [ 'comment_closer' ] ] [ 'content' ] === '' && $ tokens [ $ commentStart ] [ 'comment_closer' ] === ( $ phpcsFile -> numTokens - 1 ) ) ) { // Don't process an unfinished file comment during live coding. return ( $ phpcsFile -> numTokens + 1 ) ; } $ commentEnd = $ tokens [ $ commentStart ] [ 'comment_closer' ] ; $ nextToken = $ phpcsFile -> findNext ( T_WHITESPACE , ( $ commentEnd + 1 ) , null , true ) ; $ ignore = [ T_CLASS , T_INTERFACE , T_TRAIT , T_FUNCTION , T_CLOSURE , T_PUBLIC , T_PRIVATE , T_PROTECTED , T_FINAL , T_STATIC , T_ABSTRACT , T_CONST , T_PROPERTY , T_INCLUDE , T_INCLUDE_ONCE , T_REQUIRE , T_REQUIRE_ONCE , ] ; if ( in_array ( $ tokens [ $ nextToken ] [ 'code' ] , $ ignore ) === true ) { $ phpcsFile -> addError ( 'Missing file doc comment' , $ stackPtr , 'Missing' ) ; $ phpcsFile -> recordMetric ( $ stackPtr , 'File has doc comment' , 'no' ) ; return ( $ phpcsFile -> numTokens + 1 ) ; } $ phpcsFile -> recordMetric ( $ stackPtr , 'File has doc comment' , 'yes' ) ; // No blank line between the open tag and the file comment. if ( $ tokens [ $ commentStart ] [ 'line' ] > ( $ tokens [ $ stackPtr ] [ 'line' ] + 1 ) ) { $ error = 'There must be no blank lines before the file comment' ; $ phpcsFile -> addError ( $ error , $ stackPtr , 'SpacingAfterOpen' ) ; } // Exactly one blank line after the file comment. $ next = $ phpcsFile -> findNext ( T_WHITESPACE , ( $ commentEnd + 1 ) , null , true ) ; if ( $ tokens [ $ next ] [ 'line' ] !== ( $ tokens [ $ commentEnd ] [ 'line' ] + 2 ) ) { $ error = 'There must be exactly one blank line after the file comment' ; $ phpcsFile -> addError ( $ error , $ commentEnd , 'SpacingAfterComment' ) ; } // Ignore the rest of the file. return ( $ phpcsFile -> numTokens + 1 ) ; }
{@inheritdoc}
{