You are here

UbercartPaymentMethod.php in Ubercart 8.4

File

payment/uc_payment/src/Annotation/UbercartPaymentMethod.php
View source
<?php

namespace Drupal\uc_payment\Annotation;

use Drupal\Component\Annotation\Plugin;

/**
 * Defines an Ubercart payment method annotation object.
 *
 * @Annotation
 */
class UbercartPaymentMethod extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human readable name of the payment method.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $name;

  /**
   * If TRUE, the plugin will be hidden from the UI.
   *
   * @var bool
   */
  public $no_ui = FALSE;

  /**
   * Submit button form class name, for redirect methods.
   *
   * Name of a class that implements \Drupal\Core\Form\FormBase and provides
   * a Submit button on the /cart/checkout/review page redirecting to an
   * external payment site.
   *
   * @var string
   */
  public $redirect = NULL;

  /**
   * Express button form class name.
   *
   * Name of a class that implements \Drupal\Core\Form\FormBase and provides
   * an express checkout button for the /cart page.
   *
   * @var string
   */
  public $express = NULL;

}

Classes

Namesort descending Description
UbercartPaymentMethod Defines an Ubercart payment method annotation object.