PurchaseResponse   A
last analyzed

Complexity

Total Complexity 6

Size/Duplication

Total Lines 35
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 1

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 6
lcom 1
cbo 1
dl 0
loc 35
ccs 12
cts 12
cp 1
rs 10
c 0
b 0
f 0

6 Methods

Rating   Name   Duplication   Size   Complexity  
A isSuccessful() 0 4 1
A isRedirect() 0 4 1
A getRedirectUrl() 0 4 1
A getRedirectMethod() 0 4 1
A getRedirectData() 0 4 1
A getMessage() 0 4 1
1
<?php
2
3
namespace Omnipay\BPOINT\Message;
4
5
use Omnipay\Common\Message\AbstractResponse;
6
use Omnipay\Common\Message\RedirectResponseInterface;
7
8
/**
9
 * BPOINT Purchase Response
10
 */
11
class PurchaseResponse extends AbstractResponse implements RedirectResponseInterface
12 3
{
13
    public function isSuccessful()
14 3
    {
15
        return false;
16
    }
17 3
18
    public function isRedirect()
19 3
    {
20
        return $this->data['APIResponse']['ResponseCode'] == 0;
21
    }
22 3
23
    public function getRedirectUrl()
24 3
    {
25
        return 'https://www.bpoint.com.au/pay/'.$this->getRequest()->getMerchantShortName();
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 getMerchantShortName() does only exist in the following implementations of said interface: Omnipay\BPOINT\Message\CompletePurchaseRequest, Omnipay\BPOINT\Message\PurchaseRequest.

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...
26
    }
27 1
28
    public function getRedirectMethod()
29 1
    {
30
        return 'GET';
31
    }
32 1
33
    public function getRedirectData()
34 1
    {
35
        return array('in_pay_token' => $this->data['AuthKey']);
36
    }
37
38
    /**
39
     * Description of the response; mostly only relevant in the error case when not redirecting
40 3
     */
41
    public function getMessage()
42 3
    {
43
        return $this->data['APIResponse']['ResponseText'];
44
    }
45
}
46