TikiWiki/tiki-manager

View on GitHub
src/Command/SetupSchedulerCronInstanceCommand.php

Summary

Maintainability
C
7 hrs
Test Coverage

Method configure has 42 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function configure()
    {
        parent::configure();

        $this
Severity: Minor
Found in src/Command/SetupSchedulerCronInstanceCommand.php - About 1 hr to fix

    Method interact has 41 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        protected function interact(InputInterface $input, OutputInterface $output)
        {
            $instances = CommandHelper::getInstances('all', true);
            $instancesInfo = CommandHelper::getInstancesInfo($instances);
    
    
    Severity: Minor
    Found in src/Command/SetupSchedulerCronInstanceCommand.php - About 1 hr to fix

      Method handleInstance has 36 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          protected function handleInstance(Instance $instance, InputInterface $input): Instance\CronJob
          {
              $this->io->section($instance->name);
      
              $instanceOS = $instance->getDiscovery()->detectOS();
      Severity: Minor
      Found in src/Command/SetupSchedulerCronInstanceCommand.php - About 1 hr to fix

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

            protected function handleInstance(Instance $instance, InputInterface $input): Instance\CronJob
            {
                $this->io->section($instance->name);
        
                $instanceOS = $instance->getDiscovery()->detectOS();
        Severity: Minor
        Found in src/Command/SetupSchedulerCronInstanceCommand.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

        Avoid too many return statements within this method.
        Open

                        return Helper\CommandHelper::validateCrontabInput($answer);
        Severity: Major
        Found in src/Command/SetupSchedulerCronInstanceCommand.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                  return $newCronJob;
          Severity: Major
          Found in src/Command/SetupSchedulerCronInstanceCommand.php - About 30 mins to fix

            Function interact has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                protected function interact(InputInterface $input, OutputInterface $output)
                {
                    $instances = CommandHelper::getInstances('all', true);
                    $instancesInfo = CommandHelper::getInstancesInfo($instances);
            
            
            Severity: Minor
            Found in src/Command/SetupSchedulerCronInstanceCommand.php - About 25 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

            The method handleInstance() has an NPath complexity of 432. The configured NPath complexity threshold is 200.
            Open

                protected function handleInstance(Instance $instance, InputInterface $input): Instance\CronJob
                {
                    $this->io->section($instance->name);
            
                    $instanceOS = $instance->getDiscovery()->detectOS();

            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 handleInstance() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10.
            Open

                protected function handleInstance(Instance $instance, InputInterface $input): Instance\CronJob
                {
                    $this->io->section($instance->name);
            
                    $instanceOS = $instance->getDiscovery()->detectOS();

            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

            Missing class import via use statement (line '157', column '23').
            Open

                        throw new \Exception('Operating System not supported.');

            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

            Avoid using static access to class 'TikiManager\Command\Helper\CommandHelper' in method 'execute'.
            Open

                    Helper\CommandHelper::validateCrontabInput($time);

            StaticAccess

            Since: 1.4.0

            Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

            Example

            class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

            Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'execute'.
            Open

                    $instances = CommandHelper::getInstances();

            StaticAccess

            Since: 1.4.0

            Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

            Example

            class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

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

                    } else {
                        $statusMsg = !$job->isEnabled() ? '<error>Disabled</error>' : '<info>Enabled</info>';
                        $message = <<<TXT
            Cron Job:
              - Status: %s

            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 static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
            Open

                    $instancesInfo = CommandHelper::getInstancesInfo($instances);

            StaticAccess

            Since: 1.4.0

            Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

            Example

            class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

            Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'execute'.
            Open

                    CommandHelper::validateInstanceSelection($instancesOption, $instances);

            StaticAccess

            Since: 1.4.0

            Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

            Example

            class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

            Avoid using static access to class 'TikiManager\Command\Helper\CommandHelper' in method 'interact'.
            Open

                            return Helper\CommandHelper::validateCrontabInput($answer);

            StaticAccess

            Since: 1.4.0

            Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

            Example

            class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

            Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'execute'.
            Open

                    $instancesInfo = CommandHelper::getInstancesInfo($instances);

            StaticAccess

            Since: 1.4.0

            Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

            Example

            class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

            Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
            Open

                    $instances = CommandHelper::getInstances('all', true);

            StaticAccess

            Since: 1.4.0

            Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

            Example

            class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

            Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
            Open

                        CommandHelper::renderInstancesTable($output, $instancesInfo);

            StaticAccess

            Since: 1.4.0

            Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

            Example

            class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

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

                    } else {
                        preg_match('/\((.+)\)/', $cronFreq, $matches);
                        $cronFreq = $matches[1];
                    }

            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 static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
            Open

                                return CommandHelper::validateInstanceSelection($answer, $instances);

            StaticAccess

            Since: 1.4.0

            Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

            Example

            class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

            There are no issues that match your filters.

            Category
            Status