librenms/librenms

View on GitHub
LibreNMS/Device/Processor.php

Summary

Maintainability
A
3 hrs
Test Coverage

Method discover has 10 arguments (exceeds 4 allowed). Consider refactoring.
Open

        $type,
        $device_id,
        $oid,
        $index,
        $description = 'Processor',
Severity: Major
Found in LibreNMS/Device/Processor.php - About 1 hr to fix

    Method discover has 28 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static function discover(
            $type,
            $device_id,
            $oid,
            $index,
    Severity: Minor
    Found in LibreNMS/Device/Processor.php - About 1 hr to fix

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

          public static function poll(OS $os)
          {
              $processors = dbFetchRows('SELECT * FROM processors WHERE device_id=?', [$os->getDeviceId()]);
      
              if ($os instanceof ProcessorPolling) {
      Severity: Minor
      Found in LibreNMS/Device/Processor.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

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

          private static function pollProcessors(OS $os, $processors)
          {
              if (empty($processors)) {
                  return [];
              }
      Severity: Minor
      Found in LibreNMS/Device/Processor.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 discover has 10 parameters. Consider reducing the number of parameters to less than 10.
      Open

          public static function discover(
              $type,
              $device_id,
              $oid,
              $index,
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      Avoid using undefined variables such as '$processor_descr' which will lead to PHP notices.
      Open

                      echo "$processor_descr: $usage%\n";
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      UndefinedVariable

      Since: 2.8.0

      Detects when a variable is used that has not been defined before.

      Example

      class Foo
      {
          private function bar()
          {
              // $message is undefined
              echo $message;
          }
      }

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

      Avoid using undefined variables such as '$processor_index' which will lead to PHP notices.
      Open

                      $rrd_name = ['processor', $processor_type, $processor_index];
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      UndefinedVariable

      Since: 2.8.0

      Detects when a variable is used that has not been defined before.

      Example

      class Foo
      {
          private function bar()
          {
              // $message is undefined
              echo $message;
          }
      }

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

      Avoid using undefined variables such as '$processor_usage' which will lead to PHP notices.
      Open

                      if ($usage != $processor_usage) {
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      UndefinedVariable

      Since: 2.8.0

      Detects when a variable is used that has not been defined before.

      Example

      class Foo
      {
          private function bar()
          {
              // $message is undefined
              echo $message;
          }
      }

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

      Avoid using undefined variables such as '$processor_id' which will lead to PHP notices.
      Open

                  if (array_key_exists($processor_id, $data)) {
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      UndefinedVariable

      Since: 2.8.0

      Detects when a variable is used that has not been defined before.

      Example

      class Foo
      {
          private function bar()
          {
              // $message is undefined
              echo $message;
          }
      }

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

      Avoid using undefined variables such as '$processor_id' which will lead to PHP notices.
      Open

                          dbUpdate(['processor_usage' => $usage], 'processors', '`processor_id` = ?', [$processor_id]);
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      UndefinedVariable

      Since: 2.8.0

      Detects when a variable is used that has not been defined before.

      Example

      class Foo
      {
          private function bar()
          {
              // $message is undefined
              echo $message;
          }
      }

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

      Avoid using undefined variables such as '$processor_type' which will lead to PHP notices.
      Open

                      $rrd_name = ['processor', $processor_type, $processor_index];
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      UndefinedVariable

      Since: 2.8.0

      Detects when a variable is used that has not been defined before.

      Example

      class Foo
      {
          private function bar()
          {
              // $message is undefined
              echo $message;
          }
      }

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

      Avoid using undefined variables such as '$processor_id' which will lead to PHP notices.
      Open

                      $usage = round($data[$processor_id], 2);
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      UndefinedVariable

      Since: 2.8.0

      Detects when a variable is used that has not been defined before.

      Example

      class Foo
      {
          private function bar()
          {
              // $message is undefined
              echo $message;
          }
      }

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

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

              } else {
                  $data = static::pollProcessors($os, $processors);
              }
      Severity: Minor
      Found in LibreNMS/Device/Processor.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

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

                  } else {
                      $value = 0;
                  }
      Severity: Minor
      Found in LibreNMS/Device/Processor.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 unused local variables such as '$index'.
      Open

              foreach ($processors as $index => $processor) {
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      UnusedLocalVariable

      Since: 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 https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

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

                      if ($usage != $processor_usage) {
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      UnusedLocalVariable

      Since: 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 https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

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

                      echo "$processor_descr: $usage%\n";
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      UnusedLocalVariable

      Since: 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 https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

      TODO found
      Open

              // don't fetch too many at a time TODO build into snmp_get_multi_oid?
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by fixme

      TODO found
      Open

              parent::onDelete($processor); // TODO: Change the autogenerated stub
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by fixme

      The property $processor_precision is not named in camelCase.
      Open

      class Processor extends Model implements DiscoveryModule, PollerModule, DiscoveryItem
      {
          protected static $table = 'processors';
          protected static $primaryKey = 'processor_id';
      
      
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      CamelCasePropertyName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name attributes.

      Example

      class ClassName {
          protected $property_name;
      }

      Source

      The property $processor_id is not named in camelCase.
      Open

      class Processor extends Model implements DiscoveryModule, PollerModule, DiscoveryItem
      {
          protected static $table = 'processors';
          protected static $primaryKey = 'processor_id';
      
      
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      CamelCasePropertyName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name attributes.

      Example

      class ClassName {
          protected $property_name;
      }

      Source

      The property $processor_usage is not named in camelCase.
      Open

      class Processor extends Model implements DiscoveryModule, PollerModule, DiscoveryItem
      {
          protected static $table = 'processors';
          protected static $primaryKey = 'processor_id';
      
      
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      CamelCasePropertyName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name attributes.

      Example

      class ClassName {
          protected $property_name;
      }

      Source

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

          public static function processYaml(OS $os)
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      ShortVariable

      Since: 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 https://phpmd.org/rules/naming.html#shortvariable

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

          public static function runDiscovery(OS $os)
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      ShortVariable

      Since: 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 https://phpmd.org/rules/naming.html#shortvariable

      The property $processor_type is not named in camelCase.
      Open

      class Processor extends Model implements DiscoveryModule, PollerModule, DiscoveryItem
      {
          protected static $table = 'processors';
          protected static $primaryKey = 'processor_id';
      
      
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      CamelCasePropertyName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name attributes.

      Example

      class ClassName {
          protected $property_name;
      }

      Source

      The property $processor_perc_warn is not named in camelCase.
      Open

      class Processor extends Model implements DiscoveryModule, PollerModule, DiscoveryItem
      {
          protected static $table = 'processors';
          protected static $primaryKey = 'processor_id';
      
      
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      CamelCasePropertyName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name attributes.

      Example

      class ClassName {
          protected $property_name;
      }

      Source

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

          public static function poll(OS $os)
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      ShortVariable

      Since: 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 https://phpmd.org/rules/naming.html#shortvariable

      The property $processor_descr is not named in camelCase.
      Open

      class Processor extends Model implements DiscoveryModule, PollerModule, DiscoveryItem
      {
          protected static $table = 'processors';
          protected static $primaryKey = 'processor_id';
      
      
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      CamelCasePropertyName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name attributes.

      Example

      class ClassName {
          protected $property_name;
      }

      Source

      The property $processor_oid is not named in camelCase.
      Open

      class Processor extends Model implements DiscoveryModule, PollerModule, DiscoveryItem
      {
          protected static $table = 'processors';
          protected static $primaryKey = 'processor_id';
      
      
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      CamelCasePropertyName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name attributes.

      Example

      class ClassName {
          protected $property_name;
      }

      Source

      The property $processor_index is not named in camelCase.
      Open

      class Processor extends Model implements DiscoveryModule, PollerModule, DiscoveryItem
      {
          protected static $table = 'processors';
          protected static $primaryKey = 'processor_id';
      
      
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      CamelCasePropertyName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name attributes.

      Example

      class ClassName {
          protected $property_name;
      }

      Source

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

          public static function fromYaml(OS $os, $index, array $data)
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      ShortVariable

      Since: 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 https://phpmd.org/rules/naming.html#shortvariable

      The property $device_id is not named in camelCase.
      Open

      class Processor extends Model implements DiscoveryModule, PollerModule, DiscoveryItem
      {
          protected static $table = 'processors';
          protected static $primaryKey = 'processor_id';
      
      
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      CamelCasePropertyName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name attributes.

      Example

      class ClassName {
          protected $property_name;
      }

      Source

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

          private static function pollProcessors(OS $os, $processors)
      Severity: Minor
      Found in LibreNMS/Device/Processor.php by phpmd

      ShortVariable

      Since: 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 https://phpmd.org/rules/naming.html#shortvariable

      There are no issues that match your filters.

      Category
      Status