commerce_authnet.post_update.php in Commerce Authorize.Net 8

Post update functions for commerce_authnet.

File

commerce_authnet.post_update.php

<?php

/**
 * @file
 * Post update functions for commerce_authnet.
 */
use Drupal\commerce_payment\Entity\PaymentGatewayInterface;

/**
 * Separate echeck payment gateways from accept.js and update all affected
 * payment_methods and payments.
 */
function commerce_authnet_post_update_echeck(&$sandbox) {
  \Drupal::service('plugin.manager.commerce_payment_gateway')
    ->clearCachedDefinitions();
  $entity_type_manager = \Drupal::entityTypeManager();
  $payment_gateway_storage = $entity_type_manager
    ->getStorage('commerce_payment_gateway');
  $payment_method_storage = $entity_type_manager
    ->getStorage('commerce_payment_method');
  $payment_storage = $entity_type_manager
    ->getStorage('commerce_payment');
  $order_storage = $entity_type_manager
    ->getStorage('commerce_order');
  if (!isset($sandbox['progress'])) {
    $sandbox['progress'] = 0;
    $sandbox['echeck_payment_methods'] = [];

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface[] $gateways */
    $gateways = $payment_gateway_storage
      ->loadMultiple();
    foreach ($gateways as $gateway) {
      if ($gateway
        ->getPluginId() !== 'authorizenet') {
        continue;
      }
      $config = $gateway
        ->getPluginConfiguration();
      unset($config['transaction_type']);
      $original_label = $gateway
        ->label();
      foreach ($config['payment_method_types'] as $payment_method_type) {
        if ($payment_method_type === 'credit_card') {

          // We only rename ids and labels if both credit card and echeck was
          // enabled.
          $gateway
            ->setPluginId('authorizenet_acceptjs');

          // Changing the plugin ID will reset the configuration, put it back.
          $gateway
            ->setPluginConfiguration($config);
          if (count($config['payment_method_types']) > 1) {
            $gateway
              ->set('label', $original_label . ' ' . t('Credit card'));
            $new_config = $config;
            $new_config['display_label'] .= ' ' . t('Credit card');
            unset($new_config['payment_method_types']['authnet_echeck']);
            $gateway
              ->setPluginConfiguration($new_config);
          }
        }
        else {

          // If the gateway had both credit_card and echeck enabled, we keep
          // the original gateway for credit_card and create a new one here
          // for echeck.
          if (count($config['payment_method_types']) > 1) {
            $new_gateway = $gateway
              ->createDuplicate();
            $new_config = $config;
            $new_gateway
              ->setPluginId('authorizenet_echeck');
            $new_gateway
              ->set('id', $gateway
              ->id() . '_echeck');
            $new_gateway
              ->set('label', $gateway
              ->label() . ' ' . t('Echeck'));
            $new_config['display_label'] .= ' ' . t('Echeck');
            $sandbox['echeck_payment_methods'] += $payment_method_storage
              ->getQuery()
              ->condition('type', 'authnet_echeck')
              ->condition('payment_gateway', $gateway
              ->id())
              ->execute();
            unset($new_config['payment_method_types']['credit_card']);
            $new_gateway
              ->setPluginConfiguration($new_config);
            $new_gateway
              ->save();
          }
          else {
            $gateway
              ->setPluginId('authorizenet_echeck');
            $gateway
              ->setPluginConfiguration($config);
          }
        }
      }
      $gateway
        ->save();
    }
    $sandbox['max'] = count($sandbox['echeck_payment_methods']);
  }

  // Update echeck orders, payment_methods and payments in batch.
  for ($i = 1; $i <= 20; $i++) {
    if (empty($sandbox['echeck_payment_methods'])) {
      break;
    }
    $payment_method_id = array_shift($sandbox['echeck_payment_methods']);
    $payment_method = $payment_method_storage
      ->load($payment_method_id);
    $new_payment_gateway_id = $payment_method
      ->getPaymentGatewayId() . '_echeck';
    $payment_method
      ->set('payment_gateway', $new_payment_gateway_id);
    $payment_method
      ->save();
    $payment_ids = $payment_storage
      ->getQuery()
      ->condition('payment_method', $payment_method
      ->id())
      ->execute();
    foreach ($payment_ids as $payment_id) {
      $payment = $payment_storage
        ->load($payment_id);
      $payment
        ->set('payment_gateway', $new_payment_gateway_id);
      $payment
        ->save();
    }
    $order_ids = $order_storage
      ->getQuery()
      ->condition('payment_method', $payment_method
      ->id())
      ->execute();
    foreach ($order_ids as $order_id) {
      $order = $order_storage
        ->load($order_id);
      $order
        ->set('payment_gateway', $new_payment_gateway_id);
      $order
        ->save();
    }
    $sandbox['progress']++;
  }
  if (!empty($sandbox['max']) && count($sandbox['echeck_payment_methods']) > 0) {
    $sandbox['#finished'] = empty($sandbox['max']) ? 1 : $sandbox['progress'] / count($sandbox['echeck_payment_methods']);
  }
  else {
    $sandbox['#finished'] = 1;
  }
  return t('All Authorize.net gateways, payment methods and payments have been updated. Please double check all configuration.');
}

/**
 * Verify that AcceptJS and eCheck payment gateways have the client_key configured.
 */
function commerce_authnet_post_update_verify_client_key() {
  $entity_type_manager = \Drupal::entityTypeManager();
  $payment_gateway_storage = $entity_type_manager
    ->getStorage('commerce_payment_gateway');

  /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface[] $gateways */
  $gateways = array_filter($payment_gateway_storage
    ->loadMultiple(), function (PaymentGatewayInterface $gateway) {
    return in_array($gateway
      ->getPluginId(), [
      'authorizenet_acceptjs',
      'authorizenet_echeck',
    ]);
  });
  $gateways_with_warnings = [];
  foreach ($gateways as $gateway) {
    $configuration = $gateway
      ->getPluginConfiguration();
    if (empty($configuration['client_key'])) {
      $gateways_with_warnings[] = $gateway
        ->label();
    }
  }
  if (!empty($gateways_with_warnings)) {
    return t('Please provide a client key for %labels. It is required to continue accepting payments.', [
      '%labels' => implode(', ', $gateways_with_warnings),
    ]);
  }
  return t('All Authorize.net payment gateways which require a client key have it configured.');
}

Functions

Name	Description
commerce_authnet_post_update_echeck	Separate echeck payment gateways from accept.js and update all affected payment_methods and payments.
commerce_authnet_post_update_verify_client_key	Verify that AcceptJS and eCheck payment gateways have the client_key configured.