phpbb-extensions/boardrules

View on GitHub
acp/boardrules_module.php

Summary

Maintainability
A
3 hrs
Test Coverage

Method main has 56 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function main($id, $mode)
    {
        global $phpbb_container;

        /** @var \phpbb\language\language $lang */
Severity: Major
Found in acp/boardrules_module.php - About 2 hrs to fix

    Function main has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

        public function main($id, $mode)
        {
            global $phpbb_container;
    
            /** @var \phpbb\language\language $lang */
    Severity: Minor
    Found in acp/boardrules_module.php - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    The method main() has 108 lines of code. Current threshold is set to 100. Avoid really long methods.
    Open

        public function main($id, $mode)
        {
            global $phpbb_container;
    
            /** @var \phpbb\language\language $lang */
    Severity: Minor
    Found in acp/boardrules_module.php by phpmd

    The method main() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
    Open

        public function main($id, $mode)
        {
            global $phpbb_container;
    
            /** @var \phpbb\language\language $lang */
    Severity: Minor
    Found in acp/boardrules_module.php by phpmd

    CyclomaticComplexity

    Since: 0.1

    Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

    Example

    // Cyclomatic Complexity = 11
    class Foo {
    1   public function example() {
    2       if ($a == $b) {
    3           if ($a1 == $b1) {
                    fiddle();
    4           } elseif ($a2 == $b2) {
                    fiddle();
                } else {
                    fiddle();
                }
    5       } elseif ($c == $d) {
    6           while ($c == $d) {
                    fiddle();
                }
    7        } elseif ($e == $f) {
    8           for ($n = 0; $n < $h; $n++) {
                    fiddle();
                }
            } else {
                switch ($z) {
    9               case 1:
                        fiddle();
                        break;
    10              case 2:
                        fiddle();
                        break;
    11              case 3:
                        fiddle();
                        break;
                    default:
                        fiddle();
                        break;
                }
            }
        }
    }

    Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

    Avoid unused parameters such as '$id'.
    Open

        public function main($id, $mode)
    Severity: Minor
    Found in acp/boardrules_module.php by phpmd

    UnusedFormalParameter

    Since: 0.2

    Avoid passing parameters to methods or constructors and then not using those parameters.

    Example

    class Foo
    {
        private function bar($howdy)
        {
            // $howdy is not used
        }
    }

    Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

    The method main uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                    {
                        $admin_controller->display_rules($language, $parent_id);
                    }
    Severity: Minor
    Found in acp/boardrules_module.php by phpmd

    ElseExpression

    Since: 1.4.0

    An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($flag) {
                // one branch
            } else {
                // another branch
            }
        }
    }

    Source https://phpmd.org/rules/cleancode.html#elseexpression

    There are no issues that match your filters.

    Category
    Status