class PaymentGatewayForm in Commerce Core 8.2

Provides a form element for embedding the payment gateway forms.

$form['payment_method'] = [
  '#type' => 'commerce_payment_gateway_form',
  '#operation' => 'add-payment-method',
  // A payment or payment method entity, depending on the operation.
  // On submit, the payment method will be created remotely, and the
  // entity updated, for access via $form_state->getValue('payment_method')
  '#default_value' => $payment_method,
];

Plugin annotation

@RenderElement("commerce_payment_gateway_form");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\commerce_payment\Element\PaymentGatewayForm uses CommerceElementTrait

Deprecated

Use the payment_gateway_form inline form instead.

Usage example:

See also

https://www.drupal.org/node/3015309

File

modules/payment/src/Element/PaymentGatewayForm.php, line 30

Namespace

Drupal\commerce_payment\Element

class PaymentGatewayForm extends RenderElement {
  use CommerceElementTrait;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#operation' => '',
      // The entity operated on. Instance of EntityWithPaymentGatewayInterface.
      '#default_value' => NULL,
      '#process' => [
        [
          $class,
          'attachElementSubmit',
        ],
        [
          $class,
          'processForm',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateElementSubmit',
        ],
      ],
      '#theme_wrappers' => [
        'container',
      ],
    ];
  }

  /**
   * Builds the payment gateway form.
   *
   * @param array $element
   *   The form element being processed.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @throws \InvalidArgumentException
   *   Thrown when the #operation or #default_value properties are empty, or
   *   when the #default_value property is not a valid entity.
   *
   * @return array
   *   The processed form element.
   */
  public static function processForm(array $element, FormStateInterface $form_state, array &$complete_form) {
    if (empty($element['#operation'])) {
      throw new \InvalidArgumentException('The commerce_payment_gateway_form element requires the #operation property.');
    }
    if (empty($element['#default_value'])) {
      throw new \InvalidArgumentException('The commerce_payment_gateway_form element requires the #default_value property.');
    }
    elseif (isset($element['#default_value']) && !$element['#default_value'] instanceof EntityWithPaymentGatewayInterface) {
      throw new \InvalidArgumentException('The commerce_payment_gateway_form #default_value property must be a payment or a payment method entity.');
    }

    /** @var \Drupal\commerce\InlineFormManager $inline_form_manager */
    $inline_form_manager = \Drupal::service('plugin.manager.commerce_inline_form');
    $inline_form = $inline_form_manager
      ->createInstance('payment_gateway_form', [
      'operation' => $element['#operation'],
    ], $element['#default_value']);
    $element['#inline_form'] = $inline_form;
    $element = $inline_form
      ->buildInlineForm($element, $form_state);

    // The updateValue() callback needs to run after the inline form ones.
    $element['#commerce_element_submit'][] = [
      get_called_class(),
      'updateValue',
    ];
    return $element;
  }

  /**
   * Updates the form state value after the inline form is submitted.
   *
   * @param array $element
   *   The form element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public static function updateValue(array &$element, FormStateInterface $form_state) {

    /** @var \Drupal\commerce\Plugin\Commerce\InlineForm\EntityInlineFormInterface $inline_form */
    $inline_form = $element['#inline_form'];
    $form_state
      ->setValueForElement($element, $inline_form
      ->getEntity());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CommerceElementTrait::attachElementSubmit	public static	function	Attaches the #commerce_element_submit functionality.
CommerceElementTrait::doExecuteSubmitHandlers	protected static	function	Calls the #commerce_element_submit callbacks recursively.
CommerceElementTrait::executeElementSubmitHandlers	public static	function	Submits elements by calling their #commerce_element_submit callbacks.
CommerceElementTrait::shouldExecuteElementSubmit	protected static	function	Checks whether #commerce_element_submit callbacks should be executed.
CommerceElementTrait::validateElementSubmit	public static	function	Confirms that #commerce_element_submit handlers can be run.
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.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PaymentGatewayForm::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
PaymentGatewayForm::processForm	public static	function	Builds the payment gateway form.
PaymentGatewayForm::updateValue	public static	function	Updates the form state value after the inline form is submitted.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.