PurchaseRequest::sendData() - Code Metrics - Inspection of "Update" - PatronBase/omnipay-worldline - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 67f80d...eb72a4 )

by Leith

created 2025-07-28 04:34 UTC

PurchaseRequest::sendData() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	26
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	2
eloc	17
c	2
b	0
f	0
nc	2
nop	1
dl	0
loc	26
rs	9.7

<?php

namespace Omnipay\Worldline\Message;

/**
 * Worldline Purchase Request
 *
 * @see https://docs.direct.worldline-solutions.com/en/api-reference#tag/HostedCheckout/operation/CreateHostedCheckoutApi
 */
class PurchaseRequest extends AbstractRequest
{
    /** @var string  Can be "FINAL_AUTHORIZATION" "PRE_AUTHORIZATION" or "SALE" */
    protected $authorizationMode = 'SALE';
    protected $requestMethod = 'POST';

    public function getAvailablePaymentProducts()
    {
        return $this->getParameter('availablePaymentProducts');
    }

    /**
     * @param int[] $value  @see https://docs.direct.worldline-solutions.com/en/payment-methods-and-features/
     */
    public function setAvailablePaymentProducts($value)
    {
        return $this->setParameter('availablePaymentProducts', $value);
    }

    public function getExcludedPaymentProducts()
    {
        return $this->getParameter('excludedPaymentProducts');
    }

    /**
     * @param int[] $value  @see https://docs.direct.worldline-solutions.com/en/payment-methods-and-features/
     */
    public function setExcludedPaymentProducts($value)
    {
        return $this->setParameter('excludedPaymentProducts', $value);
    }

    public function getMerchantName()
    {
        return $this->getParameter('merchantName');
    }

    public function setMerchantName($value)
    {
        return $this->setParameter('merchantName', $value);
    }

    public function getShowResultPage()
    {
        return $this->getParameter('showResultPage');
    }

    public function setShowResultPage($value)
    {
        return $this->setParameter('showResultPage', $value);
    }

    public function getSessionTimeout()
    {
        return $this->getParameter('sessionTimeout');
    }

    /**
     * Timeout is in minutes, default 180
     */
    public function setSessionTimeout($value)
    {
        return $this->setParameter('sessionTimeout', $value);
    }

    public function getTransactionChannel()
    {
        return $this->getParameter('transactionChannel');
    }

    /**
     * Transaction channel can only be either 'ECOMMERCE' or 'MOTO'
     */
    public function setTransactionChannel($value)
    {
        if (!in_array($value, ['ECOMMERCE', 'MOTO'])) {
            $value = null;
        }
        return $this->setParameter('transactionChannel', $value);
    }

    public function getData()
    {
        $this->validate('merchantId', 'amount', 'currency');

        $formattedItems = [];
        $items = $this->getItems();
        if ($items) {
            foreach ($items as $item) {
                $itemPrice = $this->getItemPriceInteger($item);
                $formattedItems[] = [
                    'amountOfMoney' => [
                        'amount' => $item->getQuantity() * $itemPrice,
                        'currencyCode' => $this->getCurrency(),
                    ],
                    'orderLineDetails' => [
                        'productName' => $item->getName(),
                        'productPrice' => $itemPrice,
                        'quantity' => (int) $item->getQuantity(),
                    ],
                ];
            }
        }

        $data = [
            'cardPaymentMethodSpecificInput' => [
                'authorizationMode' => $this->authorizationMode ?? 'SALE',
                'transactionChannel' => $this->getTransactionChannel() ?? 'ECOMMERCE',
            ],
            'hostedCheckoutSpecificInput' => [
                // if adding locale, validate locale against known formats
                // @see https://docs.direct.worldline-solutions.com/en/integration/basic-integration-methods/hosted-checkout-page#chooselanguageversion
                // 'locale' => 'en_UK',
                'returnUrl' => $this->getReturnUrl(),
            ],
            'order' => [
                'amountOfMoney' => [
                    'amount' => $this->getAmountInteger(),
                    'currencyCode' => $this->getCurrency(),
                ],
                'references' => [
                    'descriptor' => $this->getMerchantName(),
                    'merchantReference' => $this->getTransactionId(),
                ],
                'shoppingCart' => [
                    'items' => $formattedItems,
                ],
            ],
        ];

        if ($this->getAvailablePaymentProducts() !== null) {
            if (!isset($data['hostedCheckoutSpecificInput']['paymentProductFilters'])) {
                $data['hostedCheckoutSpecificInput']['paymentProductFilters'] = [];
            }
            $data['hostedCheckoutSpecificInput']['paymentProductFilters']['restrictTo'] = [
                'products' => $this->getAvailablePaymentProducts(),
            ];
        }

        if ($this->getExcludedPaymentProducts() !== null) {
            if (!isset($data['hostedCheckoutSpecificInput']['paymentProductFilters'])) {
                $data['hostedCheckoutSpecificInput']['paymentProductFilters'] = [];
            }
            $data['hostedCheckoutSpecificInput']['paymentProductFilters']['exclude'] = [
                'products' => $this->getExcludedPaymentProducts(),
            ];
        }

        if ($this->getShowResultPage() !== null) {
            $data['hostedCheckoutSpecificInput']['showResultPage'] = (bool) $this->getShowResultPage();
        }

        if ($this->getSessionTimeout() !== null) {
            $data['hostedCheckoutSpecificInput']['sessionTimeout'] = (int) $this->getSessionTimeout();
        }

        if ($this->getNotifyUrl() !== null) {

            $data['feedbacks'] = [
                'webhookUrl' => $this->getNotifyUrl(),
            ];
        }

        return $data;
    }

    protected function createResponse($data)
    {
        return $this->response = new PurchaseResponse($this, json_decode($data));
    }

    protected function getAction()
    {
        return '/v2/'.$this->getMerchantId().'/hostedcheckouts';
    }
}


1			<?php
2
3			namespace Omnipay\Worldline\Message;
4
5			/**
6			* Worldline Purchase Request
7			*
8			* @see https://docs.direct.worldline-solutions.com/en/api-reference#tag/HostedCheckout/operation/CreateHostedCheckoutApi
9			*/
10			class PurchaseRequest extends AbstractRequest
11			{
12			/** @var string Can be "FINAL_AUTHORIZATION" "PRE_AUTHORIZATION" or "SALE" */
13			protected $authorizationMode = 'SALE';
14			protected $requestMethod = 'POST';
15
16			public function getAvailablePaymentProducts()
17			{
18			return $this->getParameter('availablePaymentProducts');
19			}
20
21			/**
22			* @param int[] $value @see https://docs.direct.worldline-solutions.com/en/payment-methods-and-features/
23			*/
24			public function setAvailablePaymentProducts($value)
25			{
26			return $this->setParameter('availablePaymentProducts', $value);
27			}
28
29			public function getExcludedPaymentProducts()
30			{
31			return $this->getParameter('excludedPaymentProducts');
32			}
33
34			/**
35			* @param int[] $value @see https://docs.direct.worldline-solutions.com/en/payment-methods-and-features/
36			*/
37			public function setExcludedPaymentProducts($value)
38			{
39			return $this->setParameter('excludedPaymentProducts', $value);
40			}
41
42			public function getMerchantName()
43			{
44			return $this->getParameter('merchantName');
45			}
46
47			public function setMerchantName($value)
48			{
49			return $this->setParameter('merchantName', $value);
50			}
51
52			public function getShowResultPage()
53			{
54			return $this->getParameter('showResultPage');
55			}
56
57			public function setShowResultPage($value)
58			{
59			return $this->setParameter('showResultPage', $value);
60			}
61
62			public function getSessionTimeout()
63			{
64			return $this->getParameter('sessionTimeout');
65			}
66
67			/**
68			* Timeout is in minutes, default 180
69			*/
70			public function setSessionTimeout($value)
71			{
72			return $this->setParameter('sessionTimeout', $value);
73			}
74
75			public function getTransactionChannel()
76			{
77			return $this->getParameter('transactionChannel');
78			}
79
80			/**
81			* Transaction channel can only be either 'ECOMMERCE' or 'MOTO'
82			*/
83			public function setTransactionChannel($value)
84			{
85			if (!in_array($value, ['ECOMMERCE', 'MOTO'])) {
86			$value = null;
87			}
88			return $this->setParameter('transactionChannel', $value);
89			}
90
91			public function getData()
92			{
93			$this->validate('merchantId', 'amount', 'currency');
94
95			$formattedItems = [];
96			$items = $this->getItems();
97			if ($items) {
98			foreach ($items as $item) {
99			$itemPrice = $this->getItemPriceInteger($item);
100			$formattedItems[] = [
101			'amountOfMoney' => [
102			'amount' => $item->getQuantity() * $itemPrice,
103			'currencyCode' => $this->getCurrency(),
104			],
105			'orderLineDetails' => [
106			'productName' => $item->getName(),
107			'productPrice' => $itemPrice,
108			'quantity' => (int) $item->getQuantity(),
109			],
110			];
111			}
112			}
113
114			$data = [
115			'cardPaymentMethodSpecificInput' => [
116			'authorizationMode' => $this->authorizationMode ?? 'SALE',
117			'transactionChannel' => $this->getTransactionChannel() ?? 'ECOMMERCE',
118			],
119			'hostedCheckoutSpecificInput' => [
120			// if adding locale, validate locale against known formats
121			// @see https://docs.direct.worldline-solutions.com/en/integration/basic-integration-methods/hosted-checkout-page#chooselanguageversion
122			// 'locale' => 'en_UK',
123			'returnUrl' => $this->getReturnUrl(),
124			],
125			'order' => [
126			'amountOfMoney' => [
127			'amount' => $this->getAmountInteger(),
128			'currencyCode' => $this->getCurrency(),
129			],
130			'references' => [
131			'descriptor' => $this->getMerchantName(),
132			'merchantReference' => $this->getTransactionId(),
133			],
134			'shoppingCart' => [
135			'items' => $formattedItems,
136			],
137			],
138			];
139
140			if ($this->getAvailablePaymentProducts() !== null) {
141			if (!isset($data['hostedCheckoutSpecificInput']['paymentProductFilters'])) {
142			$data['hostedCheckoutSpecificInput']['paymentProductFilters'] = [];
143			}
144			$data['hostedCheckoutSpecificInput']['paymentProductFilters']['restrictTo'] = [
145			'products' => $this->getAvailablePaymentProducts(),
146			];
147			}
148
149			if ($this->getExcludedPaymentProducts() !== null) {
150			if (!isset($data['hostedCheckoutSpecificInput']['paymentProductFilters'])) {
151			$data['hostedCheckoutSpecificInput']['paymentProductFilters'] = [];
152			}
153			$data['hostedCheckoutSpecificInput']['paymentProductFilters']['exclude'] = [
154			'products' => $this->getExcludedPaymentProducts(),
155			];
156			}
157
158			if ($this->getShowResultPage() !== null) {
159			$data['hostedCheckoutSpecificInput']['showResultPage'] = (bool) $this->getShowResultPage();
160			}
161
162			if ($this->getSessionTimeout() !== null) {
163			$data['hostedCheckoutSpecificInput']['sessionTimeout'] = (int) $this->getSessionTimeout();
164			}
165
166			if ($this->getNotifyUrl() !== null) {
			0 ignored issues – show introduced 2025-04-30 11:57 UTC by Report Bug Copy Issue Report The condition `$this->getNotifyUrl() !== null` is always `true`. Loading history...
167			$data['feedbacks'] = [
168			'webhookUrl' => $this->getNotifyUrl(),
169			];
170			}
171
172			return $data;
173			}
174
175			protected function createResponse($data)
176			{
177			return $this->response = new PurchaseResponse($this, json_decode($data));
178			}
179
180			protected function getAction()
181			{
182			return '/v2/'.$this->getMerchantId().'/hostedcheckouts';
183			}
184			}
185

PatronBase / omnipay-worldline

Push — main ( 67f80d...eb72a4 )

PurchaseRequest::sendData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like