librenms/librenms

View on GitHub
LibreNMS/OS/Unifi.php

Summary

Maintainability
B
6 hrs
Test Coverage

Method discoverWirelessClients has 62 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function discoverWirelessClients()
    {
        $client_oids = snmpwalk_cache_oid($this->getDeviceArray(), 'unifiVapNumStations', [], 'UBNT-UniFi-MIB');
        if (empty($client_oids)) {
            return [];
Severity: Major
Found in LibreNMS/OS/Unifi.php - About 2 hrs to fix

    Method discoverWirelessUtilization has 48 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function discoverWirelessUtilization()
        {
            $util_oids = snmpwalk_cache_oid($this->getDeviceArray(), 'unifiRadioCuTotal', [], 'UBNT-UniFi-MIB');
            if (empty($util_oids)) {
                return [];
    Severity: Minor
    Found in LibreNMS/OS/Unifi.php - About 1 hr to fix

      Function discoverWirelessClients has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
      Open

          public function discoverWirelessClients()
          {
              $client_oids = snmpwalk_cache_oid($this->getDeviceArray(), 'unifiVapNumStations', [], 'UBNT-UniFi-MIB');
              if (empty($client_oids)) {
                  return [];
      Severity: Minor
      Found in LibreNMS/OS/Unifi.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

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

                      } else {
                          $ssids[$ssid] = [
                              'oids' => ['.1.3.6.1.4.1.41112.1.6.1.2.1.8.' . $index],
                              'count' => $entry['unifiVapNumStations'],
                          ];
      Severity: Minor
      Found in LibreNMS/OS/Unifi.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 '62', column '19').
      Open

          public function discoverOS(Device $device): void
          {
              // try the Unifi MIB first, then fall back to dot11manufacturer
              if ($data = snmp_getnext_multi($this->getDeviceArray(), ['unifiApSystemModel', 'unifiApSystemVersion'], '-OQUs', 'UBNT-UniFi-MIB')) {
                  $device->hardware = $data['unifiApSystemModel'] ?? $device->hardware;
      Severity: Minor
      Found in LibreNMS/OS/Unifi.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

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

          public function discoverOS(Device $device): void
          {
              // try the Unifi MIB first, then fall back to dot11manufacturer
              if ($data = snmp_getnext_multi($this->getDeviceArray(), ['unifiApSystemModel', 'unifiApSystemVersion'], '-OQUs', 'UBNT-UniFi-MIB')) {
                  $device->hardware = $data['unifiApSystemModel'] ?? $device->hardware;
      Severity: Minor
      Found in LibreNMS/OS/Unifi.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

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

                  } else {
                      $radios[$radio_name]['count'] = $entry['unifiVapNumStations'];
                  }
      Severity: Minor
      Found in LibreNMS/OS/Unifi.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