クラス
Update
ソース ソース
ファイル: src/API/CheckoutSession/Update.php
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 | class Update extends ErrorStore{ // Errors const RESOURCE_NOT_FOUND = 'ResourceNotFound'; const INVALID_CHECKOUT_SESSION_STATUS = 'InvalidCheckoutSessionStatus'; // Constraints const CONSTRAINT_CHECKOUT_RESULT_RETURN_URL_NOT_SET = 'CheckoutResultReturnUrlNotSet'; const CONSTRAINT_CHARGE_AMOUNT_NOT_SET = 'ChargeAmountNotSet'; const CONSTRAINT_PAYMENT_INTENT_NOT_SET = 'PaymentIntentNotSet'; const CONSTRAINT_BUYER_NOT_ASSOCIATED = 'BuyerNotAssociated'; /** * AmazonPay module object * * @var AmazonPay */ private $module; /** * Amazon checkout `paymentIntent` * * `Authorize`, `AuthorizeWithCapture` or `Confirm` * * @var string */ private $paymentIntent; /** * True for asynchronous processing. False otherwise * * @var bool */ private $canHandlePendingAuthorization; /** * Redirect URL for checkout result page * * @var string */ private $checkoutResultUrl; /** * The type of Amazon Pay settlement. * * Should be `payonly` or `payandship` * * This variable is used for conditionally firing hooks * relative to the settlement type. * * @var string */ private $settlementType; /** * PaymentIntent option * * @var string */ public static $authorizeWithCapture = 'AuthorizeWithCapture'; /** * PaymentIntent option * * @var string */ public static $authorize = 'Authorize'; /** * PaymentIntent option * * @var string */ public static $confirm = 'Confirm'; /** * Sets `$module` member var with dependency injection. * * @author Evan D Shaw <evandanielshaw@gmail.com> * @param AmazonPay $module * @param string $checkoutResultUrl * @param bool $canHandlePendingAuthorization Default: `false` * @param string $paymentIntent `Authorize`, `AuthorizeWithCapture`, or `Confirm`. `Authorize` by default * @return void * @throws InvalidArgumentException Thrown if paymentIntent is `AuthorizeWithCapture` when * canHandlePendingAuthorization is `true`. */ public function __construct( AmazonPay $module, $checkoutResultUrl, $canHandlePendingAuthorization = false, $paymentIntent = 'Authorize' ) { if ($canHandlePendingAuthorization === true && $paymentIntent === 'AuthorizeWithCapture') { throw new InvalidArgumentException( "paymentIntent cannot be 'AuthorizeWithCapture' when canHandlePendingAuthorization is true" ); } $this->module = $module; $this->checkoutResultUrl = $checkoutResultUrl; $this->canHandlePendingAuthorization = $canHandlePendingAuthorization; $this->paymentIntent = $paymentIntent; parent::__construct(); $this->populate(); } /** * Updates a checkout session * * @author Evan D Shaw <evandanielshaw@gmail.com> * @param array $args { * URL params * * @type int $id Checkout Session ID * } * @return array * @throws InvalidArgumentException Thrown by `getAmazonClient`. */ public function patch(array $args) { $formExtras = !empty($_POST['formExtras']) ? $_POST['formExtras'] : []; /** * Fires **before** calling Amazon Pay's `Update Checkout Session` API * * @param array $formExtras * @param array $args See {@see \Aivec\Welcart\SettlementModules\AmazonPay\API\CheckoutSession\Update::patch()} * @param string $settlementType `payonly` or `payandship` * @param string $paymentIntent `Authorize`, `AuthorizeWithCapture` or `Confirm` */ do_action( 'wcexaap_on_before_update_checkout_session', $formExtras, $args, $this->settlementType, $this->paymentIntent ); if (!empty($this->settlementType)) { /** * Fires **before** calling Amazon Pay's `Update Checkout Session` API * * @param array $formExtras * @param array $args See {@see \Aivec\Welcart\SettlementModules\AmazonPay\API\CheckoutSession\Update::patch()} * @param string $settlementType `payonly` or `payandship` * @param string $paymentIntent `Authorize`, `AuthorizeWithCapture` or `Confirm` */ do_action( "wcexaap_on_before_update_checkout_session_{$this->settlementType}", $formExtras, $args, $this->settlementType, $this->paymentIntent ); } $id = $args['id']; $order = (new API\WelcartEntries())->getOrder(); $payload = [ 'webCheckoutDetails' => [ 'checkoutResultReturnUrl' => $this->checkoutResultUrl, ], 'paymentDetails' => [ 'paymentIntent' => $this->paymentIntent, 'canHandlePendingAuthorization' => $this->canHandlePendingAuthorization, 'chargeAmount' => [ 'amount' => $order['total_full_price'], 'currencyCode' => usces_crcode('return'), ], ], 'platformId' => Constants::PLATFORM_ID, ]; $headers = (new SandboxSimulation($this->module))->updateCheckoutSessionSetSimCodeIfSandbox(); try { $client = $this->module->getAmazonClient(); $result = $client->updateCheckoutSession($id, $payload, $headers); if ($this->module->errors->hasError($result)) { return $this->module->errors->getAmzErrorResponse($result, $this); } if ($this->hasConstraints($result)) { return $this->getConstraintsResponse($result); } } catch (\Exception $e) { return $this->module->errors->getErrorResponse( GenericErrorStore::AMAZON_PAY_SDK_CLIENT_EXCEPTION, [$e->getMessage()] ); } /** * Fires **after** calling Amazon Pay's `Update Checkout Session` API * * This hook will not be called if an error occured * * @param array $result * @param array $formExtras * @param array $args See {@see \Aivec\Welcart\SettlementModules\AmazonPay\API\CheckoutSession\Update::patch()} * @param string $settlementType `payonly` or `payandship` * @param string $paymentIntent `Authorize`, `AuthorizeWithCapture` or `Confirm` */ do_action( 'wcexaap_on_after_update_checkout_session', $result, $formExtras, $args, $this->settlementType, $this->paymentIntent ); if (!empty($this->settlementType)) { /** * Fires **after** calling Amazon Pay's `Update Checkout Session` API * * This hook will not be called if an error occured * * @param array $result * @param array $formExtras * @param array $args See {@see \Aivec\Welcart\SettlementModules\AmazonPay\API\CheckoutSession\Update::patch()} * @param string $settlementType `payonly` or `payandship` * @param string $paymentIntent `Authorize`, `AuthorizeWithCapture` or `Confirm` */ do_action( "wcexaap_on_after_update_checkout_session_{$this->settlementType}", $result, $formExtras, $args, $this->settlementType, $this->paymentIntent ); } return $result; } /** * Parses update result and returns true if any constraints exist * * @author Evan D Shaw <evandanielshaw@gmail.com> * @param array $result * @return bool */ public function hasConstraints(array $result) { $body = json_decode($result['response'], true); if (isset($body['constraints']) && count($body['constraints']) > 0) { return true; } return false; } /** * Returns `AmazonGenericError` object created from response constraints * * @author Evan D Shaw <evandanielshaw@gmail.com> * @param array $result * @return AmazonGenericError */ public function getConstraintsResponse(array $result) { $body = json_decode($result['response'], true); $constraint = $body['constraints'][0]; $genericerr = $this->getErrorResponse($constraint['constraintId'], [$constraint['description']]); return new AmazonGenericError( $genericerr->errorcode, $genericerr->errorname, $genericerr->httpcode, $genericerr->debugmsg, $genericerr->message, $genericerr->adminmsg, $genericerr->logger, $result ); } /** * Setter for `settlementType` member variable. * * @author Evan D Shaw <evandanielshaw@gmail.com> * @param string $type Should be either `payonly` or `payandship` * @return void */ public function setSettlementType($type) { $this->settlementType = $type; } /** * Populates error store * * @author Evan D Shaw <evandanielshaw@gmail.com> * @return void * @throws InvalidArgumentException Thrown if duplicate errorcodes exist. */ public function populate() { $defaultErrors = $this->getErrorCodeMap(); $defaultErrorMessage = $defaultErrors[parent::INTERNAL_SERVER_ERROR]->message; $actingLogger = new ActingLogger($this->module); $this->addError(new GenericError( self::RESOURCE_NOT_FOUND, $this->getConstantNameByValue(self::RESOURCE_NOT_FOUND), 404, function ($message) { return $message; }, __('Youre checkout session has expired or is not available', 'wcexaap') )); $this->addError((new GenericError( self::INVALID_CHECKOUT_SESSION_STATUS, $this->getConstantNameByValue(self::INVALID_CHECKOUT_SESSION_STATUS), 422, function ($message) { return $message; }, __('Illegal operation. Please try again.', 'wcexaap') ))->setLogger($actingLogger)); $this->addError((new GenericError( self::CONSTRAINT_CHECKOUT_RESULT_RETURN_URL_NOT_SET, $this->getConstantNameByValue(self::CONSTRAINT_CHECKOUT_RESULT_RETURN_URL_NOT_SET), 400, function ($message) { return $message; }, $defaultErrorMessage ))->setLogger($actingLogger)); $this->addError((new GenericError( self::CONSTRAINT_CHARGE_AMOUNT_NOT_SET, $this->getConstantNameByValue(self::CONSTRAINT_CHARGE_AMOUNT_NOT_SET), 400, function ($message) { return $message; }, $defaultErrorMessage ))->setLogger($actingLogger)); $this->addError((new GenericError( self::CONSTRAINT_PAYMENT_INTENT_NOT_SET, $this->getConstantNameByValue(self::CONSTRAINT_PAYMENT_INTENT_NOT_SET), 400, function ($message) { return $message; }, $defaultErrorMessage ))->setLogger($actingLogger)); $this->addError((new GenericError( self::CONSTRAINT_BUYER_NOT_ASSOCIATED, $this->getConstantNameByValue(self::CONSTRAINT_BUYER_NOT_ASSOCIATED), 400, function ($message) { return $message; }, __('Please select your preferred payment method and shipping address to complete the purchase.', 'wcexaap') ))->setLogger($actingLogger)); }} |
- __construct — Sets `$module` member var with dependency injection.
- getConstraintsResponse — Returns `AmazonGenericError` object created from response constraints
- hasConstraints — Parses update result and returns true if any constraints exist
- patch — Updates a checkout session
- populate — Populates error store
- setSettlementType — Setter for `settlementType` member variable.