You are here

public function PaymentProcess::buildConfigurationForm in Commerce Core 8.2

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides CheckoutPaneBase::buildConfigurationForm

File

modules/payment/src/Plugin/Commerce/CheckoutPane/PaymentProcess.php, line 113

Class

PaymentProcess
Provides the payment process pane.

Namespace

Drupal\commerce_payment\Plugin\Commerce\CheckoutPane

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);
  $form['capture'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Transaction mode'),
    '#description' => $this
      ->t('This setting is only respected if the chosen payment gateway supports authorizations.'),
    '#options' => [
      TRUE => $this
        ->t('Authorize and capture'),
      FALSE => $this
        ->t('Authorize only (requires manual capture after checkout)'),
    ],
    '#default_value' => (int) $this->configuration['capture'],
  ];
  return $form;
}