Payment::isApproved() - Code Metrics - Inspection of "Add isApproved and isDeclined methods" - cardinity/cardinity-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7de380...31fde0 )

unknown

created 2018-06-05 07:12 UTC

Payment::isApproved() A

↳ Parent: Payment

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Cardinity\Method\Payment;

use Cardinity\Method\ResultObject;

class Payment extends ResultObject
{
    /** @type string ID of the payment.
        Value assigned by Cardinity. */
    private $id;

    /** @type float Amount charged shown in #0.00 format. */
    private $amount;

    /** @type string Three-letter ISO currency code representing the currency in
        which the charge was made.
        Supported currencies: EUR, USD. */
    private $currency;

    /** @type string Payment creation time as defined in RFC 3339 Section 5.6.
        UTC timezone.
        Value assigned by Cardinity. */
    private $created;

    /** @type string Payment type.
        Can be one of the following: authorization, purchase.
        Value assigned by Cardinity. */
    private $type;

    /** @type boolean Indicates whether a payment was made in live or testing
        mode.
        Value assigned by Cardinity. */
    private $live;

    /** @type boolean Optional. Default: true.
        Used to indicate a transaction type while creating a payment: true -
        purchase, false - authorization. */
    private $settle;

    /** @type string Payment status.
        Can be one of the following: pending, approved, declined.
        Value assigned by Cardinity. */
    private $status;

    /** @type string Error message.
        Returned only if status is declined.
        Provides human readable information why the payment failed.
        Value assigned by Cardinity. */
    private $error;

    /** @type string Optional. Order ID provided by a merchant.
        Must be between 2 and 50 characters [A-Za-z0-9'.-]. */
    private $orderId;

    /** @type string Payment description provided by a merchant.
        Maximum length 255 characters. */
    private $description;

    /** @type string Country of a customer provided by a merchant.
        ISO 3166-1 alpha-2 country code. */
    private $country;

    /** @type string Can be one the following: card, recurring. */
    private $paymentMethod;

    /** @type PaymentInstrumentInterface Payment instrument representing earlier described
        payment_method.
        Can be one of the following: card or recurring.
     */
    private $paymentInstrument;

    /** @type string Used to provide additional information (PATCH verb) once
        customer completes authorization process. */
    private $authorizeData;

    /** @type AuthorizationInformation Specific authorization object returned in case additional
        payment authorization is needed (i.e. payment status is pending).
        Value assigned by Cardinity. */
    private $authorizationInformation;

    /**
     * Gets the value of id.
     * @return mixed
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Sets the value of id.
     * @param mixed $id the id
     * @return void
     */
    public function setId($id)
    {
        $this->id = $id;
    }

    /**
     * Gets the value of amount.
     * @return mixed
     */
    public function getAmount()
    {
        return $this->amount;
    }

    /**
     * Sets the value of amount.
     * @param mixed $amount the amount
     * @return void
     */
    public function setAmount($amount)
    {
        $this->amount = $amount;
    }

    /**
     * Gets the value of currency.
     * @return mixed
     */
    public function getCurrency()
    {
        return $this->currency;
    }

    /**
     * Sets the value of currency.
     * @param mixed $currency the currency
     * @return void
     */
    public function setCurrency($currency)
    {
        $this->currency = $currency;
    }

    /**
     * Gets the value of created.
     * @return mixed
     */
    public function getCreated()
    {
        return $this->created;
    }

    /**
     * Sets the value of created.
     * @param mixed $created the created
     * @return void
     */
    public function setCreated($created)
    {
        $this->created = $created;
    }

    /**
     * Gets the value of type.
     * @return mixed
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Sets the value of type.
     * @param mixed $type the type
     * @return void
     */
    public function setType($type)
    {
        $this->type = $type;
    }

    /**
     * Gets the value of live.
     * @return mixed
     */
    public function getLive()
    {
        return $this->live;
    }

    /**
     * Sets the value of live.
     * @param mixed $live the live
     * @return void
     */
    public function setLive($live)
    {
        $this->live = $live;
    }

    /**
     * Gets the value of settle.
     * @return mixed
     */
    public function getSettle()
    {
        return $this->settle;
    }

    /**
     * Sets the value of settle.
     * @param mixed $settle the settle
     * @return void
     */
    public function setSettle($settle)
    {
        $this->settle = $settle;
    }

    /**
     * Gets the value of status.
     * @return mixed
     */
    public function getStatus()
    {
        return $this->status;
    }

    /**
     * Sets the value of status.
     * @param mixed $status the status
     * @return void
     */
    public function setStatus($status)
    {
        $this->status = $status;
    }

    /**
     * Gets the value of error.
     * @return mixed
     */
    public function getError()
    {
        return $this->error;
    }

    /**
     * Sets the value of error.
     * @param mixed $error the error
     * @return void
     */
    public function setError($error)
    {
        $this->error = $error;
    }

    /**
     * Gets the value of orderId.
     * @return mixed
     */
    public function getOrderId()
    {
        return $this->orderId;
    }

    /**
     * Sets the value of orderId.
     * @param mixed $orderId the order id
     * @return void
     */
    public function setOrderId($orderId)
    {
        $this->orderId = $orderId;
    }

    /**
     * Gets the value of description.
     * @return mixed
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * Sets the value of description.
     * @param mixed $description the description
     * @return void
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }

    /**
     * Gets the value of country.
     * @return mixed
     */
    public function getCountry()
    {
        return $this->country;
    }

    /**
     * Sets the value of country.
     * @param mixed $country the country
     * @return void
     */
    public function setCountry($country)
    {
        $this->country = $country;
    }

    /**
     * Gets the value of paymentMethod.
     * @return mixed
     */
    public function getPaymentMethod()
    {
        return $this->paymentMethod;
    }

    /**
     * Sets the value of paymentMethod.
     * @param mixed $paymentMethod the payment method
     * @return void
     */
    public function setPaymentMethod($paymentMethod)
    {
        $this->paymentMethod = $paymentMethod;
    }

    /**
     * Gets the value of paymentInstrument.
     * @return PaymentInstrumentInterface
     */
    public function getPaymentInstrument()
    {
        return $this->paymentInstrument;
    }

    /**
     * Sets the value of paymentInstrument.
     * @param PaymentInstrumentInterface $paymentInstrument the payment instrument
     * @return void
     */
    public function setPaymentInstrument(PaymentInstrumentInterface $paymentInstrument)
    {
        $this->paymentInstrument = $paymentInstrument;
    }

    /**
     * Gets the value of authorizeData.
     * @return mixed
     */
    public function getAuthorizeData()
    {
        return $this->authorizeData;
    }

    /**
     * Sets the value of authorizeData.
     * @param mixed $authorizeData the authorize data
     * @return void
     */
    public function setAuthorizeData($authorizeData)
    {
        $this->authorizeData = $authorizeData;
    }

    /**
     * Gets the value of authorizationInformation.
     * @return AuthorizationInformation
     */
    public function getAuthorizationInformation()
    {
        return $this->authorizationInformation;
    }

    /**
     * Sets the value of authorizationInformation.
     * @param AuthorizationInformation $authorizationInformation the authorization information
     * @return void
     */
    public function setAuthorizationInformation(AuthorizationInformation $authorizationInformation)
    {
        $this->authorizationInformation = $authorizationInformation;
    }

    /**
     * Check if payment is pending
     * @return boolean
     */
    public function isPending()
    {
        return $this->getStatus() === 'pending';
    }

    /**
     * Check if payment is approved
     * @return boolean
     */
    public function isApproved()
    {
        return $this->getStatus() === 'approved';
    }

    /**
     * Check if payment is declined
     * @return boolean
     */
    public function isDeclined()
    {
        return $this->getStatus() === 'declined';
    }
}


1			<?php
2
3			namespace Cardinity\Method\Payment;
4
5			use Cardinity\Method\ResultObject;
6
7			class Payment extends ResultObject
8			{
9			/** @type string ID of the payment.
10			Value assigned by Cardinity. */
11			private $id;
12
13			/** @type float Amount charged shown in #0.00 format. */
14			private $amount;
15
16			/** @type string Three-letter ISO currency code representing the currency in
17			which the charge was made.
18			Supported currencies: EUR, USD. */
19			private $currency;
20
21			/** @type string Payment creation time as defined in RFC 3339 Section 5.6.
22			UTC timezone.
23			Value assigned by Cardinity. */
24			private $created;
25
26			/** @type string Payment type.
27			Can be one of the following: authorization, purchase.
28			Value assigned by Cardinity. */
29			private $type;
30
31			/** @type boolean Indicates whether a payment was made in live or testing
32			mode.
33			Value assigned by Cardinity. */
34			private $live;
35
36			/** @type boolean Optional. Default: true.
37			Used to indicate a transaction type while creating a payment: true -
38			purchase, false - authorization. */
39			private $settle;
40
41			/** @type string Payment status.
42			Can be one of the following: pending, approved, declined.
43			Value assigned by Cardinity. */
44			private $status;
45
46			/** @type string Error message.
47			Returned only if status is declined.
48			Provides human readable information why the payment failed.
49			Value assigned by Cardinity. */
50			private $error;
51
52			/** @type string Optional. Order ID provided by a merchant.
53			Must be between 2 and 50 characters [A-Za-z0-9'.-]. */
54			private $orderId;
55
56			/** @type string Payment description provided by a merchant.
57			Maximum length 255 characters. */
58			private $description;
59
60			/** @type string Country of a customer provided by a merchant.
61			ISO 3166-1 alpha-2 country code. */
62			private $country;
63
64			/** @type string Can be one the following: card, recurring. */
65			private $paymentMethod;
66
67			/** @type PaymentInstrumentInterface Payment instrument representing earlier described
68			payment_method.
69			Can be one of the following: card or recurring.
70			*/
71			private $paymentInstrument;
72
73			/** @type string Used to provide additional information (PATCH verb) once
74			customer completes authorization process. */
75			private $authorizeData;
76
77			/** @type AuthorizationInformation Specific authorization object returned in case additional
78			payment authorization is needed (i.e. payment status is pending).
79			Value assigned by Cardinity. */
80			private $authorizationInformation;
81
82			/**
83			* Gets the value of id.
84			* @return mixed
85			*/
86			public function getId()
87			{
88			return $this->id;
89			}
90
91			/**
92			* Sets the value of id.
93			* @param mixed $id the id
94			* @return void
95			*/
96			public function setId($id)
97			{
98			$this->id = $id;
99			}
100
101			/**
102			* Gets the value of amount.
103			* @return mixed
104			*/
105			public function getAmount()
106			{
107			return $this->amount;
108			}
109
110			/**
111			* Sets the value of amount.
112			* @param mixed $amount the amount
113			* @return void
114			*/
115			public function setAmount($amount)
116			{
117			$this->amount = $amount;
118			}
119
120			/**
121			* Gets the value of currency.
122			* @return mixed
123			*/
124			public function getCurrency()
125			{
126			return $this->currency;
127			}
128
129			/**
130			* Sets the value of currency.
131			* @param mixed $currency the currency
132			* @return void
133			*/
134			public function setCurrency($currency)
135			{
136			$this->currency = $currency;
137			}
138
139			/**
140			* Gets the value of created.
141			* @return mixed
142			*/
143			public function getCreated()
144			{
145			return $this->created;
146			}
147
148			/**
149			* Sets the value of created.
150			* @param mixed $created the created
151			* @return void
152			*/
153			public function setCreated($created)
154			{
155			$this->created = $created;
156			}
157
158			/**
159			* Gets the value of type.
160			* @return mixed
161			*/
162			public function getType()
163			{
164			return $this->type;
165			}
166
167			/**
168			* Sets the value of type.
169			* @param mixed $type the type
170			* @return void
171			*/
172			public function setType($type)
173			{
174			$this->type = $type;
175			}
176
177			/**
178			* Gets the value of live.
179			* @return mixed
180			*/
181			public function getLive()
182			{
183			return $this->live;
184			}
185
186			/**
187			* Sets the value of live.
188			* @param mixed $live the live
189			* @return void
190			*/
191			public function setLive($live)
192			{
193			$this->live = $live;
194			}
195
196			/**
197			* Gets the value of settle.
198			* @return mixed
199			*/
200			public function getSettle()
201			{
202			return $this->settle;
203			}
204
205			/**
206			* Sets the value of settle.
207			* @param mixed $settle the settle
208			* @return void
209			*/
210			public function setSettle($settle)
211			{
212			$this->settle = $settle;
213			}
214
215			/**
216			* Gets the value of status.
217			* @return mixed
218			*/
219			public function getStatus()
220			{
221			return $this->status;
222			}
223
224			/**
225			* Sets the value of status.
226			* @param mixed $status the status
227			* @return void
228			*/
229			public function setStatus($status)
230			{
231			$this->status = $status;
232			}
233
234			/**
235			* Gets the value of error.
236			* @return mixed
237			*/
238			public function getError()
239			{
240			return $this->error;
241			}
242
243			/**
244			* Sets the value of error.
245			* @param mixed $error the error
246			* @return void
247			*/
248			public function setError($error)
249			{
250			$this->error = $error;
251			}
252
253			/**
254			* Gets the value of orderId.
255			* @return mixed
256			*/
257			public function getOrderId()
258			{
259			return $this->orderId;
260			}
261
262			/**
263			* Sets the value of orderId.
264			* @param mixed $orderId the order id
265			* @return void
266			*/
267			public function setOrderId($orderId)
268			{
269			$this->orderId = $orderId;
270			}
271
272			/**
273			* Gets the value of description.
274			* @return mixed
275			*/
276			public function getDescription()
277			{
278			return $this->description;
279			}
280
281			/**
282			* Sets the value of description.
283			* @param mixed $description the description
284			* @return void
285			*/
286			public function setDescription($description)
287			{
288			$this->description = $description;
289			}
290
291			/**
292			* Gets the value of country.
293			* @return mixed
294			*/
295			public function getCountry()
296			{
297			return $this->country;
298			}
299
300			/**
301			* Sets the value of country.
302			* @param mixed $country the country
303			* @return void
304			*/
305			public function setCountry($country)
306			{
307			$this->country = $country;
308			}
309
310			/**
311			* Gets the value of paymentMethod.
312			* @return mixed
313			*/
314			public function getPaymentMethod()
315			{
316			return $this->paymentMethod;
317			}
318
319			/**
320			* Sets the value of paymentMethod.
321			* @param mixed $paymentMethod the payment method
322			* @return void
323			*/
324			public function setPaymentMethod($paymentMethod)
325			{
326			$this->paymentMethod = $paymentMethod;
327			}
328
329			/**
330			* Gets the value of paymentInstrument.
331			* @return PaymentInstrumentInterface
332			*/
333			public function getPaymentInstrument()
334			{
335			return $this->paymentInstrument;
336			}
337
338			/**
339			* Sets the value of paymentInstrument.
340			* @param PaymentInstrumentInterface $paymentInstrument the payment instrument
341			* @return void
342			*/
343			public function setPaymentInstrument(PaymentInstrumentInterface $paymentInstrument)
344			{
345			$this->paymentInstrument = $paymentInstrument;
346			}
347
348			/**
349			* Gets the value of authorizeData.
350			* @return mixed
351			*/
352			public function getAuthorizeData()
353			{
354			return $this->authorizeData;
355			}
356
357			/**
358			* Sets the value of authorizeData.
359			* @param mixed $authorizeData the authorize data
360			* @return void
361			*/
362			public function setAuthorizeData($authorizeData)
363			{
364			$this->authorizeData = $authorizeData;
365			}
366
367			/**
368			* Gets the value of authorizationInformation.
369			* @return AuthorizationInformation
370			*/
371			public function getAuthorizationInformation()
372			{
373			return $this->authorizationInformation;
374			}
375
376			/**
377			* Sets the value of authorizationInformation.
378			* @param AuthorizationInformation $authorizationInformation the authorization information
379			* @return void
380			*/
381			public function setAuthorizationInformation(AuthorizationInformation $authorizationInformation)
382			{
383			$this->authorizationInformation = $authorizationInformation;
384			}
385
386			/**
387			* Check if payment is pending
388			* @return boolean
389			*/
390			public function isPending()
391			{
392			return $this->getStatus() === 'pending';
393			}
394
395			/**
396			* Check if payment is approved
397			* @return boolean
398			*/
399			public function isApproved()
400			{
401			return $this->getStatus() === 'approved';
402			}
403
404			/**
405			* Check if payment is declined
406			* @return boolean
407			*/
408			public function isDeclined()
409			{
410			return $this->getStatus() === 'declined';
411			}
412			}
413

cardinity / cardinity-sdk-php

Push — master ( 7de380...31fde0 )

Payment::isApproved() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like