Sign upLogin

librenms/librenms

View on GitHub
Star
LibreNMS/Util/Number.php

Summary

Maintainability
A
2 hrs
Test Coverage

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

    public static function formatSi($value, $round = 2, $sf = 3, $suffix = 'B'): string
    {
        $value = (float) $value;
        $neg = $value < 0;
        if ($neg) {
Severity: Minor
Found in LibreNMS/Util/Number.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 constrainInteger has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    public static function constrainInteger(int $value, IntegerType $integerSize): int
    {
        if ($integerSize->isSigned()) {
            $maxSignedValue = $integerSize->maxValue();
Severity: Minor
Found in LibreNMS/Util/Number.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

Method formatBase has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    public static function formatBase($value, $base = 1000, $round = 2, $sf = 3, $suffix = 'B'): string
Severity: Minor
Found in LibreNMS/Util/Number.php - About 35 mins to fix

    Missing class import via use statement (line '187', column '27').
    Open

                    throw new \InvalidArgumentException('Unsigned value exceeds the minimum representable value of ' . $integerSize->name);
    Severity: Minor
    Found in LibreNMS/Util/Number.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
    return new \stdClass();
}

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Missing class import via use statement (line '173', column '31').
    Open

                        throw new \InvalidArgumentException('Unsigned value exceeds the maximum representable value of ' . $integerSize->name);
    Severity: Minor
    Found in LibreNMS/Util/Number.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
    return new \stdClass();
}

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    The method formatSi uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            } else {
            $sizes = ['', 'm', 'u', 'n', 'p'];
            $ext = $sizes[0];
            for ($i = 1; ($i < count($sizes)) && ($value != 0) && ($value <= 0.1); $i++) {
                $value = $value * 1000;
    Severity: Minor
    Found in LibreNMS/Util/Number.php by phpmd

    ElseExpression

    Since: 1.4.0

    An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

    Example

    class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

    Source https://phpmd.org/rules/cleancode.html#elseexpression

    Avoid using LibreNMS\Util\count() function in for loops.
    Open

                for ($i = 1; ($i < count($sizes)) && ($value != 0) && ($value <= 0.1); $i++) {
                $value = $value * 1000;
                $ext = $sizes[$i];
            }
    Severity: Minor
    Found in LibreNMS/Util/Number.php by phpmd

    CountInLoopExpression

    Since: 2.7.0

    Using count/sizeof in loops expressions is considered bad practice and is a potential source of many bugs, especially when the loop manipulates an array, as count happens on each iteration.

    Example

    class Foo {

  public function bar()
  {
    $array = array();

    for ($i = 0; count($array); $i++) {
      // ...
    }
  }
}

    Source https://phpmd.org/rules/design.html#countinloopexpression

    Avoid using LibreNMS\Util\count() function in for loops.
    Open

                for ($i = 1; ($i < count($sizes)) && ($value >= 1000); $i++) {
                $value = $value / 1000;
                $ext = $sizes[$i];
            }
    Severity: Minor
    Found in LibreNMS/Util/Number.php by phpmd

    CountInLoopExpression

    Since: 2.7.0

    Using count/sizeof in loops expressions is considered bad practice and is a potential source of many bugs, especially when the loop manipulates an array, as count happens on each iteration.

    Example

    class Foo {

  public function bar()
  {
    $array = array();

    for ($i = 0; count($array); $i++) {
      // ...
    }
  }
}

    Source https://phpmd.org/rules/design.html#countinloopexpression

    Avoid using LibreNMS\Util\count() function in for loops.
    Open

            for ($i = 1; ($i < count($sizes)) && ($value >= 1024); $i++) {
            $value = $value / 1024;
            $ext = $sizes[$i];
        }
    Severity: Minor
    Found in LibreNMS/Util/Number.php by phpmd

    CountInLoopExpression

    Since: 2.7.0

    Using count/sizeof in loops expressions is considered bad practice and is a potential source of many bugs, especially when the loop manipulates an array, as count happens on each iteration.

    Example

    class Foo {

  public function bar()
  {
    $array = array();

    for ($i = 0; count($array); $i++) {
      // ...
    }
  }
}

    Source https://phpmd.org/rules/design.html#countinloopexpression

    Avoid variables with short names like $sf. Configured minimum length is 3.
    Open

        public static function formatSi($value, $round = 2, $sf = 3, $suffix = 'B'): string
    Severity: Minor
    Found in LibreNMS/Util/Number.php by phpmd

    ShortVariable

    Since: 0.2

    Detects when a field, local, or parameter has a very short name.

    Example

    class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

    Source https://phpmd.org/rules/naming.html#shortvariable

    Avoid variables with short names like $sf. Configured minimum length is 3.
    Open

        public static function formatBi($value, $round = 2, $sf = 3, $suffix = 'B'): string
    Severity: Minor
    Found in LibreNMS/Util/Number.php by phpmd

    ShortVariable

    Since: 0.2

    Detects when a field, local, or parameter has a very short name.

    Example

    class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

    Source https://phpmd.org/rules/naming.html#shortvariable

    Avoid variables with short names like $sf. Configured minimum length is 3.
    Open

        public static function formatBase($value, $base = 1000, $round = 2, $sf = 3, $suffix = 'B'): string
    Severity: Minor
    Found in LibreNMS/Util/Number.php by phpmd

    ShortVariable

    Since: 0.2

    Detects when a field, local, or parameter has a very short name.

    Example

    class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

    Source https://phpmd.org/rules/naming.html#shortvariable

    There are no issues that match your filters.

    Category
    Status