hnhdigital-os/laravel-navigation-builder

View on GitHub
src/Menu.php

Summary

Maintainability
C
1 day
Test Coverage

Menu has 35 functions (exceeds 20 allowed). Consider refactoring.
Open

class Menu
{
    /**
     * Item collection.
     *
Severity: Minor
Found in src/Menu.php - About 4 hrs to fix

    The class Menu has 24 public methods. Consider refactoring Menu to keep number of public methods under 10.
    Open

    class Menu
    {
        /**
         * Item collection.
         *
    Severity: Minor
    Found in src/Menu.php by phpmd

    TooManyPublicMethods

    Since: 0.1

    A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

    By default it ignores methods starting with 'get' or 'set'.

    Example

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

    The class Menu has 26 non-getter- and setter-methods. Consider refactoring Menu to keep number of methods under 25.
    Open

    class Menu
    {
        /**
         * Item collection.
         *
    Severity: Minor
    Found in src/Menu.php by phpmd

    TooManyMethods

    Since: 0.1

    A class with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

    By default it ignores methods starting with 'get' or 'set'.

    The default was changed from 10 to 25 in PHPMD 2.3.

    Example

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

    The class Menu has an overall complexity of 70 which is very high. The configured complexity threshold is 50.
    Open

    class Menu
    {
        /**
         * Item collection.
         *
    Severity: Minor
    Found in src/Menu.php by phpmd

    File Menu.php has 261 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    
    /*
     * This file is part of Laravel Navigation Builder.
     *
    Severity: Minor
    Found in src/Menu.php - About 2 hrs to fix

      Method __call has 32 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function __call($name, $arguments)
          {
              // $this->whereTitle(...)
              preg_match('/^[W|w]here([a-zA-Z0-9_]+)$/', $name, $matches);
      
      
      Severity: Minor
      Found in src/Menu.php - About 1 hr to fix

        Function __call has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

            public function __call($name, $arguments)
            {
                // $this->whereTitle(...)
                preg_match('/^[W|w]here([a-zA-Z0-9_]+)$/', $name, $matches);
        
        
        Severity: Minor
        Found in src/Menu.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

        Avoid too many return statements within this method.
        Open

                return $this;
        Severity: Major
        Found in src/Menu.php - About 30 mins to fix

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

              public function __call($name, $arguments)
              {
                  // $this->whereTitle(...)
                  preg_match('/^[W|w]here([a-zA-Z0-9_]+)$/', $name, $matches);
          
          
          Severity: Minor
          Found in src/Menu.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 __construct has a boolean flag argument $collections, which is a certain sign of a Single Responsibility Principle violation.
          Open

              public function __construct($name, $collections = false)
          Severity: Minor
          Found in src/Menu.php by phpmd

          BooleanArgumentFlag

          Since: 1.4.0

          A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

          Example

          class Foo {
              public function bar($flag = true) {
              }
          }

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

          The method render has a boolean flag argument $parent_id, which is a certain sign of a Single Responsibility Principle violation.
          Open

              public function render($parent_id = false)
          Severity: Minor
          Found in src/Menu.php by phpmd

          BooleanArgumentFlag

          Since: 1.4.0

          A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

          Example

          class Foo {
              public function bar($flag = true) {
              }
          }

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

          The method filter has a boolean flag argument $include_children, which is a certain sign of a Single Responsibility Principle violation.
          Open

              public function filter($property_name, $value, $include_children = false)
          Severity: Minor
          Found in src/Menu.php by phpmd

          BooleanArgumentFlag

          Since: 1.4.0

          A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

          Example

          class Foo {
              public function bar($flag = true) {
              }
          }

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

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

                  } else {
                      $item = new Item($this, $title);
                  }
          Severity: Minor
          Found in src/Menu.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