class UbercartPaymentMethod in Ubercart 8.4

Defines an Ubercart payment method annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\uc_payment\Annotation\UbercartPaymentMethod

1 file declares its use of UbercartPaymentMethod

PaymentMethodManager.php in payment/uc_payment/src/Plugin/PaymentMethodManager.php

10 classes are annotated with UbercartPaymentMethod

AuthorizeNet in payment/uc_authorizenet/src/Plugin/Ubercart/PaymentMethod/AuthorizeNet.php

Defines the Authorize.net payment method.

CashOnDelivery in payment/uc_payment_pack/src/Plugin/Ubercart/PaymentMethod/CashOnDelivery.php

Defines the cash on delivery payment method.

Check in payment/uc_payment_pack/src/Plugin/Ubercart/PaymentMethod/Check.php

Defines the check payment method.

FreeOrder in payment/uc_payment/src/Plugin/Ubercart/PaymentMethod/FreeOrder.php

Defines a free order payment method.

Other in payment/uc_payment_pack/src/Plugin/Ubercart/PaymentMethod/Other.php

Defines a generic payment method.

... See full list

File

payment/uc_payment/src/Annotation/UbercartPaymentMethod.php, line 12

Namespace

Drupal\uc_payment\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;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
UbercartPaymentMethod::$express	public	property	Express button form class name.
UbercartPaymentMethod::$id	public	property	The plugin ID.
UbercartPaymentMethod::$name	public	property	The human readable name of the payment method.
UbercartPaymentMethod::$no_ui	public	property	If TRUE, the plugin will be hidden from the UI.
UbercartPaymentMethod::$redirect	public	property	Submit button form class name, for redirect methods.