ErrorHelper.php in Commerce Square Connect 8

Namespace

Drupal\commerce_square

File

src/ErrorHelper.php

<?php

namespace Drupal\commerce_square;

use Drupal\commerce_payment\Exception\HardDeclineException;
use Drupal\commerce_payment\Exception\InvalidResponseException;
use Drupal\commerce_payment\Exception\SoftDeclineException;
use SquareConnect\ApiException;

/**
 * Translates Square exceptions and errors into Commerce exceptions.
 *
 * @see https://docs.connect.squareup.com/api/connect/v2/#type-errorcategory
 * @see https://docs.connect.squareup.com/api/connect/v2/#type-errorcode
 */
class ErrorHelper {

  /**
   * Translates Square exceptions into Commerce exceptions.
   *
   * @param \SquareConnect\ApiException $exception
   *   The Square exception.
   *
   * @return \Drupal\commerce_payment\Exception\PaymentGatewayException
   *   The Commerce exception.
   */
  public static function convertException(ApiException $exception) {
    $response_body = $exception
      ->getResponseBody();
    $error = reset($response_body->errors);
    switch ($error->category) {
      case 'PAYMENT_METHOD_ERROR':
        return new SoftDeclineException($error->detail);
      case 'REFUND_ERROR':
        return new HardDeclineException($error->detail);
      default:

        // All other error categories are API request related.
        return new InvalidResponseException($exception
          ->getMessage(), $exception
          ->getCode(), $exception);
    }
  }

}

Classes

Name	Description
ErrorHelper	Translates Square exceptions and errors into Commerce exceptions.