TestGateway.php in Ubercart 8.4

Namespace

Drupal\uc_credit\Plugin\Ubercart\PaymentMethod

File

payment/uc_credit/src/Plugin/Ubercart/PaymentMethod/TestGateway.php

<?php

namespace Drupal\uc_credit\Plugin\Ubercart\PaymentMethod;

use Drupal\Core\Form\FormStateInterface;
use Drupal\uc_credit\CreditCardPaymentMethodBase;
use Drupal\uc_order\OrderInterface;

/**
 * Defines the test gateway payment method.
 *
 * This is a dummy payment gateway to use for testing or as an example. All
 * payments using this test gateway will succeed, except when one of the
 * following is TRUE:
 * - Credit card number equals '0000000000000000'. (Note that ANY card number
 *   that fails the Luhn algorithm check performed by uc_credit will not even be
 *   submitted to this gateway).
 * - CVV equals '000'.
 * - Credit card is expired.
 * - Payment amount equals 12.34 in store currency units.
 * - Customer's billing first name equals 'Fictitious'.
 * - Customer's billing telephone number equals '8675309'.
 *
 * @UbercartPaymentMethod(
 *   id = "test_gateway",
 *   name = @Translation("Test gateway"),
 * )
 */
class TestGateway extends CreditCardPaymentMethodBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'debug' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['debug'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Debug'),
      '#description' => $this
        ->t('Log debug payment information to dblog when card is "charged" by this gateway.'),
      '#default_value' => $this->configuration['debug'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['debug'] = $form_state
      ->getValue('debug');
    return parent::submitConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  protected function chargeCard(OrderInterface $order, $amount, $txn_type, $reference = NULL) {
    $user = \Drupal::currentUser();

    // cc_exp_month and cc_exp_year are also validated by
    // CreditCardPaymentMethodBase::validateExpirationDate().
    $month = $order->payment_details['cc_exp_month'];
    $year = $order->payment_details['cc_exp_year'];
    if ($year < 100) {
      $year = $year + 2000;
    }

    // Card is expired at 0:00 on the first day of the next month.
    $expiration_date = mktime(0, 0, 0, $month + 1, 1, $year);

    // Conditions for failure are described in file documentation block above.
    // All other transactions will succeed.
    if ($order->payment_details['cc_number'] == '0000000000000000') {
      $error = 'Invalid credit card number';
      $success = FALSE;
    }
    elseif (isset($order->payment_details['cc_cvv']) && $order->payment_details['cc_cvv'] == '000') {
      $error = 'Invalid CVV';
      $success = FALSE;
    }
    elseif ($expiration_date - REQUEST_TIME <= 0) {
      $error = 'Card is expired';
      $success = FALSE;
    }
    elseif ($amount == 12.34) {
      $error = 'Invalid payment amount';
      $success = FALSE;
    }
    elseif ($order->billing_first_name == 'Fictitious') {
      $error = 'Invalid customer name';
      $success = FALSE;
    }
    elseif ($order->billing_phone == '8675309') {
      $error = 'Obviously fake phone number';
      $success = FALSE;
    }
    else {
      $success = TRUE;
    }

    // The information for the payment is in the $order->payment_details array.
    if ($this->configuration['debug']) {
      \Drupal::logger('uc_credit')
        ->notice('Test gateway payment details @details.', [
        '@details' => print_r($order->payment_details, TRUE),
      ]);
    }
    if ($success) {
      $message = $this
        ->t('Credit card charged: @amount', [
        '@amount' => uc_currency_format($amount),
      ]);
      $comment = $this
        ->t('Card charged, resolution code: 0022548315');
    }
    else {
      $message = $this
        ->t('Credit card charge failed.');
      $comment = $this
        ->t('Card failed authorization, reason: @error', [
        '@error' => $error,
      ]);
    }
    uc_order_comment_save($order
      ->id(), $user
      ->id(), $message, 'admin');
    return [
      'success' => $success,
      'comment' => $comment,
      'message' => $message,
      'uid' => $user
        ->id(),
    ];
  }

}

Classes

Name	Description
TestGateway	Defines the test gateway payment method.