librenms/librenms

View on GitHub
LibreNMS/Alert/Transport/Syslog.php

Summary

Maintainability
C
1 day
Test Coverage

Method contactSyslog has 73 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function contactSyslog(array $alert_data): bool
    {
        $syslog_host = '127.0.0.1';
        $syslog_port = 514;
        $state = 'Unknown';
Severity: Major
Found in LibreNMS/Alert/Transport/Syslog.php - About 2 hrs to fix

    Function contactSyslog has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
    Open

        public function contactSyslog(array $alert_data): bool
        {
            $syslog_host = '127.0.0.1';
            $syslog_port = 514;
            $state = 'Unknown';
    Severity: Minor
    Found in LibreNMS/Alert/Transport/Syslog.php - About 2 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 configTemplate has 27 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static function configTemplate(): array
        {
            return [
                'config' => [
                    [
    Severity: Minor
    Found in LibreNMS/Alert/Transport/Syslog.php - About 1 hr to fix

      The method contactSyslog() has an NPath complexity of 576. The configured NPath complexity threshold is 200.
      Open

          public function contactSyslog(array $alert_data): bool
          {
              $syslog_host = '127.0.0.1';
              $syslog_port = 514;
              $state = 'Unknown';
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Syslog.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 contactSyslog() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10.
      Open

          public function contactSyslog(array $alert_data): bool
          {
              $syslog_host = '127.0.0.1';
              $syslog_port = 514;
              $state = 'Unknown';
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Syslog.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 contactSyslog uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              } else {
                  $syslog_msg = $syslog_prefix;
                  socket_sendto($socket, $syslog_msg, strlen($syslog_msg), 0, $syslog_host, $syslog_port);
              }
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Syslog.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

      Avoid assigning values to variables in if clauses and the like (line '100', column '14').
      Open

          public function contactSyslog(array $alert_data): bool
          {
              $syslog_host = '127.0.0.1';
              $syslog_port = 514;
              $state = 'Unknown';
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Syslog.php by phpmd

      IfStatementAssignment

      Since: 2.7.0

      Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

      Example

      class Foo
      {
          public function bar($flag)
          {
              if ($foo = 'bar') { // possible typo
                  // ...
              }
              if ($baz = 0) { // always false
                  // ...
              }
          }
      }

      Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

              if (! empty($alert_data['faults'])) {
                  foreach ($alert_data['faults'] as $fault) {
                      $syslog_msg = $syslog_prefix . ' - ' . $fault['string'];
                      socket_sendto($socket, $syslog_msg, strlen($syslog_msg), 0, $syslog_host, $syslog_port);
                  }
      Severity: Major
      Found in LibreNMS/Alert/Transport/Syslog.php and 1 other location - About 1 hr to fix
      LibreNMS/Alert/Transport/Splunk.php on lines 75..83

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 116.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

          public static function configTemplate(): array
          {
              return [
                  'config' => [
                      [
      Severity: Major
      Found in LibreNMS/Alert/Transport/Syslog.php and 1 other location - About 1 hr to fix
      LibreNMS/Alert/Transport/Gitlab.php on lines 61..90

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 107.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      There are no issues that match your filters.

      Category
      Status