phpbb-extensions/boardrules

View on GitHub
controller/main_controller.php

Summary

Maintainability
B
5 hrs
Test Coverage

Method display has 70 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function display()
    {
        // When board rules are disabled, redirect users back to the forum index
        if (empty($this->config['boardrules_enable']))
        {
Severity: Major
Found in controller/main_controller.php - About 2 hrs to fix

    Function display has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

        public function display()
        {
            // When board rules are disabled, redirect users back to the forum index
            if (empty($this->config['boardrules_enable']))
            {
    Severity: Minor
    Found in controller/main_controller.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

    Method __construct has 8 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        public function __construct(\phpbb\config\config $config, \phpbb\controller\helper $helper, \phpbb\language\language $lang, \phpbb\boardrules\operators\rule $rule_operator, \phpbb\template\template $template, \phpbb\user $user, $root_path, $php_ext)
    Severity: Major
    Found in controller/main_controller.php - About 1 hr to fix

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

          public function display()
          {
              // When board rules are disabled, redirect users back to the forum index
              if (empty($this->config['boardrules_enable']))
              {
      Severity: Minor
      Found in controller/main_controller.php by phpmd

      The method display() has an NPath complexity of 450. The configured NPath complexity threshold is 200.
      Open

          public function display()
          {
              // When board rules are disabled, redirect users back to the forum index
              if (empty($this->config['boardrules_enable']))
              {
      Severity: Minor
      Found in controller/main_controller.php by phpmd

      NPathComplexity

      Since: 0.1

      The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

      Example

      class Foo {
          function bar() {
              // lots of complicated code
          }
      }

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

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

          public function display()
          {
              // When board rules are disabled, redirect users back to the forum index
              if (empty($this->config['boardrules_enable']))
              {
      Severity: Minor
      Found in controller/main_controller.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

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

                  {
                      // Rules
                      $is_category = false;
                      $anchor = $entity->get_anchor() ?: $this->lang->lang('BOARDRULES_RULE_ANCHOR', ($cat_counter - 1) . $rule_counter);
      
      
      Severity: Minor
      Found in controller/main_controller.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