librenms/librenms

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

Summary

Maintainability
A
3 hrs
Test Coverage

Method contactBoxcar has 53 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function contactBoxcar($obj, $api)
    {
        $data = [];
        $data['user_credentials'] = $api['access_token'];
        $data['notification[source_name]'] = Config::get('project_id', 'librenms');
Severity: Major
Found in LibreNMS/Alert/Transport/Boxcar.php - About 2 hrs to fix

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

        public static function contactBoxcar($obj, $api)
        {
            $data = [];
            $data['user_credentials'] = $api['access_token'];
            $data['notification[source_name]'] = Config::get('project_id', 'librenms');
    Severity: Minor
    Found in LibreNMS/Alert/Transport/Boxcar.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 contactBoxcar() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10.
    Open

        public static function contactBoxcar($obj, $api)
        {
            $data = [];
            $data['user_credentials'] = $api['access_token'];
            $data['notification[source_name]'] = Config::get('project_id', 'librenms');
    Severity: Minor
    Found in LibreNMS/Alert/Transport/Boxcar.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 parameters such as '$opts'.
    Open

        public function deliverAlert($obj, $opts)
    Severity: Minor
    Found in LibreNMS/Alert/Transport/Boxcar.php by phpmd

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

    FIXME found
    Open

                var_dump('Boxcar returned error'); //FIXME: proper debugging
    Severity: Minor
    Found in LibreNMS/Alert/Transport/Boxcar.php by fixme

    There are no issues that match your filters.

    Category
    Status