Sign upLogin

warlof/seat-discord-connector

View on GitHub
Star

Showing 33 of 37 total issues

Function getInstance has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
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 - 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 store has 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function store(Request $request)
    {
        try {
            $request->validate([
                'client_id'       => 'required|string',
Severity: Minor
Found in src/Http/Controllers/SettingsController.php - About 1 hr to fix

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

        public function getUser(string $id): ?IUser
    {
        $member = $this->members->get($id);

        if (! is_null($member))
    Severity: Minor
    Found in src/Driver/DiscordClient.php - About 1 hr to fix

      The property $bot_token is not named in camelCase.
      Open

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

    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

      Avoid variables with short names like $id. Configured minimum length is 3.
      Open

          private $id;
      Severity: Minor
      Found in src/Driver/DiscordMember.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

          private $id;
      Severity: Minor
      Found in src/Driver/DiscordRole.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 $owner_id is not named in camelCase.
      Open

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

    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

      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

      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

      The property $guild_id is not named in camelCase.
      Open

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

    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 $role_ids is not named in camelCase.
      Open

      class DiscordMember implements IUser
{
    /**
     * @var string
     */
      Severity: Minor
      Found in src/Driver/DiscordMember.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

      Function seedMembers has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          private function seedMembers()
    {
        $after = null;

        do {
      Severity: Minor
      Found in src/Driver/DiscordClient.php - About 45 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 class DiscordClient has a coupling between objects value of 13. Consider to reduce the number of dependencies under 13.
      Open

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

    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

      The class RegistrationController has a coupling between objects value of 15. Consider to reduce the number of dependencies under 13.
      Open

      class RegistrationController extends Controller
{
    const SCOPES = [
        'identify', 'guilds.join',
    ];
      Severity: Minor
      Found in src/Http/Controllers/RegistrationController.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

      Function seedRoles has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          private function seedRoles()
    {
        $roles = DiscordClient::getInstance()->sendCall('GET', '/guilds/{guild.id}/roles', [
            'guild.id' => $this->guild_id,
        ]);
      Severity: Minor
      Found in src/Driver/DiscordClient.php - About 35 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

      Function getUser has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          public function getUser(string $id): ?IUser
    {
        $member = $this->members->get($id);

        if (! is_null($member))
      Severity: Minor
      Found in src/Driver/DiscordClient.php - About 35 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

      Function getSets has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          public function getSets(): array
    {
        if ($this->roles->isEmpty()) {
            foreach ($this->role_ids as $role_id) {
                $set = DiscordClient::getInstance()->getSet($role_id);
      Severity: Minor
      Found in src/Driver/DiscordMember.php - About 35 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

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

          public function redirectToProvider()
    {
        $settings = setting('seat-connector.drivers.discord', true);

        if (is_null($settings) || ! is_object($settings))
      Severity: Minor
      Found in src/Http/Controllers/RegistrationController.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

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

          public function sendCall(string $method, string $endpoint, array $arguments = [])
    {
        $uri = ltrim($endpoint, '/');

        foreach ($arguments as $uri_parameter => $value) {
      Severity: Minor
      Found in src/Driver/DiscordClient.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 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),
            ]);
        }
      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

      Severity
      Category
      Status
      Source
      Language