give / src / PaymentGateways / PayPalCommerce / Models / PayPalOrder.php

PayPalOrder.php in GiveWP – Donation Plugin and Fundraising Platform 4.17.0, at src/PaymentGateways/PayPalCommerce/Models/PayPalOrder.php

161 lines 3.0 KB

Raw Download Zip

1	<?php
2
3	namespace Give\PaymentGateways\PayPalCommerce\Models;
4
5	use Give\Framework\Exceptions\Primitives\InvalidArgumentException;
6	use Give\Helpers\ArrayDataSet;
7	use stdClass;
8
9	/**
10	* Class PayPalOrder
11	* @package Give\PaymentGateways\PayPalCommerce
12	*
13	* @since 2.9.0
14	*/
15	class PayPalOrder
16	{
17	/**
18	* Order Id.
19	*
20	* @since 2.9.0
21	*
22	* @var string
23	*/
24	public $id;
25
26	/**
27	* Order intent.
28	*
29	* @since 2.9.0
30	*
31	* @var string
32	*/
33	public $intent;
34
35	/**
36	* Order status.
37	*
38	* @since 2.9.0
39	*
40	* @var string
41	*/
42	public $status;
43
44	/**
45	* Order creation time.
46	*
47	* @since 2.9.0
48	*
49	* @var string
50	*/
51	public $createTime;
52
53	/**
54	* Order update time.
55	*
56	* @since 2.9.0
57	*
58	* @var string
59	*/
60	public $updateTime;
61
62	/**
63	* PayPal Order action links.
64	*
65	* @since 2.9.0
66	*
67	* @var string
68	*/
69	public $links;
70
71	/**
72	* Payer information.
73	*
74	* @since 2.9.0
75	*
76	* @var stdClass
77	*/
78	public $payer;
79
80	/**
81	* Order purchase unit details.
82	*
83	* @since 2.9.0
84	*
85	* @var stdClass
86	*/
87	private $purchaseUnit;
88
89	/**
90	* Payment details for order.
91	*
92	* @since 2.9.0
93	*
94	* @var PayPalPayment
95	*/
96	public $payment;
97
98	/**
99	* Create PayPalOrder object from given array.
100	*
101	* @since 2.9.0
102	*
103	* @param $array
104	*
105	* @return PayPalOrder
106	*/
107	public static function fromArray($array)
108	{
109	/* @var PayPalOrder $order */
110	$order = give(__CLASS__);
111
112	$order->validate($array);
113	$array = ArrayDataSet::camelCaseKeys($array);
114
115	foreach ($array as $itemName => $value) {
116	if ('purchaseUnits' === $itemName) {
117	$value = current($value);
118
119	$order->purchaseUnit = $value;
120	$order->payment = PayPalPayment::fromArray((array)current($order->purchaseUnit->payments->captures));
121
122	continue;
123	}
124
125	$order->{$itemName} = $value;
126	}
127
128	return $order;
129	}
130
131	/**
132	* Validate order given in array format.
133	*
134	* @since 2.9.0
135	*
136	* @param array $array
137	*
138	* @throws InvalidArgumentException
139	*/
140	private function validate($array)
141	{
142	$required = ['id', 'intent', 'purchase_units', 'create_time', 'update_time', 'links'];
143
144	// PayPal does not send following parameter in Order (completed with advanced card fields payment method) details.
145	if ( ! isset($array['payment_source'])) {
146	$required = array_merge($required, ['payer', 'status']);
147	}
148
149	$array = array_filter($array); // Remove empty values.
150
151	if (array_diff($required, array_keys($array))) {
152	throw new InvalidArgumentException(
153	sprintf(
154	esc_html__('To create a PayPalOrder object, please provide valid %1$s', 'give'),
155	implode(', ', $required)
156	)
157	);
158	}
159	}
160	}
161