Ignore attributes when figuring out if the docblock is file level or …

…code level (ref #3286)
squizlabs · Mar 30, 2021 · d2812fd · d2812fd
1 parent 3decd5e
commit d2812fd
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 2 deletions.
diff --git a/package.xml b/package.xml
@@ -1275,6 +1275,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
         <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.14.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.15.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.16.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.17.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.php" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="ImportStatementUnitTest.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="ImportStatementUnitTest.inc.fixed" role="test" />

diff --git a/src/Standards/PSR12/Sniffs/Files/FileHeaderSniff.php b/src/Standards/PSR12/Sniffs/Files/FileHeaderSniff.php
@@ -166,8 +166,25 @@ public function getHeaderLines(File $phpcsFile, $stackPtr)
                 }
 
                 // Make sure this is not a code-level docblock.
-                $end      = $tokens[$next]['comment_closer'];
-                $docToken = $phpcsFile->findNext(Tokens::$emptyTokens, ($end + 1), null, true);
+                $end = $tokens[$next]['comment_closer'];
+                for ($docToken = ($end + 1); $docToken < $phpcsFile->numTokens; $docToken++) {
+                    if (isset(Tokens::$emptyTokens[$tokens[$docToken]['code']]) === true) {
+                        continue;
+                    }
+
+                    if ($tokens[$docToken]['code'] === T_ATTRIBUTE
+                        && isset($tokens[$docToken]['attribute_closer']) === true
+                    ) {
+                        $docToken = $tokens[$docToken]['attribute_closer'];
+                        continue;
+                    }
+
+                    break;
+                }
+
+                if ($docToken === $phpcsFile->numTokens) {
+                    $docToken--;
+                }
 
                 if (isset($commentOpeners[$tokens[$docToken]['code']]) === false
                     && isset(Tokens::$methodPrefixes[$tokens[$docToken]['code']]) === false

diff --git a/src/Standards/PSR12/Tests/Files/FileHeaderUnitTest.17.inc b/src/Standards/PSR12/Tests/Files/FileHeaderUnitTest.17.inc
@@ -0,0 +1,13 @@
+<?php
+
+namespace project\Controller;
+
+use project\Auth\Authenticate;
+
+/**
+ * Shows open tasks for admins
+ */
+#[Authenticate('admin_logged_in')]
+class TodoController extends AbstractController implements MustBeLoggedInInterface
+{
+}