Completed
Push — master ( 4ad486...2231e0 )
by Paweł
19:28 queued 09:00
created

__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
1
<?php
2
3
/*
4
 * This file is part of the Sylius package.
5
 *
6
 * (c) Paweł Jędrzejewski
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Sylius\Component\Core\Checker;
13
14
use Sylius\Component\Core\Model\OrderInterface;
15
use Sylius\Component\Core\Model\PaymentInterface;
16
use Sylius\Component\Payment\Resolver\PaymentMethodsResolverInterface;
17
18
/**
19
 * @author Mateusz Zalewski <[email protected]>
20
 */
21
final class OrderPaymentMethodSelectionRequirementChecker implements OrderPaymentMethodSelectionRequirementCheckerInterface
22
{
23
    /**
24
     * @var PaymentMethodsResolverInterface
25
     */
26
    private $paymentMethodsResolver;
27
28
    public function __construct(PaymentMethodsResolverInterface $paymentMethodsResolver)
29
    {
30
        $this->paymentMethodsResolver = $paymentMethodsResolver;
31
    }
32
33
    /**
34
     * {@inheritdoc}
35
     */
36
    public function isPaymentMethodSelectionRequired(OrderInterface $order)
37
    {
38
        if ($order->getTotal() <= 0) {
39
            return false;
40
        }
41
42
        if (!$order->getChannel()->isSkippingPaymentStepAllowed()) {
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Sylius\Component\Channel\Model\ChannelInterface as the method isSkippingPaymentStepAllowed() does only exist in the following implementations of said interface: Sylius\Component\Core\Model\Channel.

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...
43
            return true;
44
        }
45
46
        foreach ($order->getPayments() as $payment) {
47
            if (count($this->paymentMethodsResolver->getSupportedMethods($payment)) !== 1) {
48
                return true;
49
            }
50
        }
51
52
        return false;
53
    }
54
}
55