MerchantDetail.php
2 years ago
PayPalOrder.php
4 years ago
PayPalPayment.php
4 years ago
WebhookConfig.php
4 years ago
MerchantDetail.php
209 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\PaymentGateways\PayPalCommerce\Models; |
| 4 | |
| 5 | use Give\Framework\Exceptions\Primitives\InvalidArgumentException; |
| 6 | |
| 7 | /** |
| 8 | * Class MerchantDetail |
| 9 | * @package Give\PaymentGateways\PayPalCommerce |
| 10 | * |
| 11 | * @since 2.9.0 |
| 12 | */ |
| 13 | final class MerchantDetail |
| 14 | { |
| 15 | /** |
| 16 | * PayPal merchant Id (email address) |
| 17 | * |
| 18 | * @since 2.9.0 |
| 19 | * |
| 20 | * @var null|string |
| 21 | */ |
| 22 | public $merchantId = null; |
| 23 | |
| 24 | /** |
| 25 | * PayPal merchant id |
| 26 | * |
| 27 | * @since 2.9.0 |
| 28 | * |
| 29 | * @var null|string |
| 30 | */ |
| 31 | public $merchantIdInPayPal = null; |
| 32 | |
| 33 | /** |
| 34 | * Client id. |
| 35 | * |
| 36 | * @since 2.9.0 |
| 37 | * |
| 38 | * @var null |string |
| 39 | */ |
| 40 | public $clientId = null; |
| 41 | |
| 42 | /** |
| 43 | * Client Secret |
| 44 | * |
| 45 | * @since 2.9.0 |
| 46 | * |
| 47 | * @var null|string |
| 48 | */ |
| 49 | public $clientSecret = null; |
| 50 | |
| 51 | /** |
| 52 | * Access token. |
| 53 | * |
| 54 | * @since 2.9.0 |
| 55 | * |
| 56 | * @var null|string |
| 57 | */ |
| 58 | public $accessToken = null; |
| 59 | |
| 60 | /** |
| 61 | * Whether or not the connected account is ready to process donations. |
| 62 | * |
| 63 | * @since 2.9.0 |
| 64 | * |
| 65 | * @var bool |
| 66 | */ |
| 67 | public $accountIsReady = false; |
| 68 | |
| 69 | /** |
| 70 | * Whether or not the account can make custom payments (i.e Advanced Fields & PPCP) |
| 71 | * |
| 72 | * @since 2.9.0 |
| 73 | * |
| 74 | * @var bool |
| 75 | */ |
| 76 | public $supportsCustomPayments; |
| 77 | |
| 78 | /** |
| 79 | * PayPal account accountCountry. |
| 80 | * |
| 81 | * @since 2.9.0 |
| 82 | * |
| 83 | * @var string|null |
| 84 | */ |
| 85 | public $accountCountry; |
| 86 | |
| 87 | /** |
| 88 | * Access token. |
| 89 | * |
| 90 | * @since 2.9.0 |
| 91 | * |
| 92 | * @var array |
| 93 | */ |
| 94 | private $tokenDetails = null; |
| 95 | |
| 96 | /** |
| 97 | * Return array of merchant details. |
| 98 | * |
| 99 | * @sicne 2.9.0 |
| 100 | * |
| 101 | * @return array |
| 102 | */ |
| 103 | public function toArray() |
| 104 | { |
| 105 | return [ |
| 106 | 'merchantId' => $this->merchantId, |
| 107 | 'merchantIdInPayPal' => $this->merchantIdInPayPal, |
| 108 | 'clientId' => $this->clientId, |
| 109 | 'clientSecret' => $this->clientSecret, |
| 110 | 'token' => $this->tokenDetails, |
| 111 | 'accountIsReady' => $this->accountIsReady, |
| 112 | 'supportsCustomPayments' => $this->supportsCustomPayments, |
| 113 | 'accountCountry' => $this->accountCountry, |
| 114 | ]; |
| 115 | } |
| 116 | |
| 117 | /** |
| 118 | * Make MerchantDetail object from array. |
| 119 | * |
| 120 | * @since 2.9.0 |
| 121 | * |
| 122 | * @param array $merchantDetails |
| 123 | * |
| 124 | * @return MerchantDetail |
| 125 | */ |
| 126 | public static function fromArray($merchantDetails) |
| 127 | { |
| 128 | $obj = new static(); |
| 129 | |
| 130 | if ( ! $merchantDetails) { |
| 131 | return $obj; |
| 132 | } |
| 133 | |
| 134 | $obj->validate($merchantDetails); |
| 135 | $obj->setupProperties($merchantDetails); |
| 136 | |
| 137 | return $obj; |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * Setup properties from array. |
| 142 | * |
| 143 | * @since 2.9.0 |
| 144 | * |
| 145 | * @param $merchantDetails |
| 146 | * |
| 147 | */ |
| 148 | private function setupProperties($merchantDetails) |
| 149 | { |
| 150 | $this->merchantId = $merchantDetails['merchantId']; |
| 151 | $this->merchantIdInPayPal = $merchantDetails['merchantIdInPayPal']; |
| 152 | |
| 153 | $this->clientId = $merchantDetails['clientId']; |
| 154 | $this->clientSecret = $merchantDetails['clientSecret']; |
| 155 | $this->tokenDetails = $merchantDetails['token']; |
| 156 | $this->accountIsReady = $merchantDetails['accountIsReady']; |
| 157 | $this->supportsCustomPayments = $merchantDetails['supportsCustomPayments']; |
| 158 | $this->accountCountry = $merchantDetails['accountCountry']; |
| 159 | $this->accessToken = $this->tokenDetails['accessToken']; |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * Validate merchant details. |
| 164 | * |
| 165 | * @since 2.9.0 |
| 166 | * |
| 167 | * @param array $merchantDetails |
| 168 | */ |
| 169 | private function validate($merchantDetails) |
| 170 | { |
| 171 | $required = [ |
| 172 | 'merchantId', |
| 173 | 'merchantIdInPayPal', |
| 174 | 'clientId', |
| 175 | 'clientSecret', |
| 176 | 'token', |
| 177 | 'accountIsReady', |
| 178 | 'supportsCustomPayments', |
| 179 | 'accountCountry', |
| 180 | ]; |
| 181 | |
| 182 | if (array_diff($required, array_keys($merchantDetails))) { |
| 183 | throw new InvalidArgumentException( |
| 184 | esc_html__( |
| 185 | 'To create a MerchantDetail object, please provide the following: ' . implode(', ', $required), |
| 186 | 'give' |
| 187 | ) |
| 188 | ); |
| 189 | } |
| 190 | } |
| 191 | |
| 192 | /** |
| 193 | * Get refresh token code. |
| 194 | * |
| 195 | * @since 2.32.0 Set default value for empty tokenDetails. |
| 196 | * @since 2.25.0 Set accessToken property. |
| 197 | * @since 2.9.0 |
| 198 | * |
| 199 | * @param array $tokenDetails |
| 200 | * |
| 201 | * @return mixed |
| 202 | */ |
| 203 | public function setTokenDetails($tokenDetails) |
| 204 | { |
| 205 | $this->tokenDetails = array_merge($this->tokenDetails ?? [] , $tokenDetails); |
| 206 | $this->accessToken = $tokenDetails['accessToken']; |
| 207 | } |
| 208 | } |
| 209 |