Passed
Pull Request — master (#305)
by
unknown
02:24
created

OrderPaymentPlaceEnd   A

Complexity

Total Complexity 8

Size/Duplication

Total Lines 93
Duplicated Lines 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 27
dl 0
loc 93
rs 10
c 1
b 0
f 0
wmc 8

4 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A clearSession() 0 8 4
A execute() 0 9 1
A handleOrderStatus() 0 9 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 - 2016 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\Observer;
28
29
use Magento\Sales\Model\Order;
0 ignored issues
show
Bug introduced by
The type Magento\Sales\Model\Order was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
30
use Magento\Framework\Event\ObserverInterface;
0 ignored issues
show
Bug introduced by
The type Magento\Framework\Event\ObserverInterface was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
31
use Magento\Framework\Event\Observer;
0 ignored issues
show
Bug introduced by
The type Magento\Framework\Event\Observer was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
32
use Payone\Core\Helper\Consumerscore;
33
use Magento\Sales\Model\Order\Payment;
0 ignored issues
show
Bug introduced by
The type Magento\Sales\Model\Order\Payment was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
34
use Magento\Checkout\Model\Session;
0 ignored issues
show
Bug introduced by
The type Magento\Checkout\Model\Session was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
35
36
/**
37
 * Event class to set the orderstatus to new and pending
38
 */
39
class OrderPaymentPlaceEnd implements ObserverInterface
40
{
41
    /**
42
     * PAYONE payment helper
43
     *
44
     * @var Consumerscore
45
     */
46
    protected $consumerscoreHelper;
47
48
    /**
49
     * Checkout session object
50
     *
51
     * @var Session
52
     */
53
    protected $checkoutSession;
54
55
    /**
56
     * Array of keys to remove from session after payment was successful
57
     *
58
     * @var array
59
     */
60
    protected $aCheckoutSessionClearList = [
61
        'is_payone_redirect_cancellation',
62
        'amazon_workorder_id',
63
        'amazon_address_token',
64
        'amazon_reference_id',
65
        'order_reference_details_executed',
66
        'trigger_invalid_payment',
67
68
    ];
69
70
    /**
71
     * Constructor
72
     *
73
     * @param Consumerscore $consumerscoreHelper
74
     * @param Session       $checkoutSession
75
     */
76
    public function __construct(Consumerscore $consumerscoreHelper, Session $checkoutSession)
77
    {
78
        $this->consumerscoreHelper = $consumerscoreHelper;
79
        $this->checkoutSession = $checkoutSession;
80
    }
81
82
    /**
83
     * Handle order status
84
     *
85
     * @param  Observer $observer
86
     * @return void
87
     */
88
    protected function handleOrderStatus(Observer $observer)
89
    {
90
        /** @var Payment $oPayment */
91
        $oPayment = $observer->getEvent()->getPayment();
92
        $oPaymentInstance = $oPayment->getMethodInstance();
93
        if (stripos($oPaymentInstance->getCode(), 'payone') !== false) {
94
            $oOrder = $oPayment->getOrder();
95
            $oOrder->setState(Order::STATE_NEW);
96
            $oOrder->setStatus($oPaymentInstance->getConfigData('order_status'));
97
        }
98
    }
99
100
    /**
101
     * Execute certain tasks after the payment is placed and thus the order is placed
102
     *
103
     * @param  Observer $observer
104
     * @return void
105
     */
106
    public function execute(Observer $observer)
107
    {
108
        // set status to new - pending on new orders
109
        $this->handleOrderStatus($observer);
110
111
        // increment counter for every order, needed for the A/B test feature
112
        $this->consumerscoreHelper->incrementConsumerscoreSampleCounter();
113
114
        $this->clearSession($this->checkoutSession, $this->aCheckoutSessionClearList);
115
    }
116
117
    /**
118
     * Unset given keys from session object
119
     *
120
     * @param  Session $oSession
121
     * @param  array   $aClearParamList
122
     * @return void
123
     */
124
    protected function clearSession($oSession, $aClearParamList)
125
    {
126
        $aSessionData = $oSession->getData();
127
        foreach ($aSessionData as $sKey => $sValue) {
128
            foreach ($aClearParamList as $sDeleteKey) {
129
                if (stripos($sKey, $sDeleteKey) !== false) {
130
                    $oSession->unsetData($sKey);
131
                    break;
132
                }
133
            }
134
        }
135
    }
136
}
137