Sign upLogin

howardjones/network-weathermap

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

Summary

Maintainability
A
2 hrs
Test Coverage

Method __construct has 35 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function __construct()
    {
        $this->alpha = 255;

        // a set of 3 colours
Severity: Minor
Found in lib/Weathermap/Core/Colour.php - About 1 hr to fix

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

        public function __construct()
    {
        $this->alpha = 255;

        // a set of 3 colours
    Severity: Minor
    Found in lib/Weathermap/Core/Colour.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

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

        public function asString($format = 'RGB(%d,%d,%d)')
    Severity: Major
    Found in lib/Weathermap/Core/Colour.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;
}

    Define and throw a dedicated exception instead of using a generic one.
    Open

                            throw new \Exception("Unknown special colour type");
    Severity: Major
    Found in lib/Weathermap/Core/Colour.php by sonar-php

    If you throw a general exception type, such as ErrorException, RuntimeException, or Exception in a library or framework, it forces consumers to catch all exceptions, including unknown exceptions that they do not know how to handle.

    Instead, either throw a subtype that already exists in the Standard PHP Library, or create your own type that derives from Exception.

    Noncompliant Code Example

    throw new Exception();  // Noncompliant

    Compliant Solution

    throw new InvalidArgumentException();
// or
throw new UnexpectedValueException();

    See

    There are no issues that match your filters.

    Category
    Status