librenms/librenms

View on GitHub
app/Http/Controllers/Maps/CustomMapDataController.php

Summary

Maintainability
F
3 days
Test Coverage

Function get has a Cognitive Complexity of 47 (exceeds 5 allowed). Consider refactoring.
Open

    public function get(Request $request, CustomMap $map): JsonResponse
    {
        $this->authorize('view', $map);

        $edges = [];
Severity: Minor
Found in app/Http/Controllers/Maps/CustomMapDataController.php - About 7 hrs 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 get has 120 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function get(Request $request, CustomMap $map): JsonResponse
    {
        $this->authorize('view', $map);

        $edges = [];
Severity: Major
Found in app/Http/Controllers/Maps/CustomMapDataController.php - About 4 hrs to fix

    Method save has 93 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function save(Request $request, CustomMap $map): JsonResponse
        {
            $this->authorize('update', $map);
    
            $data = $this->validate($request, [
    Severity: Major
    Found in app/Http/Controllers/Maps/CustomMapDataController.php - About 3 hrs to fix

      File CustomMapDataController.php has 312 lines of code (exceeds 250 allowed). Consider refactoring.
      Open

      <?php
      /**
       * CustomMapController.php
       *
       * Controller for custom maps
      Severity: Minor
      Found in app/Http/Controllers/Maps/CustomMapDataController.php - About 3 hrs to fix

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

        class CustomMapDataController extends Controller
        {
            public function get(Request $request, CustomMap $map): JsonResponse
            {
                $this->authorize('view', $map);

        Function save has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
        Open

            public function save(Request $request, CustomMap $map): JsonResponse
            {
                $this->authorize('update', $map);
        
                $data = $this->validate($request, [
        Severity: Minor
        Found in app/Http/Controllers/Maps/CustomMapDataController.php - About 3 hrs 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

        Function snmpSpeed has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            private function snmpSpeed(string $speeds): int
            {
                // Only succeed if the string startes with a number optionally followed by a unit
                if (preg_match('/^(\d+)([kMGTP])?/', $speeds, $matches)) {
                    $speed = (int) $matches[1];
        Severity: Minor
        Found in app/Http/Controllers/Maps/CustomMapDataController.php - About 45 mins 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 intval($rate / 1000000000000) . ' Tbps';
        Severity: Major
        Found in app/Http/Controllers/Maps/CustomMapDataController.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                      return intval($rate / 1000000000000000) . ' Pbps';
          Severity: Major
          Found in app/Http/Controllers/Maps/CustomMapDataController.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                    return '#FF00FF';
            Severity: Major
            Found in app/Http/Controllers/Maps/CustomMapDataController.php - About 30 mins to fix

              Function rateString has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

                  private function rateString(int $rate): string
                  {
                      if ($rate < 1000) {
                          return $rate . ' bps';
                      } elseif ($rate < 1000000) {
              Severity: Minor
              Found in app/Http/Controllers/Maps/CustomMapDataController.php - About 25 mins 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 get() has 141 lines of code. Current threshold is set to 100. Avoid really long methods.
              Open

                  public function get(Request $request, CustomMap $map): JsonResponse
                  {
                      $this->authorize('view', $map);
              
                      $edges = [];

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

                  public function save(Request $request, CustomMap $map): JsonResponse
                  {
                      $this->authorize('update', $map);
              
                      $data = $this->validate($request, [

              The method get() has an NPath complexity of 6534. The configured NPath complexity threshold is 200.
              Open

                  public function get(Request $request, CustomMap $map): JsonResponse
                  {
                      $this->authorize('view', $map);
              
                      $edges = [];

              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 save() has an NPath complexity of 17199. The configured NPath complexity threshold is 200.
              Open

                  public function save(Request $request, CustomMap $map): JsonResponse
                  {
                      $this->authorize('update', $map);
              
                      $data = $this->validate($request, [

              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 get() has a Cyclomatic Complexity of 20. The configured cyclomatic complexity threshold is 10.
              Open

                  public function get(Request $request, CustomMap $map): JsonResponse
                  {
                      $this->authorize('view', $map);
              
                      $edges = [];

              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 save() has a Cyclomatic Complexity of 19. The configured cyclomatic complexity threshold is 10.
              Open

                  public function save(Request $request, CustomMap $map): JsonResponse
                  {
                      $this->authorize('update', $map);
              
                      $data = $this->validate($request, [

              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 '$request'.
              Open

                  public function get(Request $request, CustomMap $map): JsonResponse

              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 get uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
              Open

                                  } else {
                                      $speedto = $this->snmpSpeed($speed_parts[0]);
                                      $speedfrom = $this->snmpSpeed($speed_parts[1]);
                                  }

              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

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

                              } else {
                                  $device_style = $this->nodeUpStyle();
                              }

              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

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

                              } else {
                                  $dbedge = $dbedges[$edgeid];
                                  if (! $dbedge) {
                                      Log::error('Could not find existing edge for edge id ' . $edgeid);
                                      abort(404);

              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

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

                              } else {
                                  $dbnode = $dbnodes[$nodeid];
                                  if (! $dbnode) {
                                      Log::error('Could not find existing node for node id ' . $nodeid);
                                      abort(404);

              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

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

                      } else {
                          return intval($rate / 1000000000000000) . ' Pbps';
                      }

              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

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

                              } else {
                                  $edges[$edgeid]['port_topct'] = round($rateto / $speedto * 100.0, 2);
                                  $edges[$edgeid]['port_frompct'] = round($ratefrom / $speedfrom * 100.0, 2);
                              }

              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

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

                              } else {
                                  $ratefrom = $edge->port->ifOutOctets_rate * 8;
                                  $rateto = $edge->port->ifInOctets_rate * 8;
                              }

              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

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

                              } else {
                                  $edges[$edgeid]['colour_to'] = $this->speedColour($edges[$edgeid]['port_topct']);
                                  $edges[$edgeid]['colour_from'] = $this->speedColour($edges[$edgeid]['port_frompct']);
                              }

              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