Completed
Push — master ( 0dbe68...17d58d )
by Florian
04:25
created

PlaceOrder   A

Complexity

Total Complexity 9

Size/Duplication

Total Lines 99
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 1

Importance

Changes 0
Metric Value
wmc 9
lcom 1
cbo 1
dl 0
loc 99
rs 10
c 0
b 0
f 0

4 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 11 1
B execute() 0 25 4
A placeOrder() 0 16 2
A isValidationRequired() 0 4 2
1
<?php
2
3
/**
4
 * PAYONE Magento 2 Connector is free software: you can redistribute it and/or modify
5
 * it under the terms of the GNU Lesser General Public License as published by
6
 * the Free Software Foundation, either version 3 of the License, or
7
 * (at your option) any later version.
8
 *
9
 * PAYONE Magento 2 Connector is distributed in the hope that it will be useful,
10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
 * GNU Lesser General Public License for more details.
13
 *
14
 * You should have received a copy of the GNU Lesser General Public License
15
 * along with PAYONE Magento 2 Connector. If not, see <http://www.gnu.org/licenses/>.
16
 *
17
 * PHP version 5
18
 *
19
 * @category  Payone
20
 * @package   Payone_Magento2_Plugin
21
 * @author    FATCHIP GmbH <[email protected]>
22
 * @copyright 2003 - 2017 Payone GmbH
23
 * @license   <http://www.gnu.org/licenses/> GNU Lesser General Public License
24
 * @link      http://www.payone.de
25
 */
26
27
namespace Payone\Core\Controller\Onepage;
28
29
/**
30
 * Controller for creating the PaypalExpress orders
31
 */
32
class PlaceOrder extends \Magento\Framework\App\Action\Action
33
{
34
    /**
35
     * @var \Magento\Checkout\Api\AgreementsValidatorInterface
36
     */
37
    protected $agreementsValidator;
38
39
    /**
40
     * @var \Magento\Checkout\Model\Session
41
     */
42
    protected $checkoutSession;
43
44
    /**
45
     * @var \Magento\Quote\Api\CartManagementInterface
46
     */
47
    protected $cartManagement;
48
49
    /**
50
     * @param \Magento\Framework\App\Action\Context              $context
51
     * @param \Magento\Checkout\Api\AgreementsValidatorInterface $agreementValidator
52
     * @param \Magento\Checkout\Model\Session                    $checkoutSession
53
     * @param \Magento\Quote\Api\CartManagementInterface         $cartManagement
54
     */
55
    public function __construct(
56
        \Magento\Framework\App\Action\Context $context,
57
        \Magento\Checkout\Api\AgreementsValidatorInterface $agreementValidator,
58
        \Magento\Checkout\Model\Session $checkoutSession,
59
        \Magento\Quote\Api\CartManagementInterface $cartManagement
60
    ) {
61
        $this->agreementsValidator = $agreementValidator;
62
        $this->checkoutSession = $checkoutSession;
63
        $this->cartManagement = $cartManagement;
64
        parent::__construct($context);
65
    }
66
67
    /**
68
     * Submit the order
69
     *
70
     * @return void
71
     * @throws \Magento\Framework\Exception\LocalizedException
72
     */
73
    public function execute()
74
    {
75
        if ($this->isValidationRequired() &&
76
            !$this->agreementsValidator->isValid(array_keys($this->getRequest()->getPost('agreement', [])))
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Magento\Framework\App\RequestInterface as the method getPost() does only exist in the following implementations of said interface: Magento\Framework\App\Request\Http, Magento\Framework\Webapi\Request, Magento\Framework\Webapi\Rest\Request.

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...
77
        ) {
78
            $e = new \Magento\Framework\Exception\LocalizedException(
79
                __('Please agree to all the terms and conditions before placing the order.')
80
            );
81
            $this->messageManager->addExceptionMessage($e, $e->getMessage());
82
            $this->_redirect('*/*/review');
83
            return;
84
        }
85
86
        try {
87
            $this->placeOrder();
88
89
            $this->_redirect('checkout/onepage/success');
90
        } catch (\Exception $e) {
91
            $this->messageManager->addExceptionMessage(
92
                $e,
93
                __('We can\'t place the order.')
94
            );
95
            $this->_redirect('*/*/review');
96
        }
97
    }
98
99
    /**
100
     * Place the order and put it in a finished state
101
     *
102
     * @return void
103
     */
104
    protected function placeOrder()
105
    {
106
        $oQuote = $this->checkoutSession->getQuote();
107
        $oQuote->getBillingAddress()->setShouldIgnoreValidation(true);
108
        if (!$oQuote->getIsVirtual()) {
109
            $oQuote->getShippingAddress()->setShouldIgnoreValidation(true);
110
        }
111
112
        $this->cartManagement->placeOrder($oQuote->getId());
113
114
        // "last successful quote"
115
        $sQuoteId = $oQuote->getId();
116
        $this->checkoutSession->setLastQuoteId($sQuoteId)->setLastSuccessQuoteId($sQuoteId)->unsPayoneWorkorderId();
117
118
        $oQuote->setIsActive(false)->save();
119
    }
120
121
    /**
122
     * Return true if agreements validation required
123
     *
124
     * @return bool
125
     */
126
    protected function isValidationRequired()
127
    {
128
        return is_array($this->getRequest()->getBeforeForwardInfo()) && empty($this->getRequest()->getBeforeForwardInfo());
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Magento\Framework\App\RequestInterface as the method getBeforeForwardInfo() does only exist in the following implementations of said interface: Magento\Framework\App\Request\Http.

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...
129
    }
130
}
131