interface OffsitePaymentMethodPluginInterface in Ubercart 8.4

Defines an interface for payment method plugins that redirect off-site.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\ConfigurableInterface
  • interface \Drupal\uc_payment\PaymentMethodPluginInterface
    • interface \Drupal\uc_payment\OffsitePaymentMethodPluginInterface

5 files declare their use of OffsitePaymentMethodPluginInterface

OffsitePaymentMethodForm.php in payment/uc_payment/src/Form/OffsitePaymentMethodForm.php

PayPalExpressCheckout.php in payment/uc_paypal/src/Plugin/Ubercart/PaymentMethod/PayPalExpressCheckout.php

PayPalPaymentsStandard.php in payment/uc_paypal/src/Plugin/Ubercart/PaymentMethod/PayPalPaymentsStandard.php

TwoCheckout.php in payment/uc_2checkout/src/Plugin/Ubercart/PaymentMethod/TwoCheckout.php

uc_payment.module in payment/uc_payment/uc_payment.module

Defines the payment API that lets payment modules interact with Ubercart.

File

payment/uc_payment/src/OffsitePaymentMethodPluginInterface.php, line 11

Namespace

Drupal\uc_payment

interface OffsitePaymentMethodPluginInterface extends PaymentMethodPluginInterface {

  /**
   * Form constructor.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param \Drupal\uc_order\OrderInterface $order
   *   The order that is being processed.
   *
   * @return array
   *   The form structure.
   */
  public function buildRedirectForm(array $form, FormStateInterface $form_state, OrderInterface $order);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
OffsitePaymentMethodPluginInterface::buildRedirectForm	public	function	Form constructor.	3
PaymentMethodPluginInterface::cartDetails	public	function	Returns the form or render array to be displayed at checkout.	1
PaymentMethodPluginInterface::cartProcess	public	function	Called when checkout is submitted with this payment method selected.	1
PaymentMethodPluginInterface::cartReview	public	function	Returns the payment method review details.	1
PaymentMethodPluginInterface::cartReviewTitle	public	function	Returns the payment method title to be used on the checkout review page.	1
PaymentMethodPluginInterface::customerView	public	function	Called when an order is being viewed by a customer.	1
PaymentMethodPluginInterface::getDisplayLabel	public	function	Returns the payment method label with logo.	1
PaymentMethodPluginInterface::orderDelete	public	function	Called when an order is being deleted.	1
PaymentMethodPluginInterface::orderEditDetails	public	function	Called when an order is being edited with this payment method.	1
PaymentMethodPluginInterface::orderEditProcess	public	function	Called when an order is being submitted after being edited.	1
PaymentMethodPluginInterface::orderLoad	public	function	Called when an order is being loaded with this payment method.	1
PaymentMethodPluginInterface::orderSave	public	function	Called when an order is being saved with this payment method.	1
PaymentMethodPluginInterface::orderSubmit	public	function	Called when an order is being submitted with this payment method.	1
PaymentMethodPluginInterface::orderView	public	function	Called when an order is being viewed by an administrator.	1
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2