Sign upLogin

howardjones/network-weathermap

View on GitHub
Star
lib/Weathermap/Plugins/Datasources/CactiDSStats.php

Summary

Maintainability
D
2 days
Test Coverage

Function readData has a Cognitive Complexity of 48 (exceeds 5 allowed). Consider refactoring.
Open

    public function readData($targetString, &$map, &$mapItem)
    {
        $this->data[IN] = null;
        $this->data[OUT] = null;
        $pdo = weathermap_get_pdo();
Severity: Minor
Found in lib/Weathermap/Plugins/Datasources/CactiDSStats.php - About 7 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 readData has 103 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function readData($targetString, &$map, &$mapItem)
    {
        $this->data[IN] = null;
        $this->data[OUT] = null;
        $pdo = weathermap_get_pdo();
Severity: Major
Found in lib/Weathermap/Plugins/Datasources/CactiDSStats.php - About 4 hrs to fix

    Function init has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
    Open

        public function init(&$map)
    {
        if ($map->context == 'cacti') {
            if (!function_exists('db_fetch_assoc')) {
                MapUtility::debug("ReadData DSStats: Cacti database library not found. [DSSTATS001]\n");
    Severity: Minor
    Found in lib/Weathermap/Plugins/Datasources/CactiDSStats.php - About 4 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 init has 44 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function init(&$map)
    {
        if ($map->context == 'cacti') {
            if (!function_exists('db_fetch_assoc')) {
                MapUtility::debug("ReadData DSStats: Cacti database library not found. [DSSTATS001]\n");
    Severity: Minor
    Found in lib/Weathermap/Plugins/Datasources/CactiDSStats.php - About 1 hr to fix

      Avoid too many return statements within this method.
      Open

              return false;
      Severity: Major
      Found in lib/Weathermap/Plugins/Datasources/CactiDSStats.php - About 30 mins to fix

        Refactor this function to reduce its Cognitive Complexity from 48 to the 15 allowed.
        Open

            public function readData($targetString, &$map, &$mapItem)
        Severity: Critical
        Found in lib/Weathermap/Plugins/Datasources/CactiDSStats.php by sonar-php

        Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

        See

        Refactor this function to reduce its Cognitive Complexity from 28 to the 15 allowed.
        Open

            public function init(&$map)
        Severity: Critical
        Found in lib/Weathermap/Plugins/Datasources/CactiDSStats.php by sonar-php

        Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

        See

        Reduce the number of returns of this function 5, down to the maximum allowed 3.
        Open

            public function init(&$map)
        Severity: Major
        Found in lib/Weathermap/Plugins/Datasources/CactiDSStats.php by sonar-php

        Having too many return statements in a function increases the function's essential complexity because the flow of execution is broken each time a return statement is encountered. This makes it harder to read and understand the logic of the function.

        Noncompliant Code Example

        With the default threshold of 3:

        function myFunction(){ // Noncompliant as there are 4 return statements
  if (condition1) {
    return true;
  } else {
    if (condition2) {
      return false;
    } else {
      return true;
    }
  }
  return false;
}

        Remove this commented out code.
        Open

        //include_once dirname(__FILE__) . "/../Utilitymespace Weathermap\Plugins\Datasources;
        Severity: Major
        Found in lib/Weathermap/Plugins/Datasources/CactiDSStats.php by sonar-php

        Programmers should not comment out code as it bloats programs and reduces readability.

        Unused code should be deleted and can be retrieved from source control history if required.

        See

        • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
        • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
        • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
        • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

        Define a constant instead of duplicating this literal "result" 3 times.
        Open

                                if (($dsNames[$dir] == $result['name']) && ($result['result'] != -90909090909) && ($result['result'] != 'U')) {
        Severity: Critical
        Found in lib/Weathermap/Plugins/Datasources/CactiDSStats.php by sonar-php

        Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

        On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

        Noncompliant Code Example

        With the default threshold of 3:

        function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

        Compliant Solution

        ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

        Exceptions

        To prevent generating some false-positives, literals having less than 5 characters are excluded.

        There are no issues that match your filters.

        Category
        Status