longitude-one/doctrine-spatial

View on GitHub
lib/LongitudeOne/Spatial/PHP/Types/AbstractPoint.php

Summary

Maintainability
C
1 day
Test Coverage
A
99%

Function validateArguments has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
Open

    protected function validateArguments(array $argv, string $caller): array
    {
        $argc = count($argv);

        if (1 == $argc && is_array($argv[0])) {
Severity: Minor
Found in lib/LongitudeOne/Spatial/PHP/Types/AbstractPoint.php - About 3 hrs 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 AbstractPoint has an overall complexity of 58 which is very high. The configured complexity threshold is 50.
Open

abstract class AbstractPoint extends AbstractGeometry implements PointInterface
{
    /**
     * The X coordinate or the longitude.
     */

Method validateArguments has 32 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function validateArguments(array $argv, string $caller): array
    {
        $argc = count($argv);

        if (1 == $argc && is_array($argv[0])) {
Severity: Minor
Found in lib/LongitudeOne/Spatial/PHP/Types/AbstractPoint.php - About 1 hr to fix

    Consider simplifying this complex logical expression.
    Open

                if ((is_numeric($argv[0]) || is_string($argv[0]))
                    && (is_numeric($argv[1]) || is_string($argv[1]))
                    && (is_numeric($argv[2]) || null === $argv[2] || is_string($argv[2]))
                ) {
                    return $argv;
    Severity: Major
    Found in lib/LongitudeOne/Spatial/PHP/Types/AbstractPoint.php - About 1 hr to fix

      The method validateArguments() has an NPath complexity of 3276. The configured NPath complexity threshold is 200.
      Open

          protected function validateArguments(array $argv, string $caller): array
          {
              $argc = count($argv);
      
              if (1 == $argc && is_array($argv[0])) {

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

          protected function validateArguments(array $argv, string $caller): array
          {
              $argc = count($argv);
      
              if (1 == $argc && is_array($argv[0])) {

      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 createException has a boolean flag argument $subArray, which is a certain sign of a Single Responsibility Principle violation.
      Open

          private function createException(array $argv, string $caller, bool $subArray = false): InvalidValueException

      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

      Identical blocks of code found in 2 locations. Consider refactoring.
      Open

                  if ((is_numeric($argv[0]) || is_string($argv[0])) && (is_numeric($argv[1]) || is_string($argv[1]))) {
      Severity: Major
      Found in lib/LongitudeOne/Spatial/PHP/Types/AbstractPoint.php and 1 other location - About 1 hr to fix
      lib/LongitudeOne/Spatial/PHP/Types/AbstractPoint.php on lines 220..221

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 57.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Identical blocks of code found in 2 locations. Consider refactoring.
      Open

                  if ((is_numeric($argv[0]) || is_string($argv[0]))
                      && (is_numeric($argv[1]) || is_string($argv[1]))
      Severity: Major
      Found in lib/LongitudeOne/Spatial/PHP/Types/AbstractPoint.php and 1 other location - About 1 hr to fix
      lib/LongitudeOne/Spatial/PHP/Types/AbstractPoint.php on lines 214..214

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 57.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

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

          protected float|int $y;

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

          abstract protected function construct(string $x, string $y, ?int $srid = null): void;

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

          public function setY(float|int|string $y): static

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

          abstract protected function construct(string $x, string $y, ?int $srid = null): void;

      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

      A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line 50 and the first side effect is on line 33.
      Open

      <?php

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

          public function setX(float|int|string $x): static

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

          protected float|int $x;

      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

      Possible parse error: class missing opening or closing brace
      Open

      abstract class AbstractPoint extends AbstractGeometry implements PointInterface

      Scope keyword "static" must be followed by a single space
      Open

          public function setLongitude(float|int|string $longitude): static

      Scope keyword "static" must be followed by a single space
      Open

          public function setLatitude(float|int|string $latitude): static

      Possible parse error: class missing opening or closing brace
      Open

      abstract class AbstractPoint extends AbstractGeometry implements PointInterface

      Scope keyword "static" must be followed by a single space
      Open

          public function setX(float|int|string $x): static

      Scope keyword "static" must be followed by a single space
      Open

          public function setY(float|int|string $y): static

      Line exceeds 120 characters; contains 129 characters
      Open

                  throw new InvalidValueException(sprintf(InvalidValueException::OUT_OF_RANGE_LATITUDE, $latitude), $e->getCode(), $e);

      Line exceeds 120 characters; contains 130 characters
      Open

                      GeoParserRangeException::SECONDS_OUT_OF_RANGE => sprintf(InvalidValueException::OUT_OF_RANGE_SECOND, $coordinate),

      Line exceeds 120 characters; contains 131 characters
      Open

                  throw new InvalidValueException(sprintf(InvalidValueException::OUT_OF_RANGE_LONGITUDE, $longitude), $e->getCode(), $e);

      Line exceeds 120 characters; contains 133 characters
      Open

                      GeoParserRangeException::LATITUDE_OUT_OF_RANGE => sprintf(InvalidValueException::OUT_OF_RANGE_LATITUDE, $coordinate),

      Line exceeds 120 characters; contains 132 characters
      Open

                  throw new RangeException(sprintf('Coordinate must be comprised between %d and %d, got "%s".', $min, $max, $coordinate));

      Line exceeds 120 characters; contains 130 characters
      Open

                      GeoParserRangeException::MINUTES_OUT_OF_RANGE => sprintf(InvalidValueException::OUT_OF_RANGE_MINUTE, $coordinate),

      Line exceeds 120 characters; contains 124 characters
      Open

                  throw new InvalidValueException(sprintf('Invalid coordinate value, got "%s".', $coordinate), $e->getCode(), $e);

      Line exceeds 120 characters; contains 132 characters
      Open

                  throw new RangeException(sprintf('Coordinate must be comprised between %d and %d, got "%s".', $min, $max, $coordinate));

      Line exceeds 120 characters; contains 135 characters
      Open

                      GeoParserRangeException::LONGITUDE_OUT_OF_RANGE => sprintf(InvalidValueException::OUT_OF_RANGE_LONGITUDE, $coordinate),

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function setLongitude(float|int|string $longitude): static

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              try {

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  foreach ($argv[0] as $value) {

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              if (3 == $argc) {

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          private function geoParse(string $coordinate): float|int

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          protected float|int $x;

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              }

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  if (is_numeric($value) || is_string($value)) {

      Space before opening parenthesis of function call prohibited
      Open

                  $message = match ($e->getCode()) {

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function getLatitude(): float|int

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          protected float|int $y;

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function getLongitude(): float|int

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              try {

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              }

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              if (2 == $argc) {

      Closing brace indented incorrectly; expected 8 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function getX(): float|int

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              } catch (RangeException $e) {

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              if (1 == $argc && is_array($argv[0])) {

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  if ($count < 2 || $count > 3) {

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function __construct()

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function toArray(): array

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  }

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              } catch (GeoParserRangeException $e) {

      Line indented incorrectly; expected 8 spaces, found 16
      Open

                      default => $e->getMessage(),

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function setY(float|int|string $y): static

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          private function createException(array $argv, string $caller, bool $subArray = false): InvalidValueException

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              });

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              if ($subArray) {

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  }

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              try {

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  if (is_array($argv[0]) && (is_numeric($argv[1]) || null === $argv[1] || is_string($argv[1]))) {

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  if ((is_numeric($argv[0]) || is_string($argv[0])) && (is_numeric($argv[1]) || is_string($argv[1]))) {

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  }

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              if ($coordinate < $min || $coordinate > $max) {

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function getY(): float|int

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function setX(float|int|string $x): static

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          }

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  }

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          protected function validateArguments(array $argv, string $caller): array

      Line indented incorrectly; expected 12 spaces, found 16
      Open

                      if (is_numeric($value) || is_string($value)) {

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function setLatitude(float|int|string $latitude): static

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              } catch (RangeException $e) {

      Line indented incorrectly; expected 12 spaces, found 16
      Open

                      }

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  }

      Line indented incorrectly; expected 8 spaces, found 12
      Open

                  if ((is_numeric($argv[0]) || is_string($argv[0]))

      Line indented incorrectly; expected 4 spaces, found 8
      Open

              }

      Closing brace indented incorrectly; expected 4 spaces, found 0
      Open

      }

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          public function getType(): string

      Line indented incorrectly; expected 0 spaces, found 4
      Open

          private function checkRange(float|int $coordinate, int $min, int $max): float|int

      There are no issues that match your filters.

      Category
      Status