- Added new sniffs for codesniffer to be compliant with the FHComplete coding style

- Commented tests/codesniffer/FHComplete/ruleset.xml - Removed redundant PHPCS checks already performed by PHPMD - Added/removed checks from PHPCS to be compliant with the FHComplete coding style - PHPMD: Removed the ElseExpression rule from the rulesets/cleancode.xml
2026-07-20 00:12:15 +00:00 · 2022-03-04 19:59:57 +01:00
parent d4d1320503
commit 9f28db36b8
6 changed files with 583 additions and 26 deletions
@@ -0,0 +1,129 @@
+<?php
+/**
+ * Checks that the method declaration is correct.
+ *
+ * NOTE: It simply overrides the method processTokenWithinScope of the Standards\PSR2\Sniffs\Methods\MethodDeclarationSniff class
+ *
+ */
+
+namespace PHP_CodeSniffer\Standards\FHComplete\Sniffs\Methods;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\AbstractScopeSniff;
+use PHP_CodeSniffer\Util\Tokens;
+use PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\MethodDeclarationSniff;
+
+class FHCMethodDeclarationSniff extends MethodDeclarationSniff
+{
+    /**
+     * Processes the function tokens within the class.
+     *
+     * NOTE: it does not check if the method name starts with an underscore "_"
+     *
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
+     * @param int                         $stackPtr  The position where the token was found.
+     * @param int                         $currScope The current scope opener token.
+     *
+     * @return void
+     */
+    protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope)
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        // Determine if this is a function which needs to be examined.
+        $conditions = $tokens[$stackPtr]['conditions'];
+        end($conditions);
+        $deepestScope = key($conditions);
+        if ($deepestScope !== $currScope) {
+            return;
+        }
+
+        $methodName = $phpcsFile->getDeclarationName($stackPtr);
+        if ($methodName === null) {
+            // Ignore closures.
+            return;
+        }
+
+        $visibility = 0;
+        $static     = 0;
+        $abstract   = 0;
+        $final      = 0;
+
+        $find = (Tokens::$methodPrefixes + Tokens::$emptyTokens);
+        $prev = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
+
+        $prefix = $stackPtr;
+        while (($prefix = $phpcsFile->findPrevious(Tokens::$methodPrefixes, ($prefix - 1), $prev)) !== false) {
+            switch ($tokens[$prefix]['code']) {
+            case T_STATIC:
+                $static = $prefix;
+                break;
+            case T_ABSTRACT:
+                $abstract = $prefix;
+                break;
+            case T_FINAL:
+                $final = $prefix;
+                break;
+            default:
+                $visibility = $prefix;
+                break;
+            }
+        }
+
+        $fixes = [];
+
+        if ($visibility !== 0 && $final > $visibility) {
+            $error = 'The final declaration must precede the visibility declaration';
+            $fix   = $phpcsFile->addFixableError($error, $final, 'FinalAfterVisibility');
+            if ($fix === true) {
+                $fixes[$final]       = '';
+                $fixes[($final + 1)] = '';
+                if (isset($fixes[$visibility]) === true) {
+                    $fixes[$visibility] = 'final '.$fixes[$visibility];
+                } else {
+                    $fixes[$visibility] = 'final '.$tokens[$visibility]['content'];
+                }
+            }
+        }
+
+        if ($visibility !== 0 && $abstract > $visibility) {
+            $error = 'The abstract declaration must precede the visibility declaration';
+            $fix   = $phpcsFile->addFixableError($error, $abstract, 'AbstractAfterVisibility');
+            if ($fix === true) {
+                $fixes[$abstract]       = '';
+                $fixes[($abstract + 1)] = '';
+                if (isset($fixes[$visibility]) === true) {
+                    $fixes[$visibility] = 'abstract '.$fixes[$visibility];
+                } else {
+                    $fixes[$visibility] = 'abstract '.$tokens[$visibility]['content'];
+                }
+            }
+        }
+
+        if ($static !== 0 && $static < $visibility) {
+            $error = 'The static declaration must come after the visibility declaration';
+            $fix   = $phpcsFile->addFixableError($error, $static, 'StaticBeforeVisibility');
+            if ($fix === true) {
+                $fixes[$static]       = '';
+                $fixes[($static + 1)] = '';
+                if (isset($fixes[$visibility]) === true) {
+                    $fixes[$visibility] .= ' static';
+                } else {
+                    $fixes[$visibility] = $tokens[$visibility]['content'].' static';
+                }
+            }
+        }
+
+        // Batch all the fixes together to reduce the possibility of conflicts.
+        if (empty($fixes) === false) {
+            $phpcsFile->fixer->beginChangeset();
+            foreach ($fixes as $stackPtr => $content) {
+                $phpcsFile->fixer->replaceToken($stackPtr, $content);
+            }
+
+            $phpcsFile->fixer->endChangeset();
+        }
+
+    }//end processTokenWithinScope()
+}//end class
+