public function CheckoutFlowBase::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 PluginFormInterface::buildConfigurationForm

1 call to CheckoutFlowBase::buildConfigurationForm()

CheckoutFlowWithPanesBase::buildConfigurationForm in modules/checkout/src/Plugin/Commerce/CheckoutFlow/CheckoutFlowWithPanesBase.php

Form constructor.

1 method overrides CheckoutFlowBase::buildConfigurationForm()

CheckoutFlowWithPanesBase::buildConfigurationForm in modules/checkout/src/Plugin/Commerce/CheckoutFlow/CheckoutFlowWithPanesBase.php

Form constructor.

File

modules/checkout/src/Plugin/Commerce/CheckoutFlow/CheckoutFlowBase.php, line 293

Class

CheckoutFlowBase

Provides the base checkout flow class.

Namespace

Drupal\commerce_checkout\Plugin\Commerce\CheckoutFlow

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['display_checkout_progress'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Display checkout progress'),
    '#description' => $this
      ->t('Used by the checkout progress block to determine visibility.'),
    '#default_value' => $this->configuration['display_checkout_progress'],
  ];
  $form['display_checkout_progress_breadcrumb_links'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Display checkout progress breadcrumb as links'),
    '#description' => $this
      ->t('Let the checkout progress block render the breadcrumb as links.'),
    '#default_value' => $this->configuration['display_checkout_progress_breadcrumb_links'],
  ];
  return $form;
}