hnhdigital-os/php-virtualmin-api

View on GitHub
src/VirtualminClient.php

Summary

Maintainability
A
2 hrs
Test Coverage

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

    protected function call($program, $parameters = [])
    {
        $url = sprintf('%s://%s:%s/virtual-server/remote.cgi?program=%s&json=1', $this->mode, $this->server, $this->port, $program);

        foreach ($parameters as $key => &$value) {
Severity: Minor
Found in src/VirtualminClient.php - About 1 hr to fix

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

        protected function call($program, $parameters = [])
        {
            $url = sprintf('%s://%s:%s/virtual-server/remote.cgi?program=%s&json=1', $this->mode, $this->server, $this->port, $program);
    
            foreach ($parameters as $key => &$value) {
    Severity: Minor
    Found in src/VirtualminClient.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

    The method call() has an NPath complexity of 216. The configured NPath complexity threshold is 200.
    Open

        protected function call($program, $parameters = [])
        {
            $url = sprintf('%s://%s:%s/virtual-server/remote.cgi?program=%s&json=1', $this->mode, $this->server, $this->port, $program);
    
            foreach ($parameters as $key => &$value) {
    Severity: Minor
    Found in src/VirtualminClient.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 call() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
    Open

        protected function call($program, $parameters = [])
        {
            $url = sprintf('%s://%s:%s/virtual-server/remote.cgi?program=%s&json=1', $this->mode, $this->server, $this->port, $program);
    
            foreach ($parameters as $key => &$value) {
    Severity: Minor
    Found in src/VirtualminClient.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

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

                throw new \Exception('Failed to connect - '.$exception->getMessage());
    Severity: Minor
    Found in src/VirtualminClient.php by phpmd

    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

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

                throw new \Exception($result['error']);
    Severity: Minor
    Found in src/VirtualminClient.php by phpmd

    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

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

                throw new \Exception(json_last_error_msg());
    Severity: Minor
    Found in src/VirtualminClient.php by phpmd

    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

    There are no issues that match your filters.

    Category
    Status