librenms/librenms

View on GitHub
app/Console/Commands/SetConfigCommand.php

Summary

Maintainability
C
1 day
Test Coverage

Method handle has 66 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function handle(DynamicConfig $definition)
    {
        $setting = $this->argument('setting');
        $value = $this->argument('value');
        $force = $this->option('ignore-checks');
Severity: Major
Found in app/Console/Commands/SetConfigCommand.php - About 2 hrs to fix

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

        public function handle(DynamicConfig $definition)
        {
            $setting = $this->argument('setting');
            $value = $this->argument('value');
            $force = $this->option('ignore-checks');
    Severity: Minor
    Found in app/Console/Commands/SetConfigCommand.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

    Method validateOsSetting has 37 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function validateOsSetting(string $os, string $setting, $value)
        {
            // prep data to be validated
            OS::loadDefinition($os);
            $os_data = \LibreNMS\Config::get("os.$os");
    Severity: Minor
    Found in app/Console/Commands/SetConfigCommand.php - About 1 hr to fix

      Avoid too many return statements within this method.
      Open

                  return 2;
      Severity: Major
      Found in app/Console/Commands/SetConfigCommand.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                return 1;
        Severity: Major
        Found in app/Console/Commands/SetConfigCommand.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                      return 3;
          Severity: Major
          Found in app/Console/Commands/SetConfigCommand.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                            return 2;
            Severity: Major
            Found in app/Console/Commands/SetConfigCommand.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                          return 0;
              Severity: Major
              Found in app/Console/Commands/SetConfigCommand.php - About 30 mins to fix

                The method handle() has an NPath complexity of 10368. The configured NPath complexity threshold is 200.
                Open

                    public function handle(DynamicConfig $definition)
                    {
                        $setting = $this->argument('setting');
                        $value = $this->argument('value');
                        $force = $this->option('ignore-checks');

                NPathComplexity

                Since: 0.1

                The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

                Example

                class Foo {
                    function bar() {
                        // lots of complicated code
                    }
                }

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

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

                    public function handle(DynamicConfig $definition)
                    {
                        $setting = $this->argument('setting');
                        $value = $this->argument('value');
                        $force = $this->option('ignore-checks');

                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 forgetWithIndex uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
                Open

                        } else {
                            Arr::forget($data, $matches);
                        }

                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 erase uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
                Open

                            } else {
                                // not nested, just forget the setting
                                $this->forgetWithIndex($data, $this->getChildPath($setting, $parent));
                            }

                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 variables with short names like $os. Configured minimum length is 3.
                Open

                            $os = $matches['os'];

                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 $os. Configured minimum length is 3.
                Open

                    private function validateOsSetting(string $os, string $setting, $value)

                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