Completed
Push — main ( 9e586c...e73d1c )
by Leonard
03:31
created

PurchaseResponse::getRedirectUrl()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
crap 1
1
<?php
2
3
namespace Omnipay\Yoomoney\Message;
4
5
use Omnipay\Common\Message\AbstractResponse;
6
use Omnipay\Common\Message\RedirectResponseInterface;
7
8
class PurchaseResponse extends AbstractResponse implements RedirectResponseInterface
9
{
10
11 3
    public function isSuccessful()
12
    {
13 3
        return false;
14
    }
15
16 3
    public function isRedirect()
17
    {
18 3
        return true;
19
    }
20
21 3
    public function getRedirectUrl()
22
    {
23 3
        return $this->getRequest()->getEndpoint();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Omnipay\Common\Message\RequestInterface as the method getEndpoint() does only exist in the following implementations of said interface: Omnipay\Yoomoney\Message\AbstractRequest, Omnipay\Yoomoney\Message\CompletePurchaseRequest, Omnipay\Yoomoney\Message\PurchaseRequest, Omnipay\Yoomoney\Message\ServerNotifyRequest.

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...
24
    }
25
26 3
    public function getRedirectMethod()
27
    {
28 3
        return 'GET';
29
    }
30
31
    public function getRedirectData()
32
    {
33
        return $this->data;
34
    }
35
}
36