TikiWiki/tiki-manager

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

Summary

Maintainability
B
4 hrs
Test Coverage

rsync accesses the super-global variable $_ENV.
Open

    public function rsync($args = [])
    {
        $return_val = -1;
        if (empty($args['src']) || empty($args['dest'])) {
            return $return_val;
Severity: Minor
Found in src/Libs/Host/SSH.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

openShell accesses the super-global variable $_ENV.
Open

    public function openShell($workingDir = '')
    {
        $key = $_ENV['SSH_KEY'];
        $port = null;
        if ($this->port != 22) {
Severity: Minor
Found in src/Libs/Host/SSH.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

checkSshKey accesses the super-global variable $_ENV.
Open

    private function checkSshKey()
    {
        $params = [
            '-i',
            $_ENV['SSH_KEY'],
Severity: Minor
Found in src/Libs/Host/SSH.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

openShell accesses the super-global variable $_ENV.
Open

    public function openShell($workingDir = '')
    {
        $key = $_ENV['SSH_KEY'];
        $port = null;
        if ($this->port != 22) {
Severity: Minor
Found in src/Libs/Host/SSH.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

checkSshKey accesses the super-global variable $_ENV.
Open

    private function checkSshKey()
    {
        $params = [
            '-i',
            $_ENV['SSH_KEY'],
Severity: Minor
Found in src/Libs/Host/SSH.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

Method rsync has 44 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function rsync($args = [])
    {
        $return_val = -1;
        if (empty($args['src']) || empty($args['dest'])) {
            return $return_val;
Severity: Minor
Found in src/Libs/Host/SSH.php - About 1 hr to fix

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

        public function rsync($args = [])
        {
            $return_val = -1;
            if (empty($args['src']) || empty($args['dest'])) {
                return $return_val;
    Severity: Minor
    Found in src/Libs/Host/SSH.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 checkSshKey has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function checkSshKey()
        {
            $params = [
                '-i',
                $_ENV['SSH_KEY'],
    Severity: Minor
    Found in src/Libs/Host/SSH.php - About 1 hr to fix

      The method rsync() has an NPath complexity of 810. The configured NPath complexity threshold is 200.
      Open

          public function rsync($args = [])
          {
              $return_val = -1;
              if (empty($args['src']) || empty($args['dest'])) {
                  return $return_val;
      Severity: Minor
      Found in src/Libs/Host/SSH.php by phpmd

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

          public function rsync($args = [])
          {
              $return_val = -1;
              if (empty($args['src']) || empty($args['dest'])) {
                  return $return_val;
      Severity: Minor
      Found in src/Libs/Host/SSH.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 runCommands has a boolean flag argument $output, which is a certain sign of a Single Responsibility Principle violation.
      Open

          public function runCommands($commands, $output = false)
      Severity: Minor
      Found in src/Libs/Host/SSH.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 checkCopyId uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              } else {
                  if (preg_match('/p port/', stream_get_contents($ph))) {
                      $this->copy_id_port_in_host = false;
                  }
                  pclose($ph);
      Severity: Minor
      Found in src/Libs/Host/SSH.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 setupKey uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              } else {
                  $port = escapeshellarg($this->port);
                  $host = escapeshellarg("{$this->user}@{$this->host}");
                  `ssh-copy-id -i $file -p $port $host`;
              }
      Severity: Minor
      Found in src/Libs/Host/SSH.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 rsync uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              } else {
                  $rsyncParams[] = $src;
                  $rsyncParams[] = "{$user}@{$host}:".escapeshellarg($dest);
              }
      Severity: Minor
      Found in src/Libs/Host/SSH.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 assigning values to variables in if clauses and the like (line '263', column '17').
      Open

          private function checkSshKey()
          {
              $params = [
                  '-i',
                  $_ENV['SSH_KEY'],
      Severity: Minor
      Found in src/Libs/Host/SSH.php by phpmd

      IfStatementAssignment

      Since: 2.7.0

      Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

      Example

      class Foo
      {
          public function bar($flag)
          {
              if ($foo = 'bar') { // possible typo
                  // ...
              }
              if ($baz = 0) { // always false
                  // ...
              }
          }
      }

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

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

              } else {
                  $command = "ssh $port -i $key {$this->user}@{$this->host}";
              }
      Severity: Minor
      Found in src/Libs/Host/SSH.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

      Argument 1 (arg) is int but \escapeshellarg() takes string
      Open

                  $port = escapeshellarg($this->port);
      Severity: Minor
      Found in src/Libs/Host/SSH.php by phan

      The property $copy_id_port_in_host is not named in camelCase.
      Open

      class SSH
      {
          private static $sshKeyCheck = [];
      
          private $adapter;
      Severity: Minor
      Found in src/Libs/Host/SSH.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

      The parameter $adapter_class is not named in camelCase.
      Open

          public function __construct($host, $user, $port, $adapter_class = null)
          {
              $this->host = $host ?: '';
              $this->user = $user ?: '';
              $this->port = $port ?: 22;
      Severity: Minor
      Found in src/Libs/Host/SSH.php by phpmd

      CamelCaseParameterName

      Since: 0.2

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

      Example

      class ClassName {
          public function doSomething($user_name) {
          }
      }

      Source

      The variable $return_var is not named in camelCase.
      Open

          public function rsync($args = [])
          {
              $return_val = -1;
              if (empty($args['src']) || empty($args['dest'])) {
                  return $return_val;
      Severity: Minor
      Found in src/Libs/Host/SSH.php by phpmd

      CamelCaseVariableName

      Since: 0.2

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

      Example

      class ClassName {
          public function doSomething() {
              $data_module = new DataModule();
          }
      }

      Source

      The variable $return_var is not named in camelCase.
      Open

          public function rsync($args = [])
          {
              $return_val = -1;
              if (empty($args['src']) || empty($args['dest'])) {
                  return $return_val;
      Severity: Minor
      Found in src/Libs/Host/SSH.php by phpmd

      CamelCaseVariableName

      Since: 0.2

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

      Example

      class ClassName {
          public function doSomething() {
              $data_module = new DataModule();
          }
      }

      Source

      The variable $return_val is not named in camelCase.
      Open

          public function rsync($args = [])
          {
              $return_val = -1;
              if (empty($args['src']) || empty($args['dest'])) {
                  return $return_val;
      Severity: Minor
      Found in src/Libs/Host/SSH.php by phpmd

      CamelCaseVariableName

      Since: 0.2

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

      Example

      class ClassName {
          public function doSomething() {
              $data_module = new DataModule();
          }
      }

      Source

      The variable $return_var is not named in camelCase.
      Open

          public function rsync($args = [])
          {
              $return_val = -1;
              if (empty($args['src']) || empty($args['dest'])) {
                  return $return_val;
      Severity: Minor
      Found in src/Libs/Host/SSH.php by phpmd

      CamelCaseVariableName

      Since: 0.2

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

      Example

      class ClassName {
          public function doSomething() {
              $data_module = new DataModule();
          }
      }

      Source

      The variable $return_val is not named in camelCase.
      Open

          public function rsync($args = [])
          {
              $return_val = -1;
              if (empty($args['src']) || empty($args['dest'])) {
                  return $return_val;
      Severity: Minor
      Found in src/Libs/Host/SSH.php by phpmd

      CamelCaseVariableName

      Since: 0.2

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

      Example

      class ClassName {
          public function doSomething() {
              $data_module = new DataModule();
          }
      }

      Source

      The variable $adapter_class is not named in camelCase.
      Open

          public function __construct($host, $user, $port, $adapter_class = null)
          {
              $this->host = $host ?: '';
              $this->user = $user ?: '';
              $this->port = $port ?: 22;
      Severity: Minor
      Found in src/Libs/Host/SSH.php by phpmd

      CamelCaseVariableName

      Since: 0.2

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

      Example

      class ClassName {
          public function doSomething() {
              $data_module = new DataModule();
          }
      }

      Source

      The variable $return_var is not named in camelCase.
      Open

          public function rsync($args = [])
          {
              $return_val = -1;
              if (empty($args['src']) || empty($args['dest'])) {
                  return $return_val;
      Severity: Minor
      Found in src/Libs/Host/SSH.php by phpmd

      CamelCaseVariableName

      Since: 0.2

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

      Example

      class ClassName {
          public function doSomething() {
              $data_module = new DataModule();
          }
      }

      Source

      There are no issues that match your filters.

      Category
      Status