TikiWiki/tiki-manager

View on GitHub
src/Libs/Host/Command.php

Summary

Maintainability
D
1 day
Test Coverage

The class Command has an overall complexity of 67 which is very high. The configured complexity threshold is 50.
Open

class Command
{
    private $args;
    private $command;
    private $host;
Severity: Minor
Found in src/Libs/Host/Command.php by phpmd

Command has 26 functions (exceeds 20 allowed). Consider refactoring.
Open

class Command
{
    private $args;
    private $command;
    private $host;
Severity: Minor
Found in src/Libs/Host/Command.php - About 3 hrs to fix

    Function prepareArgs has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

        public function prepareArgs($args)
        {
            $result = [];
            if (is_string($args)) {
                $args = preg_split('/  */', $args);
    Severity: Minor
    Found in src/Libs/Host/Command.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

    Method prepareArgs has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function prepareArgs($args)
        {
            $result = [];
            if (is_string($args)) {
                $args = preg_split('/  */', $args);
    Severity: Minor
    Found in src/Libs/Host/Command.php - About 1 hr to fix

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

                      } else {
                          $arg = escapeshellarg($arg);
                      }
      Severity: Minor
      Found in src/Libs/Host/Command.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

      Returning type null but getStderr() is declared to return resource
      Open

              return $this->stderr ?: null;
      Severity: Minor
      Found in src/Libs/Host/Command.php by phan

      Returning type null but getStdout() is declared to return resource
      Open

              return $this->stdout ?: null;
      Severity: Minor
      Found in src/Libs/Host/Command.php by phan

      Saw possibly unextractable annotation for a fragment of comment '* @param resource|string the command stdin': after resource|string, did not see an element name (will guess based on comment order)
      Open

           * @param resource|string    the command stdin
      Severity: Info
      Found in src/Libs/Host/Command.php by phan

      Assigning \TikiManager\Libs\Host\SSH to property but \TikiManager\Libs\Host\Command->host is \TikiManager\Libs\Host\Local
      Open

              return $this->host = $host;
      Severity: Minor
      Found in src/Libs/Host/Command.php by phan

      Returning type null but getStdin() is declared to return resource
      Open

              return $this->stdin ?: null;
      Severity: Minor
      Found in src/Libs/Host/Command.php by phan

      Similar blocks of code found in 3 locations. Consider refactoring.
      Open

          public function setStderr($stderr)
          {
              if (is_object($stderr) && method_exists($stderr, '__toString')) {
                  $stderr = strval($stderr);
              }
      Severity: Major
      Found in src/Libs/Host/Command.php and 2 other locations - About 2 hrs to fix
      src/Libs/Host/Command.php on lines 273..288
      src/Libs/Host/Command.php on lines 293..308

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 134.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 3 locations. Consider refactoring.
      Open

          public function setStdout($stdout)
          {
              if (is_object($stdout) && method_exists($stdout, '__toString')) {
                  $stdout = strval($stdout);
              }
      Severity: Major
      Found in src/Libs/Host/Command.php and 2 other locations - About 2 hrs to fix
      src/Libs/Host/Command.php on lines 253..268
      src/Libs/Host/Command.php on lines 273..288

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 134.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 3 locations. Consider refactoring.
      Open

          public function setStdin($stdin)
          {
              if (is_object($stdin) && method_exists($stdin, '__toString')) {
                  $stdin = strval($stdin);
              }
      Severity: Major
      Found in src/Libs/Host/Command.php and 2 other locations - About 2 hrs to fix
      src/Libs/Host/Command.php on lines 253..268
      src/Libs/Host/Command.php on lines 293..308

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 134.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      There are no issues that match your filters.

      Category
      Status