Sign upLogin

howardjones/network-weathermap

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

Summary

Maintainability
F
3 days
Test Coverage

File Legend.php has 433 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace Weathermap\Core;

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

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

        private function drawLegendClassic($useTags = false)
    {
        $nScales = $this->scale->spanCount();

        MapUtility::debug("Drawing $nScales colours into SCALE\n");
    Severity: Minor
    Found in lib/Weathermap/Core/Legend.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 drawLegendClassic has 95 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function drawLegendClassic($useTags = false)
    {
        $nScales = $this->scale->spanCount();

        MapUtility::debug("Drawing $nScales colours into SCALE\n");
    Severity: Major
    Found in lib/Weathermap/Core/Legend.php - About 3 hrs to fix

      Method drawLegendHorizontal has 81 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function drawLegendHorizontal($keyWidth = 400)
    {

        $title = $this->keytitle;
      Severity: Major
      Found in lib/Weathermap/Core/Legend.php - About 3 hrs to fix

        Method drawLegendVertical has 71 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private function drawLegendVertical($keyHeight = 400, $inverted = false)
    {
        $title = $this->keytitle;

        $nScales = $this->scale->spanCount();
        Severity: Major
        Found in lib/Weathermap/Core/Legend.php - About 2 hrs to fix

          Method getConfig has 34 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function getConfig()
    {
        assert(isset($this->owner));

        $output = '';
          Severity: Minor
          Found in lib/Weathermap/Core/Legend.php - About 1 hr to fix

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

                private function drawLegendVertical($keyHeight = 400, $inverted = false)
    {
        $title = $this->keytitle;

        $nScales = $this->scale->spanCount();
            Severity: Minor
            Found in lib/Weathermap/Core/Legend.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 getConfig has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

                public function getConfig()
    {
        assert(isset($this->owner));

        $output = '';
            Severity: Minor
            Found in lib/Weathermap/Core/Legend.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 drawLegendHorizontal has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

                private function drawLegendHorizontal($keyWidth = 400)
    {

        $title = $this->keytitle;
            Severity: Minor
            Found in lib/Weathermap/Core/Legend.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

            Avoid too many return statements within this method.
            Open

                    return null;
            Severity: Major
            Found in lib/Weathermap/Core/Legend.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                              return $this->drawLegendClassic(true);
              Severity: Major
              Found in lib/Weathermap/Core/Legend.php - About 30 mins to fix

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

                    private function drawLegendClassic($useTags = false)
                Severity: Critical
                Found in lib/Weathermap/Core/Legend.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 6, down to the maximum allowed 3.
                Open

                    public function drawLegend()
                Severity: Major
                Found in lib/Weathermap/Core/Legend.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

                //        $this->owner->imap->addArea($newArea);
                Severity: Major
                Found in lib/Weathermap/Core/Legend.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"

                Add a "case default" clause to this "switch" statement.
                Open

                        switch ($this->keystyle) {
                Severity: Critical
                Found in lib/Weathermap/Core/Legend.php by sonar-php

                The requirement for a final case default clause is defensive programming. The clause should either take appropriate action, or contain a suitable comment as to why no action is taken. Even when the switch covers all current values of an enum, a default case should still be used because there is no guarantee that the enum won't be extended.

                Noncompliant Code Example

                switch ($param) {  //missing default clause
  case 0:
    do_something();
    break;
  case 1:
    do_something_else();
    break;
}

switch ($param) {
  default: // default clause should be the last one
    error();
    break;
  case 0:
    do_something();
    break;
  case 1:
    do_something_else();
    break;
}

                Compliant Solution

                switch ($param) {
  case 0:
    do_something();
    break;
  case 1:
    do_something_else();
    break;
  default:
    error();
    break;
}

                See

                • MISRA C:2004, 15.0 - The MISRA C switch syntax shall be used.
                • MISRA C:2004, 15.3 - The final clause of a switch statement shall be the default clause
                • MISRA C++:2008, 6-4-3 - A switch statement shall be a well-formed switch statement.
                • MISRA C++:2008, 6-4-6 - The final clause of a switch statement shall be the default-clause
                • MISRA C:2012, 16.1 - All switch statements shall be well-formed
                • MISRA C:2012, 16.4 - Every switch statement shall have a default label
                • MISRA C:2012, 16.5 - A default label shall appear as either the first or the last switch label of a switch statement
                • MITRE, CWE-478 - Missing Default Case in Switch Statement
                • CERT, MSC01-C. - Strive for logical completeness
                • CERT, MSC01-CPP. - Strive for logical completeness

                Remove this commented out code.
                Open

                        );
                Severity: Major
                Found in lib/Weathermap/Core/Legend.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

                        // $config['pos'] = array($this->keypos->x, $this->keypos->y);
                Severity: Major
                Found in lib/Weathermap/Core/Legend.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

                        //        $this->setColour("KEYBG", new Colour(255, 255, 255));
                Severity: Major
                Found in lib/Weathermap/Core/Legend.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