Sign upLogin

howardjones/network-weathermap

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

Summary

Maintainability
A
3 hrs
Test Coverage

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

    public function readData($targetString, &$map, &$mapItem)
    {
        $this->data[IN] = null;
        $this->data[OUT] = null;
Severity: Minor
Found in lib/Weathermap/Plugins/Datasources/CactiHostStatus.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

Method readData has 41 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function readData($targetString, &$map, &$mapItem)
    {
        $this->data[IN] = null;
        $this->data[OUT] = null;
Severity: Minor
Found in lib/Weathermap/Plugins/Datasources/CactiHostStatus.php - About 1 hr to fix

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

                    if ($result['status'] == 1) {
    Severity: Critical
    Found in lib/Weathermap/Plugins/Datasources/CactiHostStatus.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.

    Remove this commented out code.
    Open

    //require_once dirname(__FILE__) . "/../database.php";
    Severity: Major
    Found in lib/Weathermap/Plugins/Datasources/CactiHostStatus.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"

    There are no issues that match your filters.

    Category
    Status