PurchaseRequest::getMetadata() - Code Metrics - Inspection of "Changes in PurchaseRequest.php" - PatronBase/omnipay-windcave-hpp - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 022702...f60e44 )

unknown

created 2024-08-28 22:25 UTC

PurchaseRequest::getMetadata() A

↳ Parent: PurchaseRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0

<?php

namespace Omnipay\WindcaveHpp\Message;

use Illuminate\Http\Request;
filter:
    dependency_paths: ["lib/*"]
use Omnipay\Common\Message\AbstractRequest;
use Symfony\Component\HttpFoundation\ParameterBag;

/**
 * Windcave HPP Purchase Request
 */

class PurchaseRequest extends AbstractRequest {

    const endpointTest = 'https://uat.windcave.com/api/v1';
    const endpointLive = 'https://sec.windcave.com/api/v1';

    public function initialize(array $parameters = []) 
    {
        $this->metaData = new ParameterBag();


        return parent::initialize($parameters);
    }

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

    public function getApiUsername()
    {
        return $this->getParameter('apiUsername');
    }

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

    public function getApiKey()
    {
        return $this->getParameter('apiKey');
    }

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

    public function getMerchantReference()
    {
        return $this->getParameter('merchantReference');
    }

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

    public function getType()
    {
        return $this->getParameter('type') ?? 'purchase';
    }

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

    public function getLanguage()
    {
        return $this->getParameter('language') ?? 'en';
    }

    /**
     * @param $list
     * Possible methods: ['card', 'account2account', 'alipay', 'applepay', 'googlepay', 'paypal', 'interac', 'unionpay', 'oxipay', 'visacheckout', 'wechat']
     *
     * @return PurchaseRequest
     */
    public function setPaymentMethods($list)
    {
        return $this->setParameter('paymentMethods', $list);
    }

    public function getPaymentMethods()
    {
        return $this->getParameter('paymentMethods');
    }

    public function setCardTypes($list)
    {
        return $this->setParameter('cardTypes', $list);
    }

    public function getCardTypes()
    {
        return $this->getParameter('cardTypes');
    }

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

    public function getExpiresAt()
    {
        return $this->getParameter('expiresAt');
    }

    public function setDeclineUrl($url)
    {
        return $this->setParameter('declineUrl', $url);
    }

    public function getDeclineUrl()
    {
        return $this->getParameter('declineUrl');
    }

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

    public function getStoreCard()
    {
        return $this->getParameter('storeCard');
    }

    public function setMetadata($data)
    {
        return $this->setParameter('metadata', $data);
    }

    public function getMetadata()
    {
        return $this->getParameter('metadata');
    }

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

        $data = [];

        $data['type'] = $this->getType();
        $data['amount'] = $this->getAmount();
        $data['currency'] = $this->getCurrency();
        $data['storeCard'] = (bool) $this->getStoreCard() ?? false;
        $data['callbackUrls'] = [];

        if ( is_array($this->getPaymentMethods()) ) {
            $data['methods'] = $this->getPaymentMethods();
        }

        if ( is_array($this->getCardTypes()) ) {
            $data['cardTypes'] = $this->getCardTypes();
        }

        if ( is_array($this->getMetadata()) ) {
            $data['metaData'] = $this->getMetadata();
        }

        if ( $this->getMerchantReference() ) {
            $data['merchantReference'] = $this->getMerchantReference();
        }

        if ( $this->getReturnUrl() ) {
            $data['callbackUrls']['approved'] = $this->getReturnUrl();
        }

        if ( $this->getDeclineUrl() ) {
            $data['callbackUrls']['declined'] = $this->getDeclineUrl();
        }

        if ( $this->getCancelUrl() ) {
            $data['callbackUrls']['cancelled'] = $this->getCancelUrl();
        }

        if ( $this->getNotifyUrl() ) {
            $data['notificationUrl'] = $this->getNotifyUrl();
        }

        return $data;
    }

    public function sendData($data)
    {
        $headers = [
            'Accept' => 'application/json',
            'Content-Type' => 'application/json',
            'Authorization' => 'Basic ' . $this->getAuthorization()
        ];

        $httpResponse = $this->httpClient->request('POST', $this->getEndpoint('sessions'), $headers, json_encode($data));

        try {
            $responseData = json_decode($httpResponse->getBody()->getContents());
        } catch (\Exception $exception) {
            $responseData = [];
        }

        return $this->response = new PurchaseResponse($this, $responseData ?? []);
    }

    /**
     * Get endpoint
     *
     * Returns endpoint depending on test mode
     *
     * @access protected
     * @return string
     */
    protected function getEndpoint($path = '')
    {
        return ($this->getTestMode() ? self::endpointTest : self::endpointLive) . '/' . $path;
    }

    protected function getAuthorization()
    {
        return base64_encode($this->getApiUsername().':'.$this->getApiKey());
    }
}

1			<?php
2
3			namespace Omnipay\WindcaveHpp\Message;
4
5			use Illuminate\Http\Request;
			0 ignored issues – show Bug introduced 2024-07-19 16:27 UTC by Report Bug Copy Issue Report The type `Illuminate\Http\Request` 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...
6			use Omnipay\Common\Message\AbstractRequest;
7			use Symfony\Component\HttpFoundation\ParameterBag;
8
9			/**
10			* Windcave HPP Purchase Request
11			*/
12
13			class PurchaseRequest extends AbstractRequest {
14
15			const endpointTest = 'https://uat.windcave.com/api/v1';
16			const endpointLive = 'https://sec.windcave.com/api/v1';
17
18			public function initialize(array $parameters = [])
19			{
20			$this->metaData = new ParameterBag();
			0 ignored issues – show Bug Best Practice introduced 2024-08-28 22:29 UTC by Report Bug Copy Issue Report The property `metaData` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
21
22			return parent::initialize($parameters);
23			}
24
25			public function setApiUsername($value)
26			{
27			return $this->setParameter('apiUsername', $value);
28			}
29
30			public function getApiUsername()
31			{
32			return $this->getParameter('apiUsername');
33			}
34
35			public function setApiKey($value)
36			{
37			return $this->setParameter('apiKey', $value);
38			}
39
40			public function getApiKey()
41			{
42			return $this->getParameter('apiKey');
43			}
44
45			public function setMerchantReference($value)
46			{
47			return $this->setParameter('merchantReference', $value);
48			}
49
50			public function getMerchantReference()
51			{
52			return $this->getParameter('merchantReference');
53			}
54
55			public function setType($value)
56			{
57			return $this->setParameter('type', $value);
58			}
59
60			public function getType()
61			{
62			return $this->getParameter('type') ?? 'purchase';
63			}
64
65			public function setLanguage($value)
66			{
67			return $this->setParameter('language', $value);
68			}
69
70			public function getLanguage()
71			{
72			return $this->getParameter('language') ?? 'en';
73			}
74
75			/**
76			* @param $list
77			* Possible methods: ['card', 'account2account', 'alipay', 'applepay', 'googlepay', 'paypal', 'interac', 'unionpay', 'oxipay', 'visacheckout', 'wechat']
78			*
79			* @return PurchaseRequest
80			*/
81			public function setPaymentMethods($list)
82			{
83			return $this->setParameter('paymentMethods', $list);
84			}
85
86			public function getPaymentMethods()
87			{
88			return $this->getParameter('paymentMethods');
89			}
90
91			public function setCardTypes($list)
92			{
93			return $this->setParameter('cardTypes', $list);
94			}
95
96			public function getCardTypes()
97			{
98			return $this->getParameter('cardTypes');
99			}
100
101			public function setExpiresAt($value)
102			{
103			return $this->setParameter('expiresAt', $value);
104			}
105
106			public function getExpiresAt()
107			{
108			return $this->getParameter('expiresAt');
109			}
110
111			public function setDeclineUrl($url)
112			{
113			return $this->setParameter('declineUrl', $url);
114			}
115
116			public function getDeclineUrl()
117			{
118			return $this->getParameter('declineUrl');
119			}
120
121			public function setStoreCard($value)
122			{
123			return $this->setParameter('storeCard', $value);
124			}
125
126			public function getStoreCard()
127			{
128			return $this->getParameter('storeCard');
129			}
130
131			public function setMetadata($data)
132			{
133			return $this->setParameter('metadata', $data);
134			}
135
136			public function getMetadata()
137			{
138			return $this->getParameter('metadata');
139			}
140
141			public function getData()
142			{
143			$this->validate('apiUsername', 'apiKey', 'amount', 'currency');
144
145			$data = [];
146
147			$data['type'] = $this->getType();
148			$data['amount'] = $this->getAmount();
149			$data['currency'] = $this->getCurrency();
150			$data['storeCard'] = (bool) $this->getStoreCard() ?? false;
151			$data['callbackUrls'] = [];
152
153			if ( is_array($this->getPaymentMethods()) ) {
154			$data['methods'] = $this->getPaymentMethods();
155			}
156
157			if ( is_array($this->getCardTypes()) ) {
158			$data['cardTypes'] = $this->getCardTypes();
159			}
160
161			if ( is_array($this->getMetadata()) ) {
162			$data['metaData'] = $this->getMetadata();
163			}
164
165			if ( $this->getMerchantReference() ) {
166			$data['merchantReference'] = $this->getMerchantReference();
167			}
168
169			if ( $this->getReturnUrl() ) {
170			$data['callbackUrls']['approved'] = $this->getReturnUrl();
171			}
172
173			if ( $this->getDeclineUrl() ) {
174			$data['callbackUrls']['declined'] = $this->getDeclineUrl();
175			}
176
177			if ( $this->getCancelUrl() ) {
178			$data['callbackUrls']['cancelled'] = $this->getCancelUrl();
179			}
180
181			if ( $this->getNotifyUrl() ) {
182			$data['notificationUrl'] = $this->getNotifyUrl();
183			}
184
185			return $data;
186			}
187
188			public function sendData($data)
189			{
190			$headers = [
191			'Accept' => 'application/json',
192			'Content-Type' => 'application/json',
193			'Authorization' => 'Basic ' . $this->getAuthorization()
194			];
195
196			$httpResponse = $this->httpClient->request('POST', $this->getEndpoint('sessions'), $headers, json_encode($data));
197
198			try {
199			$responseData = json_decode($httpResponse->getBody()->getContents());
200			} catch (\Exception $exception) {
201			$responseData = [];
202			}
203
204			return $this->response = new PurchaseResponse($this, $responseData ?? []);
205			}
206
207			/**
208			* Get endpoint
209			*
210			* Returns endpoint depending on test mode
211			*
212			* @access protected
213			* @return string
214			*/
215			protected function getEndpoint($path = '')
216			{
217			return ($this->getTestMode() ? self::endpointTest : self::endpointLive) . '/' . $path;
218			}
219
220			protected function getAuthorization()
221			{
222			return base64_encode($this->getApiUsername().':'.$this->getApiKey());
223			}
224			}

PatronBase / omnipay-windcave-hpp

Push — main ( 022702...f60e44 )

PurchaseRequest::getMetadata() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like