Sign upLogin

howardjones/network-weathermap

View on GitHub
Star
lib/Weathermap/Core/MapDataItem.php

Summary

Maintainability
D
1 day
Test Coverage

File MapDataItem.php has 341 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace Weathermap\Core;

/**
Severity: Minor
Found in lib/Weathermap/Core/MapDataItem.php - About 4 hrs to fix

    MapDataItem has 23 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class MapDataItem extends MapItem
{
    // arrays to replace a lot of what follows. Paving the way for >2 channels of data.
    // (and generally less duplicated code)
    public $maxValues = array();
    Severity: Minor
    Found in lib/Weathermap/Core/MapDataItem.php - About 2 hrs to fix

      Function getConfigSimple has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

          protected function getConfigSimple($simpleParameters, $comparison)
    {
        $output = '';

        # TEMPLATE must come first. DEFAULT
      Severity: Minor
      Found in lib/Weathermap/Core/MapDataItem.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

      Function copyFrom has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          public function copyFrom(&$source)
    {
        MapUtility::debug("Initialising %s $this->name from $source->name\n", $this->myType());
        assert(is_object($source));
      Severity: Minor
      Found in lib/Weathermap/Core/MapDataItem.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 prepareForDataCollection has 27 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function prepareForDataCollection()
    {
        /** @var Target $target */
        foreach ($this->targets as $target) {
            MapUtility::debug("ProcessTargets: New Target: $target\n");
      Severity: Minor
      Found in lib/Weathermap/Core/MapDataItem.php - About 1 hr to fix

        Function collectDataFromTargets has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

            private function collectDataFromTargets($channels)
    {
        $nFails = 0;
        $dataTime = 0;
        Severity: Minor
        Found in lib/Weathermap/Core/MapDataItem.php - About 55 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 prepareForDataCollection has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            public function prepareForDataCollection()
    {
        /** @var Target $target */
        foreach ($this->targets as $target) {
            MapUtility::debug("ProcessTargets: New Target: $target\n");
        Severity: Minor
        Found in lib/Weathermap/Core/MapDataItem.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 getConfigInOutOrBoth has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            protected function getConfigInOutOrBoth($comparison, $configKeyword, $fieldName)
    {
        $output = '';
        $myArray = $this->$fieldName;
        $theirArray = $comparison->$fieldName;
        Severity: Minor
        Found in lib/Weathermap/Core/MapDataItem.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 calculateScaleColours has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            public function calculateScaleColours()
    {
        $channels = $this->getChannelList();

        $scale = $this->owner->getScale($this->usescale);
        Severity: Minor
        Found in lib/Weathermap/Core/MapDataItem.php - About 35 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 aggregateDataResults has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

            public function aggregateDataResults()
    {
        $channels = $this->getChannelList();

        foreach ($channels as $channelName => $channel) {
        Severity: Minor
        Found in lib/Weathermap/Core/MapDataItem.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

        Class "MapDataItem" has 23 methods, which is greater than 20 authorized. Split it into smaller classes.
        Open

        class MapDataItem extends MapItem
        Severity: Major
        Found in lib/Weathermap/Core/MapDataItem.php by sonar-php

        A class that grows too much tends to aggregate too many responsibilities and inevitably becomes harder to understand and therefore to maintain. Above a specific threshold, it is strongly advised to refactor the class into smaller ones which focus on well defined topics.

        Remove this commented out code.
        Open

        //    {
        Severity: Major
        Found in lib/Weathermap/Core/MapDataItem.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 "DEFAULT" 3 times.
        Open

                    $templateName = 'DEFAULT';
        Severity: Critical
        Found in lib/Weathermap/Core/MapDataItem.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

        //            ) {
        Severity: Major
        Found in lib/Weathermap/Core/MapDataItem.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"

        Remove this commented out code.
        Open

        //    {
        Severity: Major
        Found in lib/Weathermap/Core/MapDataItem.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"

        Remove this commented out code.
        Open

        //                    && $comparison->hints[$hintname] != $hint)
        Severity: Major
        Found in lib/Weathermap/Core/MapDataItem.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