abstract class OnsitePaymentGatewayBase in Commerce Core 8.2

Provides the base class for on-site payment gateways.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\PaymentGatewayBase implements PaymentGatewayInterface, ContainerFactoryPluginInterface uses PluginWithFormsTrait
      • class \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\OnsitePaymentGatewayBase implements OnsitePaymentGatewayInterface

1 file declares its use of OnsitePaymentGatewayBase

Onsite.php in modules/payment_example/src/Plugin/Commerce/PaymentGateway/Onsite.php

File

modules/payment/src/Plugin/Commerce/PaymentGateway/OnsitePaymentGatewayBase.php, line 10

Namespace

Drupal\commerce_payment\Plugin\Commerce\PaymentGateway

abstract class OnsitePaymentGatewayBase extends PaymentGatewayBase implements OnsitePaymentGatewayInterface {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);

    // The PaymentInformation pane uses payment method labels
    // for on-site gateways, the display label is unused.
    $form['display_label']['#access'] = FALSE;
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultForms() {
    return [
      'add-payment' => 'Drupal\\commerce_payment\\PluginForm\\OnsitePaymentAddForm',
    ] + parent::getDefaultForms();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OnsitePaymentGatewayBase::buildConfigurationForm	public	function	Form constructor. Overrides PaymentGatewayBase::buildConfigurationForm	1
OnsitePaymentGatewayBase::getDefaultForms	protected	function	Gets the default payment gateway forms. Overrides PaymentGatewayBase::getDefaultForms
PaymentGatewayBase::$entityId Deprecated	protected	property	The ID of the parent config entity.
PaymentGatewayBase::$entityTypeManager	protected	property	The entity type manager.
PaymentGatewayBase::$minorUnitsConverter	protected	property	The minor units converter.
PaymentGatewayBase::$parentEntity	protected	property	The parent config entity.
PaymentGatewayBase::$paymentMethodTypes	protected	property	The payment method types handled by the gateway.
PaymentGatewayBase::$paymentType	protected	property	The payment type used by the gateway.
PaymentGatewayBase::$time	protected	property	The time.
PaymentGatewayBase::assertPaymentMethod	protected	function	Asserts that the payment method is neither empty nor expired.
PaymentGatewayBase::assertPaymentState	protected	function	Asserts that the payment state matches one of the allowed states.
PaymentGatewayBase::assertRefundAmount	protected	function	Asserts that the refund amount is valid.
PaymentGatewayBase::buildAvsResponseCodeLabel	public	function	Builds a label for the given AVS response code and card type. Overrides PaymentGatewayInterface::buildAvsResponseCodeLabel	2
PaymentGatewayBase::buildPaymentOperations	public	function	Builds the available operations for the given payment. Overrides PaymentGatewayInterface::buildPaymentOperations	1
PaymentGatewayBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
PaymentGatewayBase::canCapturePayment	public	function
PaymentGatewayBase::canRefundPayment	public	function
PaymentGatewayBase::canVoidPayment	public	function
PaymentGatewayBase::collectsBillingInformation	public	function	Gets whether the payment gateway collects billing information. Overrides PaymentGatewayInterface::collectsBillingInformation
PaymentGatewayBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
PaymentGatewayBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	3
PaymentGatewayBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PaymentGatewayBase::getCreditCardTypes	public	function	Gets the credit card types handled by the gateway. Overrides PaymentGatewayInterface::getCreditCardTypes
PaymentGatewayBase::getDefaultPaymentMethodType	public	function	Gets the default payment method type. Overrides PaymentGatewayInterface::getDefaultPaymentMethodType
PaymentGatewayBase::getDisplayLabel	public	function	Gets the payment gateway display label. Overrides PaymentGatewayInterface::getDisplayLabel
PaymentGatewayBase::getJsLibrary	public	function	Gets the JS library ID. Overrides PaymentGatewayInterface::getJsLibrary
PaymentGatewayBase::getLabel	public	function	Gets the payment gateway label. Overrides PaymentGatewayInterface::getLabel
PaymentGatewayBase::getMode	public	function	Gets the mode in which the payment gateway is operating. Overrides PaymentGatewayInterface::getMode
PaymentGatewayBase::getPaymentMethodTypes	public	function	Gets the payment method types handled by the payment gateway. Overrides PaymentGatewayInterface::getPaymentMethodTypes
PaymentGatewayBase::getPaymentType	public	function	Gets the payment type used by the payment gateway. Overrides PaymentGatewayInterface::getPaymentType
PaymentGatewayBase::getRemoteCustomerId	protected	function	Gets the remote customer ID for the given user.
PaymentGatewayBase::getSupportedModes	public	function	Gets the supported modes. Overrides PaymentGatewayInterface::getSupportedModes
PaymentGatewayBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PaymentGatewayBase::setRemoteCustomerId	protected	function	Sets the remote customer ID for the given user.
PaymentGatewayBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	3
PaymentGatewayBase::toMinorUnits	public	function	Converts the given amount to its minor units. Overrides PaymentGatewayInterface::toMinorUnits
PaymentGatewayBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
PaymentGatewayBase::__construct	public	function	Constructs a new PaymentGatewayBase object. Overrides PluginBase::__construct	3
PaymentGatewayBase::__sleep	public	function	Overrides DependencySerializationTrait::__sleep
PaymentGatewayBase::__wakeup	public	function	Overrides DependencySerializationTrait::__wakeup
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass	public	function
PluginWithFormsTrait::hasFormClass	public	function
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
SupportsCreatingPaymentMethodsInterface::createPaymentMethod	public	function	Creates a payment method with the given payment details.	1
SupportsStoredPaymentMethodsInterface::createPayment	public	function	Creates a payment.	2
SupportsStoredPaymentMethodsInterface::deletePaymentMethod	public	function	Deletes the given payment method.	2