VSVverkeerskunde/gvq-api

View on GitHub
src/Contest/Repositories/Entities/ContestParticipationEntity.php

Summary

Maintainability
A
2 hrs
Test Coverage

Method __construct has 11 arguments (exceeds 4 allowed). Consider refactoring.
Open

        string $id,
        int $year,
        string $language,
        string $channel,
        ContestParticipantEmbeddable $contestParticipant,
Severity: Major
Found in src/Contest/Repositories/Entities/ContestParticipationEntity.php - About 1 hr to fix

    Method fromContestParticipation has 27 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static function fromContestParticipation(
            ContestParticipation $contestParticipation
        ): ContestParticipationEntity {
            if ($contestParticipation->getAddress()) {
                $address = AddressEmbeddable::fromAddress(
    Severity: Minor
    Found in src/Contest/Repositories/Entities/ContestParticipationEntity.php - About 1 hr to fix

      The method __construct has 11 parameters. Consider reducing the number of parameters to less than 10.
      Open

          private function __construct(
              string $id,
              int $year,
              string $language,
              string $channel,

      This function has 11 parameters, which is greater than the 7 authorized.
      Open

          private function __construct(
              string $id,
              int $year,
              string $language,
              string $channel,

      A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

      Noncompliant Code Example

      With a maximum number of 4 parameters:

      function doSomething($param1, $param2, $param3, $param4, $param5) {
      ...
      }
      

      Compliant Solution

      function doSomething($param1, $param2, $param3, $param4) {
      ...
      }
      

      The method __construct has a boolean flag argument $associationMember, which is a certain sign of a Single Responsibility Principle violation.
      Open

              ?bool $associationMember = false

      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

      Avoid using static access to class 'VSV\GVQ_API\Contest\Repositories\Entities\AddressEmbeddable' in method 'fromContestParticipation'.
      Open

                  $address = AddressEmbeddable::fromAddress(
                      $contestParticipation->getAddress()
                  );

      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

      Avoid using static access to class 'VSV\GVQ_API\Contest\Repositories\Entities\ContestParticipantEmbeddable' in method 'fromContestParticipation'.
      Open

                  ContestParticipantEmbeddable::fromContestParticipation(
                      $contestParticipation->getContestParticipant()
                  ),

      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

      Avoid using static access to class '\Ramsey\Uuid\Uuid' in method 'toContestParticipation'.
      Open

                  Uuid::fromString($this->getId()),

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

              } else {
                  $address = new AddressEmbeddable(
                      '',
                      '',
                      '',

      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

              string $id,

      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

      There are no issues that match your filters.

      Category
      Status