zenobio93/seat-discord-connector

View on GitHub
src/Driver/DiscordClient.php

Summary

Maintainability
A
0 mins
Test Coverage

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

class DiscordClient implements IClient
{
    final public CONST BASE_URI = 'https://discord.com/api';

    final public CONST VERSION = 'v6';
Severity: Minor
Found in src/Driver/DiscordClient.php by phpmd

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

    public static function getInstance(): IClient
    {
        if (! isset(self::$instance)) {
            try {
                $settings = setting('seat-connector.drivers.discord', true);
Severity: Minor
Found in src/Driver/DiscordClient.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 class DiscordClient has a coupling between objects value of 14. Consider to reduce the number of dependencies under 13.
Open

class DiscordClient implements IClient
{
    final public CONST BASE_URI = 'https://discord.com/api';

    final public CONST VERSION = 'v6';
Severity: Minor
Found in src/Driver/DiscordClient.php by phpmd

CouplingBetweenObjects

Since: 1.1.0

A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

Example

class Foo {
    /**
     * @var \foo\bar\X
     */
    private $x = null;

    /**
     * @var \foo\bar\Y
     */
    private $y = null;

    /**
     * @var \foo\bar\Z
     */
    private $z = null;

    public function setFoo(\Foo $foo) {}
    public function setBar(\Bar $bar) {}
    public function setBaz(\Baz $baz) {}

    /**
     * @return \SplObjectStorage
     * @throws \OutOfRangeException
     * @throws \InvalidArgumentException
     * @throws \ErrorException
     */
    public function process(\Iterator $it) {}

    // ...
}

Source https://phpmd.org/rules/design.html#couplingbetweenobjects

Avoid using static access to class '\Illuminate\Support\Arr' in method 'sendCall'.
Open

            Arr::pull($arguments, $uri_parameter);
Severity: Minor
Found in src/Driver/DiscordClient.php by phpmd

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

        } else {
            $response = $this->client->request($method, $uri, [
                'body' => json_encode($arguments, JSON_THROW_ON_ERROR),
            ]);
        }
Severity: Minor
Found in src/Driver/DiscordClient.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 variables with short names like $id. Configured minimum length is 3.
Open

    public function getSet(string $id): ?ISet
Severity: Minor
Found in src/Driver/DiscordClient.php by phpmd

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

    public function getUser(string $id): ?IUser
Severity: Minor
Found in src/Driver/DiscordClient.php by phpmd

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

The property $guild_id is not named in camelCase.
Open

class DiscordClient implements IClient
{
    final public CONST BASE_URI = 'https://discord.com/api';

    final public CONST VERSION = 'v6';
Severity: Minor
Found in src/Driver/DiscordClient.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 property $owner_id is not named in camelCase.
Open

class DiscordClient implements IClient
{
    final public CONST BASE_URI = 'https://discord.com/api';

    final public CONST VERSION = 'v6';
Severity: Minor
Found in src/Driver/DiscordClient.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 property $bot_token is not named in camelCase.
Open

class DiscordClient implements IClient
{
    final public CONST BASE_URI = 'https://discord.com/api';

    final public CONST VERSION = 'v6';
Severity: Minor
Found in src/Driver/DiscordClient.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

There are no issues that match your filters.

Category
Status