MerchantDetail.php
5 years ago
PayPalOrder.php
5 years ago
PayPalPayment.php
5 years ago
WebhookConfig.php
5 years ago
PayPalOrder.php
160 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\PaymentGateways\PayPalCommerce\Models; |
| 4 | |
| 5 | use Give\Helpers\ArrayDataSet; |
| 6 | use Give\PaymentGateways\PayPalCommerce\Models\PayPalPayment; |
| 7 | use Give_Payment; |
| 8 | use InvalidArgumentException; |
| 9 | use stdClass; |
| 10 | |
| 11 | /** |
| 12 | * Class PayPalOrder |
| 13 | * @since 2.9.0 |
| 14 | * @package Give\PaymentGateways\PayPalCommerce |
| 15 | * |
| 16 | */ |
| 17 | class PayPalOrder { |
| 18 | /** |
| 19 | * Order Id. |
| 20 | * |
| 21 | * @since 2.9.0 |
| 22 | * |
| 23 | * @var string |
| 24 | */ |
| 25 | public $id; |
| 26 | |
| 27 | /** |
| 28 | * Order intent. |
| 29 | * |
| 30 | * @since 2.9.0 |
| 31 | * |
| 32 | * @var string |
| 33 | */ |
| 34 | public $intent; |
| 35 | |
| 36 | /** |
| 37 | * Order status. |
| 38 | * |
| 39 | * @since 2.9.0 |
| 40 | * |
| 41 | * @var string |
| 42 | */ |
| 43 | public $status; |
| 44 | |
| 45 | /** |
| 46 | * Order creation time. |
| 47 | * |
| 48 | * @since 2.9.0 |
| 49 | * |
| 50 | * @var string |
| 51 | */ |
| 52 | public $createTime; |
| 53 | |
| 54 | /** |
| 55 | * Order update time. |
| 56 | * |
| 57 | * @since 2.9.0 |
| 58 | * |
| 59 | * @var string |
| 60 | */ |
| 61 | public $updateTime; |
| 62 | |
| 63 | /** |
| 64 | * PayPal Order action links. |
| 65 | * |
| 66 | * @since 2.9.0 |
| 67 | * |
| 68 | * @var string |
| 69 | */ |
| 70 | public $links; |
| 71 | |
| 72 | /** |
| 73 | * Payer information. |
| 74 | * |
| 75 | * @since 2.9.0 |
| 76 | * |
| 77 | * @var stdClass |
| 78 | */ |
| 79 | public $payer; |
| 80 | |
| 81 | /** |
| 82 | * Order purchase unit details. |
| 83 | * |
| 84 | * @since 2.9.0 |
| 85 | * |
| 86 | * @var stdClass |
| 87 | */ |
| 88 | private $purchaseUnit; |
| 89 | |
| 90 | /** |
| 91 | * Payment details for order. |
| 92 | * |
| 93 | * @since 2.9.0 |
| 94 | * |
| 95 | * @var PayPalPayment |
| 96 | */ |
| 97 | public $payment; |
| 98 | |
| 99 | /** |
| 100 | * Create PayPalOrder object from given array. |
| 101 | * |
| 102 | * @since 2.9.0 |
| 103 | * |
| 104 | * @param $array |
| 105 | * |
| 106 | * @return PayPalOrder |
| 107 | */ |
| 108 | public static function fromArray( $array ) { |
| 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 | $required = [ 'id', 'intent', 'purchase_units', 'create_time', 'update_time', 'links' ]; |
| 142 | |
| 143 | // PayPal does not send following parameter in Order (completed with advanced card fields payment method) details. |
| 144 | if ( ! isset( $array['payment_source'] ) ) { |
| 145 | $required = array_merge( $required, [ 'payer', 'status' ] ); |
| 146 | } |
| 147 | |
| 148 | $array = array_filter( $array ); // Remove empty values. |
| 149 | |
| 150 | if ( array_diff( $required, array_keys( $array ) ) ) { |
| 151 | throw new InvalidArgumentException( |
| 152 | sprintf( |
| 153 | esc_html__( 'To create a PayPalOrder object, please provide valid %1$s', 'give' ), |
| 154 | implode( ', ', $required ) |
| 155 | ) |
| 156 | ); |
| 157 | } |
| 158 | } |
| 159 | } |
| 160 |