interface PaymentGatewayFormInterface in Commerce Core 8.2

Defines the interface for payment gateway plugin forms.

Hierarchy

• interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\commerce_payment\PluginForm\PaymentGatewayFormInterface

1 file declares its use of PaymentGatewayFormInterface

PaymentGatewayForm.php in modules/payment/src/Plugin/Commerce/InlineForm/PaymentGatewayForm.php

File

modules/payment/src/PluginForm/PaymentGatewayFormInterface.php, line 12

Namespace

Drupal\commerce_payment\PluginForm

interface PaymentGatewayFormInterface extends PluginFormInterface {

  /**
   * Gets the form entity.
   *
   * Allows the parent form to get the updated form entity after submitForm()
   * performs the final changes.
   *
   * @return \Drupal\commerce_payment\Entity\EntityWithPaymentGatewayInterface
   *   The form entity.
   */
  public function getEntity();

  /**
   * Sets the form entity.
   *
   * @param \Drupal\commerce_payment\Entity\EntityWithPaymentGatewayInterface $entity
   *   The form entity.
   *
   * @return $this
   */
  public function setEntity(EntityWithPaymentGatewayInterface $entity);

  /**
   * Gets the form element to which errors should be assigned.
   *
   * @param array $form
   *   The form, as built by buildConfigurationForm().
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The form element.
   */
  public function getErrorElement(array $form, FormStateInterface $form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
PaymentGatewayFormInterface::getEntity	public	function	Gets the form entity.	1
PaymentGatewayFormInterface::getErrorElement	public	function	Gets the form element to which errors should be assigned.	1
PaymentGatewayFormInterface::setEntity	public	function	Sets the form entity.	1
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18