PaymentResponse::from_object() - Code Metrics - Inspection of "Added some more JSON schemas for testing." - wp-pay-gateways/adyen - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — develop ( d3c138...9b3794 )

by Remco

created 2019-03-06 14:40 UTC

PaymentResponse::from_object() A

↳ Parent: PaymentResponse

Complexity

Conditions	3
Paths	4

Size

Total Lines	22
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	3.0052

Importance

Changes

Metric	Value
cc	3
eloc	12
nc	4
nop	1
dl	0
loc	22
ccs	11
cts	12
cp	0.9167
crap	3.0052
rs	9.8666
c	0
b	0
f	0

<?php
/**
 * Payment response
 *
 * @author    Pronamic <[email protected]>
 * @copyright 2005-2019 Pronamic
 * @license   GPL-3.0-or-later
 * @package   Pronamic\WordPress\Pay\Gateways\Adyen
 */

namespace Pronamic\WordPress\Pay\Gateways\Adyen;

use JsonSchema\Constraints\Constraint;
use JsonSchema\Exception\ValidationException;
use JsonSchema\Validator;

/**
 * Payment response
 *
 * @link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v41/payments
 *
 * @author  Remco Tolsma
 * @version 1.0.0
 * @since   1.0.0
 */
class PaymentResponse {
	/**
	 * This field contains additional data, which may be required to return in a particular payment response.
	 *
	 * @var object|null
	 */
	private $additional_data;


	/**
	 * When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.
	 *
	 * @var array|null
	 */
	private $details;


	/**
	 * The fraud result properties of the payment
	 *
	 * @var object|null
	 */
	private $fraud_result;


	/**
	 * Contains the details that will be presented to the shopper
	 *
	 * @var object|null
	 */
	private $output_details;


	/**
	 * When non-empty, contains a value that you must submit to the `/payments/details` endpoint.
	 *
	 * @var string|null
	 */
	private $payment_data;


	/**
	 * Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
	 *
	 * `pspReference` is returned only for non-redirect payment methods.
	 *
	 * @var string|null
	 */
	private $psp_reference;

	/**
	 * When the payment flow requires a redirect, this object contains information about the redirect URL.
	 *
	 * @var RedirectInformation|null
	 */
	private $redirect;

	/**
	 * If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error.
	 *
	 * When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.
	 *
	 * @var string|null
	 */
	private $refusal_reason;


	/**
	 * Code that specifies the refusal reason.
	 *
	 * @var string|null
	 */
	private $refusal_reason_code;


	/**
	 * The result of the payment.
	 *
	 * @var string
	 */
	private $result_code;

	/**
	 * Construct payment response object.
	 *
	 * @param string $result_code Result code.
	 */
	public function __construct( $result_code ) {
		$this->result_code = $result_code;
	}

	/**
	 * Get result code.
	 *
	 * @return string
	 */
	public function get_result_code() {
		return $this->result_code;
	}

	/**
	 * Get PSP reference.
	 *
	 * @return string|null
	 */
	public function get_psp_reference() {
		return $this->psp_reference;
	}

	/**
	 * Set PSP reference.
	 *
	 * @param string|null $psp_reference PSP reference.
	 */
	public function set_psp_reference( $psp_reference ) {
		$this->psp_reference = $psp_reference;
	}

	/**
	 * Get redirect.
	 *
	 * @return RedirectInformation|null
	 */
	public function get_redirect() {
		return $this->redirect;
	}

	/**
	 * Set redirect.
	 *
	 * @param RedirectInformation|null $redirect Redirect information.
	 */
	public function set_redirect( RedirectInformation $redirect = null ) {
		$this->redirect = $redirect;
	}

	/**
	 * Create payment repsonse from object.
	 *
	 * @param object $object Object.
	 * @return PaymentResponse
	 * @throws InvalidArgumentException Throws invalid argument exception when object does not contains the required properties.
	 */
	public static function from_object( $object ) {
		$validator = new Validator();

		$validator->validate(
			$object,
			(object) array(
				'$ref' => 'file://' . realpath( __DIR__ . '/../json-schemas/payment-response.json' ),
			),
			Constraint::CHECK_MODE_EXCEPTIONS
		);

		$payment_response = new self( $object->resultCode );

		if ( isset( $object->pspReference ) ) {
			$payment_response->set_psp_reference( $object->pspReference );
		}

		if ( isset( $object->redirect ) ) {
			$payment_response->set_redirect( RedirectInformation::from_object( $object->redirect ) );
		}

		return $payment_response;
	}
}


1		<?php
2		/**
3		* Payment response
4		*
5		* @author Pronamic <[email protected]>
6		* @copyright 2005-2019 Pronamic
7		* @license GPL-3.0-or-later
8		* @package Pronamic\WordPress\Pay\Gateways\Adyen
9		*/
10
11		namespace Pronamic\WordPress\Pay\Gateways\Adyen;
12
13		use JsonSchema\Constraints\Constraint;
14		use JsonSchema\Exception\ValidationException;
15		use JsonSchema\Validator;
16
17		/**
18		* Payment response
19		*
20		* @link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v41/payments
21		*
22		* @author Remco Tolsma
23		* @version 1.0.0
24		* @since 1.0.0
25		*/
26		class PaymentResponse {
27		/**
28		* This field contains additional data, which may be required to return in a particular payment response.
29		*
30		* @var object\|null
31		*/
32		private $additional_data;
		0 ignored issues – show introduced 2019-02-28 10:30 UTC by Report Bug Copy Issue Report The private property `$additional_data` is not used, and could be removed. Loading history...
33
34		/**
35		* When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.
36		*
37		* @var array\|null
38		*/
39		private $details;
		0 ignored issues – show introduced 2019-02-28 10:30 UTC by Report Bug Copy Issue Report The private property `$details` is not used, and could be removed. Loading history...
40
41		/**
42		* The fraud result properties of the payment
43		*
44		* @var object\|null
45		*/
46		private $fraud_result;
		0 ignored issues – show introduced 2019-02-28 10:30 UTC by Report Bug Copy Issue Report The private property `$fraud_result` is not used, and could be removed. Loading history...
47
48		/**
49		* Contains the details that will be presented to the shopper
50		*
51		* @var object\|null
52		*/
53		private $output_details;
		0 ignored issues – show introduced 2019-02-28 10:30 UTC by Report Bug Copy Issue Report The private property `$output_details` is not used, and could be removed. Loading history...
54
55		/**
56		* When non-empty, contains a value that you must submit to the `/payments/details` endpoint.
57		*
58		* @var string\|null
59		*/
60		private $payment_data;
		0 ignored issues – show introduced 2019-02-28 10:30 UTC by Report Bug Copy Issue Report The private property `$payment_data` is not used, and could be removed. Loading history...
61
62		/**
63		* Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
64		*
65		* `pspReference` is returned only for non-redirect payment methods.
66		*
67		* @var string\|null
68		*/
69		private $psp_reference;
70
71		/**
72		* When the payment flow requires a redirect, this object contains information about the redirect URL.
73		*
74		* @var RedirectInformation\|null
75		*/
76		private $redirect;
77
78		/**
79		* If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error.
80		*
81		* When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.
82		*
83		* @var string\|null
84		*/
85		private $refusal_reason;
		0 ignored issues – show introduced 2019-02-28 10:30 UTC by Report Bug Copy Issue Report The private property `$refusal_reason` is not used, and could be removed. Loading history...
86
87		/**
88		* Code that specifies the refusal reason.
89		*
90		* @var string\|null
91		*/
92		private $refusal_reason_code;
		0 ignored issues – show introduced 2019-02-28 10:30 UTC by Report Bug Copy Issue Report The private property `$refusal_reason_code` is not used, and could be removed. Loading history...
93
94		/**
95		* The result of the payment.
96		*
97		* @var string
98		*/
99		private $result_code;
100
101		/**
102		* Construct payment response object.
103		*
104		* @param string $result_code Result code.
105		*/
106	1	public function __construct( $result_code ) {
107	1	$this->result_code = $result_code;
108	1	}
109
110		/**
111		* Get result code.
112		*
113		* @return string
114		*/
115	1	public function get_result_code() {
116	1	return $this->result_code;
117		}
118
119		/**
120		* Get PSP reference.
121		*
122		* @return string\|null
123		*/
124		public function get_psp_reference() {
125		return $this->psp_reference;
126		}
127
128		/**
129		* Set PSP reference.
130		*
131		* @param string\|null $psp_reference PSP reference.
132		*/
133		public function set_psp_reference( $psp_reference ) {
134		$this->psp_reference = $psp_reference;
135		}
136
137		/**
138		* Get redirect.
139		*
140		* @return RedirectInformation\|null
141		*/
142	1	public function get_redirect() {
143	1	return $this->redirect;
144		}
145
146		/**
147		* Set redirect.
148		*
149		* @param RedirectInformation\|null $redirect Redirect information.
150		*/
151	1	public function set_redirect( RedirectInformation $redirect = null ) {
152	1	$this->redirect = $redirect;
153	1	}
154
155		/**
156		* Create payment repsonse from object.
157		*
158		* @param object $object Object.
159		* @return PaymentResponse
160		* @throws InvalidArgumentException Throws invalid argument exception when object does not contains the required properties.
161		*/
162	1	public static function from_object( $object ) {
163	1	$validator = new Validator();
164
165	1	$validator->validate(
166	1	$object,
167		(object) array(
168	1	'$ref' => 'file://' . realpath( __DIR__ . '/../json-schemas/payment-response.json' ),
169		),
170	1	Constraint::CHECK_MODE_EXCEPTIONS
171		);
172
173	1	$payment_response = new self( $object->resultCode );
174
175	1	if ( isset( $object->pspReference ) ) {
176		$payment_response->set_psp_reference( $object->pspReference );
177		}
178
179	1	if ( isset( $object->redirect ) ) {
180	1	$payment_response->set_redirect( RedirectInformation::from_object( $object->redirect ) );
181		}
182
183	1	return $payment_response;
184		}
185		}
186

wp-pay-gateways / adyen

Push — develop ( d3c138...9b3794 )

PaymentResponse::from_object() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like