Sign upLogin

netglue/prismic-php-kit

View on GitHub
Star
src/Prismic/SearchForm.php

Summary

Maintainability
B
4 hrs
Test Coverage
A
97%

The class SearchForm has 13 public methods. Consider refactoring SearchForm to keep number of public methods under 10.
Open

class SearchForm
{

    /**
     * @var Api
Severity: Minor
Found in src/Prismic/SearchForm.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

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

    public function set(string $key, $value) : self
    {
        if (empty($key)) {
            throw new Exception\InvalidArgumentException('Form parameter key must be a non-empty string');
        }
Severity: Minor
Found in src/Prismic/SearchForm.php - About 1 hr to fix

    Method submit has 35 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function submit() : Response
    {
        if ($this->form->getMethod() !== 'GET' ||
            $this->form->getEnctype() !== 'application/x-www-form-urlencoded' ||
            ! $this->form->getAction()
    Severity: Minor
    Found in src/Prismic/SearchForm.php - About 1 hr to fix

      Function set has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

          public function set(string $key, $value) : self
    {
        if (empty($key)) {
            throw new Exception\InvalidArgumentException('Form parameter key must be a non-empty string');
        }
      Severity: Minor
      Found in src/Prismic/SearchForm.php - About 55 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 submit has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          public function submit() : Response
    {
        if ($this->form->getMethod() !== 'GET' ||
            $this->form->getEnctype() !== 'application/x-www-form-urlencoded' ||
            ! $this->form->getAction()
      Severity: Minor
      Found in src/Prismic/SearchForm.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

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

          public function set(string $key, $value) : self
    {
        if (empty($key)) {
            throw new Exception\InvalidArgumentException('Form parameter key must be a non-empty string');
        }
      Severity: Minor
      Found in src/Prismic/SearchForm.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 set() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
      Open

          public function set(string $key, $value) : self
    {
        if (empty($key)) {
            throw new Exception\InvalidArgumentException('Form parameter key must be a non-empty string');
        }
      Severity: Minor
      Found in src/Prismic/SearchForm.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 SearchForm has a coupling between objects value of 19. Consider to reduce the number of dependencies under 13.
      Open

      class SearchForm
{

    /**
     * @var Api
      Severity: Minor
      Found in src/Prismic/SearchForm.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 'Prismic\Response' in method 'submit'.
      Open

              return Response::fromJsonObject($json, $this->api->getHydrator());
      Severity: Minor
      Found in src/Prismic/SearchForm.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

      Avoid using static access to class 'Prismic\Api' in method 'getCacheItem'.
      Open

                  $key = Api::generateCacheKey($this->url());
      Severity: Minor
      Found in src/Prismic/SearchForm.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 set uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              } else {
            $data[$key] = $value;
        }
      Severity: Minor
      Found in src/Prismic/SearchForm.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 using static access to class 'Prismic\Response' in method 'submit'.
      Open

                  return Response::fromJsonObject($json, $this->api->getHydrator());
      Severity: Minor
      Found in src/Prismic/SearchForm.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

      Avoid using static access to class '\Prismic\Exception\RequestFailureException' in method 'submit'.
      Open

                  throw Exception\RequestFailureException::fromGuzzleException($guzzleException);
      Severity: Minor
      Found in src/Prismic/SearchForm.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

      @throws annotation of ref has suspicious interface type \Prismic\Exception\exceptioninterface for an @throws annotation, expected class (PHP allows interfaces to be caught, so this might be intentional)
      Open

          public function ref($ref) : self
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      @throws annotation of after has suspicious interface type \Prismic\Exception\exceptioninterface for an @throws annotation, expected class (PHP allows interfaces to be caught, so this might be intentional)
      Open

          public function after(string $documentId) : self
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      @throws annotation of set has suspicious interface type \Prismic\Exception\exceptioninterface for an @throws annotation, expected class (PHP allows interfaces to be caught, so this might be intentional)
      Open

          public function set(string $key, $value) : self
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      @throws annotation of page has suspicious interface type \Prismic\Exception\exceptioninterface for an @throws annotation, expected class (PHP allows interfaces to be caught, so this might be intentional)
      Open

          public function page(int $page) : self
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      @throws annotation of count has suspicious interface type \Prismic\Exception\exceptioninterface for an @throws annotation, expected class (PHP allows interfaces to be caught, so this might be intentional)
      Open

          public function count() :? int
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      @throws annotation of pageSize has suspicious interface type \Prismic\Exception\exceptioninterface for an @throws annotation, expected class (PHP allows interfaces to be caught, so this might be intentional)
      Open

          public function pageSize(int $pageSize) : self
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      @throws annotation of orderings has suspicious interface type \Prismic\Exception\exceptioninterface for an @throws annotation, expected class (PHP allows interfaces to be caught, so this might be intentional)
      Open

          public function orderings(string ...$fields) : self
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      @throws annotation of lang has suspicious interface type \Prismic\Exception\exceptioninterface for an @throws annotation, expected class (PHP allows interfaces to be caught, so this might be intentional)
      Open

          public function lang(string $lang) : self
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      @throws annotation of fetch has suspicious interface type \Prismic\Exception\exceptioninterface for an @throws annotation, expected class (PHP allows interfaces to be caught, so this might be intentional)
      Open

          public function fetch(string ...$fields) : self
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      @throws annotation of fetchLinks has suspicious interface type \Prismic\Exception\exceptioninterface for an @throws annotation, expected class (PHP allows interfaces to be caught, so this might be intentional)
      Open

          public function fetchLinks(string ...$fields) : self
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      @throws annotation of query has suspicious interface type \Prismic\Exception\exceptioninterface for an @throws annotation, expected class (PHP allows interfaces to be caught, so this might be intentional)
      Open

          public function query(...$params) : self
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      Call to method save from undeclared class \Psr\Cache\CacheItemPoolInterface
      Open

              $this->api->getCache()->save($cacheItem);
      Severity: Critical
      Found in src/Prismic/SearchForm.php by phan

      Call to method getItem from undeclared class \Psr\Cache\CacheItemPoolInterface
      Open

                  return $this->api->getCache()->getItem($key);
      Severity: Critical
      Found in src/Prismic/SearchForm.php by phan

      Call to method isHit from undeclared class \Psr\Cache\CacheItemInterface
      Open

              if ($cacheItem->isHit()) {
      Severity: Critical
      Found in src/Prismic/SearchForm.php by phan

      Call to method get from undeclared class \Psr\Cache\CacheItemInterface
      Open

                  $json = $cacheItem->get();
      Severity: Critical
      Found in src/Prismic/SearchForm.php by phan

      Catching undeclared class \GuzzleHttp\Exception\GuzzleException
      Open

              } catch (GuzzleException $guzzleException) {
      Severity: Critical
      Found in src/Prismic/SearchForm.php by phan

      Call to method request from undeclared class \GuzzleHttp\ClientInterface
      Open

                  $response = $this->api->getHttpClient()->request('GET', $url);
      Severity: Critical
      Found in src/Prismic/SearchForm.php by phan

      Call to method set from undeclared class \Psr\Cache\CacheItemInterface
      Open

              $cacheItem->set($json);
      Severity: Critical
      Found in src/Prismic/SearchForm.php by phan

      Return type of getCacheItem() is undeclared type \Psr\Cache\CacheItemInterface
      Open

          private function getCacheItem() : CacheItemInterface
      Severity: Minor
      Found in src/Prismic/SearchForm.php by phan

      Catching undeclared class \Psr\Cache\CacheException
      Open

              } catch (CacheException $cacheException) {
      Severity: Critical
      Found in src/Prismic/SearchForm.php by phan

      Call to method expiresAfter from undeclared class \Psr\Cache\CacheItemInterface
      Open

                  $cacheItem->expiresAfter($cacheDuration);
      Severity: Critical
      Found in src/Prismic/SearchForm.php by phan

      There are no issues that match your filters.

      Category
      Status