librenms/librenms

View on GitHub
LibreNMS/Alert/AlertUtil.php

Summary

Maintainability
D
1 day
Test Coverage

Function getContacts has a Cognitive Complexity of 61 (exceeds 5 allowed). Consider refactoring.
Open

    public static function getContacts($results)
    {
        if (empty($results)) {
            return [];
        }
Severity: Minor
Found in LibreNMS/Alert/AlertUtil.php - About 1 day 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 getContacts has 85 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function getContacts($results)
    {
        if (empty($results)) {
            return [];
        }
Severity: Major
Found in LibreNMS/Alert/AlertUtil.php - About 3 hrs to fix

    Function runMacros has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        public static function runMacros($rule, $x = 1)
        {
            $macros = Config::get('alert.macros.rule', []) .
            krsort($macros);
            foreach ($macros as $macro => $value) {
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php - About 35 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 getContacts() has an NPath complexity of 6336000. The configured NPath complexity threshold is 200.
    Open

        public static function getContacts($results)
        {
            if (empty($results)) {
                return [];
            }
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpmd

    Since: PHPMD 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: http://phpmd.org/rules/codesize.txt

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

        public static function getContacts($results)
        {
            if (empty($results)) {
                return [];
            }
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpmd

    Since: PHPMD 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: http://phpmd.org/rules/codesize.txt

    Avoid unused local variables such as '$tmp_name'.
    Open

                foreach ($tmp_contacts as $tmp_email => $tmp_name) {
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpmd

    Since: PHPMD 0.2

    Detects when a local variable is declared and/or assigned, but not used.

    Example:

    class Foo {
          public function doSomething()
          {
              $i = 5; // Unused
          }
      }

    Source: http://phpmd.org/rules/unusedcode.txt

    The method getContacts uses an else expression. Else is never necessary and you can simplify the code to work without else.
    Open

                        } else {
                            $tmpa = dbFetchCell('SELECT sysContact FROM devices WHERE device_id = ?', [$result['device_id']]);
                        }
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpmd

    Since: PHPMD 1.4.0

    An if expression with an else branch is never necessary. You can rewrite the conditions in a way that the else is not necessary and the code becomes simpler to read. To achieve this use early return statements. To achieve this 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: http://phpmd.org/rules/cleancode.txt

    The method runMacros uses an else expression. Else is never necessary and you can simplify the code to work without else.
    Open

                } else {
                    return false;
                }
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpmd

    Since: PHPMD 1.4.0

    An if expression with an else branch is never necessary. You can rewrite the conditions in a way that the else is not necessary and the code becomes simpler to read. To achieve this use early return statements. To achieve this 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: http://phpmd.org/rules/cleancode.txt

    The method getContacts uses an else expression. Else is never necessary and you can simplify the code to work without else.
    Open

                } else {
                    $tmp_contacts[$email] = $name;
                }
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpmd

    Since: PHPMD 1.4.0

    An if expression with an else branch is never necessary. You can rewrite the conditions in a way that the else is not necessary and the code becomes simpler to read. To achieve this use early return statements. To achieve this 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: http://phpmd.org/rules/cleancode.txt

    Avoid variables with short names like $x. Configured minimum length is 3.
    Open

        public static function runMacros($rule, $x = 1)
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpmd

    Since: PHPMD 0.2

    Detects when a field, local, or parameter has a very short name.

    Example:

    class Something {
          private $q = 15; // VIOLATION - Field
          public static function main( array $as ) { // VIOLATION - Formal
              $r = 20 + $this->q; // VIOLATION - Local
              for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                  $r += $this->q;
              }
          }
      }

    Source: http://phpmd.org/rules/naming.txt

    There are no issues that match your filters.

    Category
    Status