Completed
Push — master ( 704539...2a5253 )
by Robbie
02:16
created

src/HttpResponseAdapter.php (2 issues)

strict.coding_against_concrete_implementation

Bug Minor

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
namespace Robbie\Psr7;
4
5
use GuzzleHttp\Psr7\Response;
6
use Psr\Http\Message\ResponseInterface;
7
use Robbie\Psr7\AbstractHttpAdapter;
8
use SilverStripe\Control\HTTPResponse;
9
10
/**
11
 * @package psr7-adapters
12
 */
13
class HttpResponseAdapter extends AbstractHttpAdapter
14
{
15
    /**
16
     * {@inheritDoc}
17
     */
18
    public function toPsr7($input)
19
    {
20
        return new Response(
21
            $input->getStatusCode(),
22
            $input->getHeaders(),
23
            $input->getBody(),
24
            $this->getProtocolVersion(),
25
            $input->getStatusDescription()
26
        );
27
    }
28
29
    /**
30
     * {@inheritDoc}
31
     */
32
    public function fromPsr7($input)
33
    {
34
        $adapted = new HTTPResponse(
35
            (string) $input->getBody(),
36
            $input->getStatusCode(),
0 ignored issues
show
It seems like you code against a concrete implementation and not the interface Psr\Http\Message\MessageInterface as the method getStatusCode() does only exist in the following implementations of said interface: GuzzleHttp\Psr7\Response.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
37
            $input->getReasonPhrase()
0 ignored issues
show
It seems like you code against a concrete implementation and not the interface Psr\Http\Message\MessageInterface as the method getReasonPhrase() does only exist in the following implementations of said interface: GuzzleHttp\Psr7\Response.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
38
        );
39
40
        $this->importHeaders($input, $adapted);
41
42
        return $adapted;
43
    }
44
}
45