Dont require docblocks for fully typed methods.

Author: dereuromark

PhpCollective/Sniffs/Commenting/DocBlockSniff.php

@@ -14,7 +14,7 @@
 use PhpCollective\Traits\SignatureTrait;
 
 /**
- * Methods always need doc blocks.
+ * Methods always need doc blocks if they are using non-typed params/return.
  * Constructor and destructor may not have one if they do not have arguments.
  */
 class DocBlockSniff extends AbstractSniff
@@ -60,6 +60,10 @@ public function process(File $phpcsFile, $stackPtr): void
             return;
         }
 
+        if ($this->isFullyTyped($phpcsFile, $stackPtr)) {
+            return;
+        }
+
         // We only look for void methods right now
         $returnType = $this->detectReturnTypeVoid($phpcsFile, $stackPtr);
         if ($returnType === null) {
@@ -133,31 +137,6 @@ protected function checkConstructorAndDestructor(File $phpcsFile, int $stackPtr)
         $phpcsFile->addError('Missing doc block for method', $stackPtr, 'ConstructDesctructMissingDocBlock');
     }
 
-    /**
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile
-     * @param int $docBlockStartIndex
-     * @param int $docBlockEndIndex
-     *
-     * @return int|null
-     */
-    protected function findDocBlockReturn(File $phpcsFile, int $docBlockStartIndex, int $docBlockEndIndex): ?int
-    {
-        $tokens = $phpcsFile->getTokens();
-
-        for ($i = $docBlockStartIndex + 1; $i < $docBlockEndIndex; $i++) {
-            if (!$this->isGivenKind(T_DOC_COMMENT_TAG, $tokens[$i])) {
-                continue;
-            }
-            if ($tokens[$i]['content'] !== '@return') {
-                continue;
-            }
-
-            return $i;
-        }
-
-        return null;
-    }
-
     /**
      * For right now we only try to detect void.
      *
@@ -202,4 +181,36 @@ protected function detectReturnTypeVoid(File $phpcsFile, int $index): ?string
 
         return $type;
     }
+
+    /**
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile
+     * @param int $stackPtr
+     *
+     * @return bool
+     */
+    protected function isFullyTyped(File $phpcsFile, int $stackPtr): bool
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        // Get the function's parameter tokens
+        $params = $phpcsFile->getMethodParameters($stackPtr);
+        // Check all parameters have a type hint
+        foreach ($params as $param) {
+            if (empty($param['type_hint'])) {
+                return false;
+            }
+        }
+
+        // Check for return type
+        $hasReturnType = isset($tokens[$stackPtr]['parenthesis_closer']) &&
+            isset($tokens[$stackPtr]['scope_opener']);
+
+        $colonPtr = $phpcsFile->findNext(T_COLON, $tokens[$stackPtr]['parenthesis_closer'], $tokens[$stackPtr]['scope_opener']);
+
+        if ($colonPtr === false) {
+            return false; // No return type
+        }
+
+        return true;
+    }
 }