Add option to disable the check for protected/private function

Author: VincentLanglet

src/Standards/PEAR/Sniffs/Commenting/FunctionCommentSniff.php

@@ -16,6 +16,14 @@
 class FunctionCommentSniff implements Sniff
 {
 
+    /**
+     * Disable the check for functions with a lower visibility than the value given.
+     * Allowed values are public, protected and private.
+     *
+     * @var string
+     */
+    public $minimumVisibility = 'private';
+
 
     /**
      * Returns an array of tokens this test wants to listen for.
@@ -41,16 +49,29 @@ public function register()
     public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
-        $find   = Tokens::$methodPrefixes;
-        $find[] = T_WHITESPACE;
 
-        $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
+        $ignore   = Tokens::$emptyTokens;
+        $ignore[] = T_STATIC;
+
+        $scopeModifier = $phpcsFile->findPrevious($ignore, ($stackPtr - 1), null, true);
+        if ($tokens[$scopeModifier]['code'] === T_PROTECTED
+            && $this->minimumVisibility === 'public'
+            || $tokens[$scopeModifier]['code'] === T_PRIVATE
+            && ($this->minimumVisibility === 'public' || $this->minimumVisibility === 'protected')
+        ) {
+            return;
+        }
+
+        $ignore   = Tokens::$methodPrefixes;
+        $ignore[] = T_WHITESPACE;
+
+        $commentEnd = $phpcsFile->findPrevious($ignore, ($stackPtr - 1), null, true);
         if ($tokens[$commentEnd]['code'] === T_COMMENT) {
             // Inline comments might just be closing comments for
             // control structures or functions instead of function comments
             // using the wrong comment type. If there is other code on the line,
             // assume they relate to that code.
-            $prev = $phpcsFile->findPrevious($find, ($commentEnd - 1), null, true);
+            $prev = $phpcsFile->findPrevious($ignore, ($commentEnd - 1), null, true);
             if ($prev !== false && $tokens[$prev]['line'] === $tokens[$commentEnd]['line']) {
                 $commentEnd = $prev;
             }

src/Standards/PEAR/Tests/Commenting/FunctionCommentUnitTest.inc

@@ -381,3 +381,20 @@ public function setTranslator($a, &$b): void
 {
     $this->translator = $translator;
 }
+
+// phpcs:set PEAR.Commenting.FunctionComment minimumVisibility protected
+private function setTranslator2($a, &$b): void
+{
+    $this->translator = $translator;
+}
+
+// phpcs:set PEAR.Commenting.FunctionComment minimumVisibility public
+protected function setTranslator3($a, &$b): void
+{
+    $this->translator = $translator;
+}
+
+private function setTranslator4($a, &$b): void
+{
+    $this->translator = $translator;
+}

src/Standards/PEAR/Tests/Commenting/FunctionCommentUnitTest.inc.fixed

@@ -381,3 +381,20 @@ public function setTranslator($a, &$b): void
 {
     $this->translator = $translator;
 }
+
+// phpcs:set PEAR.Commenting.FunctionComment minimumVisibility protected
+private function setTranslator2($a, &$b): void
+{
+    $this->translator = $translator;
+}
+
+// phpcs:set PEAR.Commenting.FunctionComment minimumVisibility public
+protected function setTranslator3($a, &$b): void
+{
+    $this->translator = $translator;
+}
+
+private function setTranslator4($a, &$b): void
+{
+    $this->translator = $translator;
+}