Sign upLogin

librenms/librenms

View on GitHub
Star
LibreNMS/Validator.php

Summary

Maintainability
B
4 hrs
Test Coverage

Function validate has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

    public function validate(array $validation_groups = [], bool $print_group_status = false): void
    {
        foreach ($this->validation_groups as $group_name => $group) {
            // only run each group once
            if ($group->isCompleted()) {
Severity: Minor
Found in LibreNMS/Validator.php - About 2 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

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

    public function printResults(string $validation_group = null): void
    {
        $results = $this->getResults($validation_group);

        foreach ($results as $result) {
Severity: Minor
Found in LibreNMS/Validator.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 result has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    public function result(ValidationResult $result, string $group = null): void
    {
        // get the name of the validation that submitted this result
        if (empty($group)) {
            $group = 'unknown';
Severity: Minor
Found in LibreNMS/Validator.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 '';
Severity: Major
Found in LibreNMS/Validator.php - About 30 mins to fix

    The method validate() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
    Open

        public function validate(array $validation_groups = [], bool $print_group_status = false): void
    {
        foreach ($this->validation_groups as $group_name => $group) {
            // only run each group once
            if ($group->isCompleted()) {
    Severity: Minor
    Found in LibreNMS/Validator.php by phpmd

    CyclomaticComplexity

    Since: 0.1

    Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

    Example

    // Cyclomatic Complexity = 11
class Foo {
1   public function example() {
2       if ($a == $b) {
3           if ($a1 == $b1) {
                fiddle();
4           } elseif ($a2 == $b2) {
                fiddle();
            } else {
                fiddle();
            }
5       } elseif ($c == $d) {
6           while ($c == $d) {
                fiddle();
            }
7        } elseif ($e == $f) {
8           for ($n = 0; $n < $h; $n++) {
                fiddle();
            }
        } else {
            switch ($z) {
9               case 1:
                    fiddle();
                    break;
10              case 2:
                    fiddle();
                    break;
11              case 3:
                    fiddle();
                    break;
                default:
                    fiddle();
                    break;
            }
        }
    }
}

    Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

    The method validate has a boolean flag argument $print_group_status, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function validate(array $validation_groups = [], bool $print_group_status = false): void
    Severity: Minor
    Found in LibreNMS/Validator.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

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

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

                } else {
                $this->username = getenv('USERNAME') ?: getenv('USER');
            }
    Severity: Minor
    Found in LibreNMS/Validator.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

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

                        } else {
                        echo "Failed to apply fix.\n";
                    }
    Severity: Minor
    Found in LibreNMS/Validator.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 empty try-catch blocks in __construct.
    Open

                } catch (ReflectionException $e) {
            }
    Severity: Minor
    Found in LibreNMS/Validator.php by phpmd

    EmptyCatchBlock

    Since: 2.7.0

    Usually empty try-catch is a bad idea because you are silently swallowing an error condition and then continuing execution. Occasionally this may be the right thing to do, but often it's a sign that a developer saw an exception, didn't know what to do about it, and so used an empty catch to silence the problem.

    Example

    class Foo {

  public function bar()
  {
      try {
          // ...
      } catch (Exception $e) {} // empty catch block
  }
}

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

    Avoid using short method names like Validator::ok(). The configured minimum method name length is 3.
    Open

        public function ok(string $message, string $fix = null, string $group = null): void
    {
        $this->result(new ValidationResult($message, ValidationResult::SUCCESS, $fix), $group);
    }
    Severity: Minor
    Found in LibreNMS/Validator.php by phpmd

    ShortMethodName

    Since: 0.2

    Detects when very short method names are used.

    Example

    class ShortMethod {
    public function a( $index ) { // Violation
    }
}

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

    The property $validation_groups is not named in camelCase.
    Open

    class Validator
{
    /** @var array */
    private $validation_groups = [];
    /** @var array */
    Severity: Minor
    Found in LibreNMS/Validator.php by phpmd

    CamelCasePropertyName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name attributes.

    Example

    class ClassName {
    protected $property_name;
}

    Source

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

                    $rc = new ReflectionClass($class);
    Severity: Minor
    Found in LibreNMS/Validator.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 $bt. Configured minimum length is 3.
    Open

                $bt = debug_backtrace();
    Severity: Minor
    Found in LibreNMS/Validator.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