You are here

Home » API reference » Commerce Square Connect 8 » Square.php

class Square in Commerce Square Connect 8

Provides the Square payment gateway.

Plugin annotation


@CommercePaymentGateway(
  id = "square",
  label = "Square",
  display_label = "Square",
  forms = {
    "add-payment-method" = "Drupal\commerce_square\PluginForm\Square\PaymentMethodAddForm",
  },
  js_library = "commerce_square/form",
  payment_method_types = {"credit_card"},
  credit_card_types = {
    "amex", "dinersclub", "discover", "jcb", "mastercard", "visa", "unionpay",
  },
)

Hierarchy

Expanded class hierarchy of Square

1 file declares its use of Square
SquareApiIntegrationTest.php in tests/src/Kernel/SquareApiIntegrationTest.php
3 string references to 'Square'
ConfigureGatewayTest::testCreateSquareGateway in tests/src/FunctionalJavascript/ConfigureGatewayTest.php
Tests that a Square gateway can be configured.
SquareApiIntegrationTest::setUp in tests/src/Kernel/SquareApiIntegrationTest.php
SquareConfigurationUpradeTest::testUpgrade1 in tests/src/Kernel/SquareConfigurationUpradeTest.php
Tests the config migrates.

File

src/Plugin/Commerce/PaymentGateway/Square.php, line 50

Namespace

Drupal\commerce_square\Plugin\Commerce\PaymentGateway
View source 
class Square extends OnsitePaymentGatewayBase implements SquareInterface {

  /**
   * The Connect application.
   *
   * @var \Drupal\commerce_square\Connect
   */
  protected $connect;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, PaymentTypeManager $payment_type_manager, PaymentMethodTypeManager $payment_method_type_manager, TimeInterface $time, Connect $connect) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $payment_type_manager, $payment_method_type_manager, $time);
    $this->pluginDefinition['modes']['test'] = $this
      ->t('Sandbox');
    $this->pluginDefinition['modes']['live'] = $this
      ->t('Production');
    $this->connect = $connect;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('plugin.manager.commerce_payment_type'), $container
      ->get('plugin.manager.commerce_payment_method_type'), $container
      ->get('datetime.time'), $container
      ->get('commerce_square.connect'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $default_configuration = [
      'test_location_id' => '',
      'live_location_id' => '',
    ];
    return $default_configuration + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    if (empty($this->connect
      ->getAppId('sandbox')) && empty($this->connect
      ->getAccessToken('sandbox'))) {
      $this
        ->messenger()
        ->addError($this
        ->t('Square has not been configured, please go to :link', [
        ':link' => Link::fromTextAndUrl($this
          ->t('the settings form'), Url::fromRoute('commerce_square.settings')),
      ]));
    }
    foreach (array_keys($this
      ->getSupportedModes()) as $mode) {
      $form[$mode] = [
        '#type' => 'fieldset',
        '#collapsible' => FALSE,
        '#collapsed' => FALSE,
        '#title' => $this
          ->t('@mode location', [
          '@mode' => $this->pluginDefinition['modes'][$mode],
        ]),
      ];
      $form[$mode][$mode . '_location_id'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Location'),
        '#description' => $this
          ->t('The location for the transactions.'),
        '#default_value' => $this->configuration[$mode . '_location_id'],
        '#required' => TRUE,
      ];
      $api_mode = $mode === 'test' ? 'sandbox' : 'production';
      $client = $this->connect
        ->getClient($api_mode);
      $location_api = new LocationsApi($client);
      try {
        $locations = $location_api
          ->listLocations();
        $location_options = $locations
          ->getLocations();
        $options = [];
        foreach ($location_options as $location_option) {
          $options[$location_option
            ->getId()] = $location_option
            ->getName();
        }
        $form[$mode][$mode . '_location_id']['#options'] = $options;
      } catch (\Exception $e) {
        $form[$mode][$mode . '_location_id']['#disabled'] = TRUE;
        $form[$mode][$mode . '_location_id']['#options'] = [
          '_none' => 'Not configured',
        ];
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::validateConfigurationForm($form, $form_state);
    $values = $form_state
      ->getValue($form['#parents']);
    $mode = $values['mode'];
    if (empty($values[$mode][$mode . '_location_id'])) {
      $form_state
        ->setError($form[$mode][$mode . '_location_id'], $this
        ->t('You must select a location for the configured mode.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $values = $form_state
      ->getValue($form['#parents']);
    foreach (array_keys($this
      ->getSupportedModes()) as $mode) {
      $this->configuration[$mode . '_location_id'] = $values[$mode][$mode . '_location_id'];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getApiClient() {
    $api_mode = $this
      ->getMode() == 'test' ? 'sandbox' : 'production';
    return $this->connect
      ->getClient($api_mode);
  }

  /**
   * {@inheritdoc}
   */
  public function createPayment(PaymentInterface $payment, $capture = TRUE) {
    $this
      ->assertPaymentState($payment, [
      'new',
    ]);
    $payment_method = $payment
      ->getPaymentMethod();
    $this
      ->assertPaymentMethod($payment_method);
    $paid_amount = $payment
      ->getAmount();
    $rounder = \Drupal::getContainer()
      ->get('commerce_price.rounder');

    /** @var \Drupal\commerce_price\Price $paid_amount */
    $paid_amount = $rounder
      ->round($paid_amount);
    $currency = $paid_amount
      ->getCurrencyCode();

    // Square only accepts integers and not floats.
    // @see https://docs.connect.squareup.com/api/connect/v2/#workingwithmonetaryamounts
    $square_total_amount = $this
      ->toMinorUnits($paid_amount);
    $billing = $payment_method
      ->getBillingProfile();

    /** @var \Drupal\address\Plugin\Field\FieldType\AddressItem $address */
    $address = $billing
      ->get('address')
      ->first();
    $mode = $this
      ->getMode();
    $order = new Order();
    $order
      ->setReferenceId($payment
      ->getOrderId());
    $order
      ->setLocationId($this->configuration[$mode . '_location_id']);
    $line_items = [];
    $line_item_total = 0;
    foreach ($payment
      ->getOrder()
      ->getItems() as $item) {
      $line_item = new OrderLineItem();
      $base_price_money = new Money();
      $square_amount = $this
        ->toMinorUnits($rounder
        ->round($item
        ->getUnitPrice()));
      $base_price_money
        ->setAmount($square_amount);
      $base_price_money
        ->setCurrency($currency);
      $line_item
        ->setBasePriceMoney($base_price_money);
      $square_amount = $this
        ->toMinorUnits($rounder
        ->round($item
        ->getTotalPrice()));
      $line_item
        ->setName($item
        ->getTitle());

      // Quantity needs to be a string integer.
      $line_item
        ->setQuantity((string) (int) $item
        ->getQuantity());
      $line_item_total += $square_amount;
      $line_items[] = $line_item;
    }

    // Square requires the order total to match the payment amount.
    if ($line_item_total != $square_total_amount) {
      $diff = $square_total_amount - $line_item_total;
      if ($diff < 0) {
        $discount_money = new Money();
        $discount_money
          ->setCurrency($currency);
        $discount_money
          ->setAmount(-$diff);
        $discount = new CreateOrderRequestDiscount();
        $discount
          ->setAmountMoney($discount_money);
        $discount
          ->setName('Adjustments');
      }
      else {
        $line_item = new OrderLineItem();
        $total_money = new Money();
        $total_money
          ->setAmount((int) $diff);
        $total_money
          ->setCurrency($currency);
        $line_item
          ->setBasePriceMoney($total_money);
        $line_item
          ->setName('Adjustments');
        $line_item
          ->setQuantity("1");
        $line_items[] = $line_item;
      }
    }
    $order
      ->setLineItems($line_items);
    if (isset($discount)) {
      $order
        ->setDiscounts([
        $discount,
      ]);
    }

    // @todo integration_id is not supported by the SDK.
    // @see https://github.com/square/connect-php-sdk/issues/94
    $charge_request = new IntegrationChargeRequest();
    $charge_request
      ->setAmountMoney(new Money([
      'amount' => $square_total_amount,
      'currency' => $currency,
    ]));
    if ($mode === 'live') {
      $charge_request
        ->setIntegrationId('sqi_b6ff0cd7acc14f7ab24200041d066ba6');
    }
    $charge_request
      ->setDelayCapture(!$capture);
    $charge_request
      ->setCardNonce($payment_method
      ->getRemoteId());
    $charge_request
      ->setIdempotencyKey(uniqid('', TRUE));
    $charge_request
      ->setBuyerEmailAddress($payment
      ->getOrder()
      ->getEmail());
    $charge_request
      ->setBillingAddress(new Address([
      'address_line_1' => $address
        ->getAddressLine1(),
      'address_line_2' => $address
        ->getAddressLine2(),
      'locality' => $address
        ->getLocality(),
      'sublocality' => $address
        ->getDependentLocality(),
      'administrative_district_level_1' => $address
        ->getAdministrativeArea(),
      'postal_code' => $address
        ->getPostalCode(),
      'country' => $address
        ->getCountryCode(),
      'first_name' => $address
        ->getGivenName(),
      'last_name' => $address
        ->getFamilyName(),
      'organization' => $address
        ->getOrganization(),
    ]));
    try {
      $api_client = $this
        ->getApiClient();

      // Create order.
      $order_request = new CreateOrderRequest();
      $order_request
        ->setIdempotencyKey(uniqid($payment
        ->getOrderId() . '-', TRUE));
      $order_request
        ->setOrder($order);
      $orders_api = new OrdersApi($api_client);
      $result = $orders_api
        ->createOrder($this->configuration[$mode . '_location_id'], $order_request);
      $charge_request
        ->setOrderId($result
        ->getOrder()
        ->getId());
      $transactions_api = new TransactionsApi($api_client);
      $result = $transactions_api
        ->charge($this->configuration[$mode . '_location_id'], $charge_request);
    } catch (ApiException $e) {
      throw ErrorHelper::convertException($e);
    }
    $transaction = $result
      ->getTransaction();
    $tender = $transaction
      ->getTenders()[0];
    $next_state = $capture ? 'completed' : 'authorization';
    $payment
      ->setState($next_state);
    $payment
      ->setRemoteId($transaction
      ->getId() . '|' . $tender
      ->getId());
    $payment
      ->setAuthorizedTime($transaction
      ->getCreatedAt());
    if ($capture) {
      $payment
        ->setCompletedTime($result
        ->getTransaction()
        ->getCreatedAt());
    }
    else {
      $expires = $this->time
        ->getRequestTime() + 3600 * 24 * 6 - 5;
      $payment
        ->setExpiresTime($expires);
    }
    $payment
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function createPaymentMethod(PaymentMethodInterface $payment_method, array $payment_details) {
    $required_keys = [
      'payment_method_nonce',
      'card_type',
      'last4',
    ];
    foreach ($required_keys as $required_key) {
      if (empty($payment_details[$required_key])) {
        throw new \InvalidArgumentException(sprintf('$payment_details must contain the %s key.', $required_key));
      }
    }

    // @todo Make payment methods reusable. Currently they represent 24hr nonce.
    // @see https://docs.connect.squareup.com/articles/processing-recurring-payments-ruby
    // Meet specific requirements for reusable, permanent methods.
    $payment_method
      ->setReusable(FALSE);
    $payment_method->card_type = $this
      ->mapCreditCardType($payment_details['card_type']);
    $payment_method->card_number = $payment_details['last4'];
    $payment_method->card_exp_month = $payment_details['exp_month'];
    $payment_method->card_exp_year = $payment_details['exp_year'];
    $remote_id = $payment_details['payment_method_nonce'];
    $payment_method
      ->setRemoteId($remote_id);

    // Nonces expire after 24h. We reduce that time by 5s to account for the
    // time it took to do the server request after the JS tokenization.
    $expires = $this->time
      ->getRequestTime() + 3600 * 24 - 5;
    $payment_method
      ->setExpiresTime($expires);
    $payment_method
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function deletePaymentMethod(PaymentMethodInterface $payment_method) {

    // @todo Currently there are no remote records stored.
    // Delete the local entity.
    $payment_method
      ->delete();
  }

  /**
   * {@inheritdoc}
   */
  public function capturePayment(PaymentInterface $payment, Price $amount = NULL) {
    $this
      ->assertPaymentState($payment, [
      'authorization',
    ]);
    $amount = $amount ?: $payment
      ->getAmount();

    // Square only accepts integers and not floats.
    // @see https://docs.connect.squareup.com/api/connect/v2/#workingwithmonetaryamounts
    list($transaction_id, $tender_id) = explode('|', $payment
      ->getRemoteId());
    $mode = $this
      ->getMode();
    try {
      $transaction_api = new TransactionsApi($this
        ->getApiClient());
      $result = $transaction_api
        ->captureTransaction($this->configuration[$mode . '_location_id'], $transaction_id);
    } catch (ApiException $e) {
      throw ErrorHelper::convertException($e);
    }
    $payment
      ->setState('completed');
    $payment
      ->setAmount($amount);
    $payment
      ->setCompletedTime($this->time
      ->getRequestTime());
    $payment
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function voidPayment(PaymentInterface $payment) {
    $this
      ->assertPaymentState($payment, [
      'authorization',
    ]);
    list($transaction_id, $tender_id) = explode('|', $payment
      ->getRemoteId());
    $mode = $this
      ->getMode();
    try {
      $transaction_api = new TransactionsApi($this
        ->getApiClient());
      $result = $transaction_api
        ->voidTransaction($this->configuration[$mode . '_location_id'], $transaction_id);
    } catch (ApiException $e) {
      throw ErrorHelper::convertException($e);
    }
    $payment
      ->setState('authorization_voided');
    $payment
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function refundPayment(PaymentInterface $payment, Price $amount = NULL) {
    $this
      ->assertPaymentState($payment, [
      'completed',
      'partially_refunded',
    ]);
    $amount = $amount ?: $payment
      ->getAmount();

    // Square only accepts integers and not floats.
    // @see https://docs.connect.squareup.com/api/connect/v2/#workingwithmonetaryamounts
    $square_amount = $this
      ->toMinorUnits($amount);
    list($transaction_id, $tender_id) = explode('|', $payment
      ->getRemoteId());
    $refund_request = new CreateRefundRequest([
      'idempotency_key' => uniqid(),
      'tender_id' => $tender_id,
      'amount_money' => new Money([
        'amount' => $square_amount,
        'currency' => $amount
          ->getCurrencyCode(),
      ]),
      'reason' => (string) $this
        ->t('Refunded through store backend'),
    ]);
    $mode = $this
      ->getMode();
    try {
      $transaction_api = new TransactionsApi($this
        ->getApiClient());
      $result = $transaction_api
        ->createRefund($this->configuration[$mode . '_location_id'], $transaction_id, $refund_request);
    } catch (ApiException $e) {
      throw ErrorHelper::convertException($e);
    }
    $old_refunded_amount = $payment
      ->getRefundedAmount();
    $new_refunded_amount = $old_refunded_amount
      ->add($amount);
    if ($new_refunded_amount
      ->lessThan($payment
      ->getAmount())) {
      $payment
        ->setState('partially_refunded');
    }
    else {
      $payment
        ->setState('refunded');
    }
    $payment
      ->setRefundedAmount($new_refunded_amount);
    $payment
      ->save();
  }

  /**
   * Maps the Square credit card type to a Commerce credit card type.
   *
   * @param string $card_type
   *   The Square credit card type.
   *
   * @return string
   *   The Commerce credit card type.
   */
  protected function mapCreditCardType($card_type) {
    $map = [
      'AMERICAN_EXPRESS' => 'amex',
      'CHINA_UNIONPAY' => 'unionpay',
      'DISCOVER_DINERS' => 'dinersclub',
      'DISCOVER' => 'discover',
      'JCB' => 'jcb',
      'MASTERCARD' => 'mastercard',
      'VISA' => 'visa',
    ];
    if (!isset($map[$card_type])) {
      throw new HardDeclineException(sprintf('Unsupported credit card type "%s".', $card_type));
    }
    return $map[$card_type];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OnsitePaymentGatewayBase::getDefaultForms protected function Gets the default payment gateway forms. Overrides PaymentGatewayBase::getDefaultForms
PaymentGatewayBase::$entityId Deprecated protected property The ID of the parent config entity.
PaymentGatewayBase::$entityTypeManager protected property The entity type manager.
PaymentGatewayBase::$minorUnitsConverter protected property The minor units converter.
PaymentGatewayBase::$parentEntity protected property The parent config entity.
PaymentGatewayBase::$paymentMethodTypes protected property The payment method types handled by the gateway.
PaymentGatewayBase::$paymentType protected property The payment type used by the gateway.
PaymentGatewayBase::$time protected property The time.
PaymentGatewayBase::assertPaymentMethod protected function Asserts that the payment method is neither empty nor expired.
PaymentGatewayBase::assertPaymentState protected function Asserts that the payment state matches one of the allowed states.
PaymentGatewayBase::assertRefundAmount protected function Asserts that the refund amount is valid.
PaymentGatewayBase::buildAvsResponseCodeLabel public function Builds a label for the given AVS response code and card type. Overrides PaymentGatewayInterface::buildAvsResponseCodeLabel 2
PaymentGatewayBase::buildPaymentOperations public function Builds the available operations for the given payment. Overrides PaymentGatewayInterface::buildPaymentOperations 1
PaymentGatewayBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
PaymentGatewayBase::canCapturePayment public function
PaymentGatewayBase::canRefundPayment public function
PaymentGatewayBase::canVoidPayment public function
PaymentGatewayBase::collectsBillingInformation public function Gets whether the payment gateway collects billing information. Overrides PaymentGatewayInterface::collectsBillingInformation
PaymentGatewayBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PaymentGatewayBase::getCreditCardTypes public function Gets the credit card types handled by the gateway. Overrides PaymentGatewayInterface::getCreditCardTypes
PaymentGatewayBase::getDefaultPaymentMethodType public function Gets the default payment method type. Overrides PaymentGatewayInterface::getDefaultPaymentMethodType
PaymentGatewayBase::getDisplayLabel public function Gets the payment gateway display label. Overrides PaymentGatewayInterface::getDisplayLabel
PaymentGatewayBase::getJsLibrary public function Gets the JS library ID. Overrides PaymentGatewayInterface::getJsLibrary
PaymentGatewayBase::getLabel public function Gets the payment gateway label. Overrides PaymentGatewayInterface::getLabel
PaymentGatewayBase::getMode public function Gets the mode in which the payment gateway is operating. Overrides PaymentGatewayInterface::getMode
PaymentGatewayBase::getPaymentMethodTypes public function Gets the payment method types handled by the payment gateway. Overrides PaymentGatewayInterface::getPaymentMethodTypes
PaymentGatewayBase::getPaymentType public function Gets the payment type used by the payment gateway. Overrides PaymentGatewayInterface::getPaymentType
PaymentGatewayBase::getRemoteCustomerId protected function Gets the remote customer ID for the given user.
PaymentGatewayBase::getSupportedModes public function Gets the supported modes. Overrides PaymentGatewayInterface::getSupportedModes
PaymentGatewayBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PaymentGatewayBase::setRemoteCustomerId protected function Sets the remote customer ID for the given user.
PaymentGatewayBase::toMinorUnits public function Converts the given amount to its minor units. Overrides PaymentGatewayInterface::toMinorUnits
PaymentGatewayBase::__sleep public function Overrides DependencySerializationTrait::__sleep
PaymentGatewayBase::__wakeup public function Overrides DependencySerializationTrait::__wakeup
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
Square::$connect protected property The Connect application.
Square::buildConfigurationForm public function Form constructor. Overrides OnsitePaymentGatewayBase::buildConfigurationForm
Square::capturePayment public function Captures the given authorized payment. Overrides SupportsAuthorizationsInterface::capturePayment
Square::create public static function Creates an instance of the plugin. Overrides PaymentGatewayBase::create
Square::createPayment public function Creates a payment. Overrides SupportsStoredPaymentMethodsInterface::createPayment
Square::createPaymentMethod public function Creates a payment method with the given payment details. Overrides SupportsCreatingPaymentMethodsInterface::createPaymentMethod
Square::defaultConfiguration public function Gets default configuration for this plugin. Overrides PaymentGatewayBase::defaultConfiguration
Square::deletePaymentMethod public function Deletes the given payment method. Overrides SupportsStoredPaymentMethodsInterface::deletePaymentMethod
Square::getApiClient public function Gets a configured API client. Overrides SquareInterface::getApiClient
Square::mapCreditCardType protected function Maps the Square credit card type to a Commerce credit card type.
Square::refundPayment public function Refunds the given payment. Overrides SupportsRefundsInterface::refundPayment
Square::submitConfigurationForm public function Form submission handler. Overrides PaymentGatewayBase::submitConfigurationForm
Square::validateConfigurationForm public function Form validation handler. Overrides PaymentGatewayBase::validateConfigurationForm
Square::voidPayment public function Voids the given payment. Overrides SupportsVoidsInterface::voidPayment
Square::__construct public function Constructs a new PaymentGatewayBase object. Overrides PaymentGatewayBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.