public function USPSRateBase::buildConfigurationForm in Ubercart 8.4

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

2 methods override USPSRateBase::buildConfigurationForm()

USPSDomesticRate::buildConfigurationForm in shipping/uc_usps/src/Plugin/Ubercart/ShippingQuote/USPSDomesticRate.php

Form constructor.

USPSInternationalRate::buildConfigurationForm in shipping/uc_usps/src/Plugin/Ubercart/ShippingQuote/USPSInternationalRate.php

Form constructor.

File

shipping/uc_usps/src/Plugin/Ubercart/ShippingQuote/USPSRateBase.php, line 30

Class

USPSRateBase

Common functionality for USPS shipping quotes plugins.

Namespace

Drupal\uc_usps\Plugin\Ubercart\ShippingQuote

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $fields = [
    '' => $this
      ->t('- None -'),
  ];
  $result = \Drupal::entityQuery('field_config')
    ->condition('field_type', 'number')
    ->execute();
  foreach (FieldConfig::loadMultiple($result) as $field) {
    $fields[$field
      ->getName()] = $field
      ->label();
  }
  $form['base_rate'] = [
    '#type' => 'uc_price',
    '#title' => $this
      ->t('Base price'),
    '#description' => $this
      ->t('The starting price for shipping costs.'),
    '#default_value' => $this->configuration['base_rate'],
    '#required' => TRUE,
  ];
  $form['product_rate'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Default product shipping rate'),
    '#min' => 0,
    '#step' => 'any',
    '#description' => $this
      ->t('The percentage of the item price to add to the shipping cost for an item.'),
    '#default_value' => $this->configuration['product_rate'],
    '#field_suffix' => $this
      ->t('% (percent)'),
    '#required' => TRUE,
  ];
  $form['field'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Product shipping rate override field'),
    '#description' => $this
      ->t('Overrides the default shipping rate per product for this percentage rate shipping method, when the field is attached to a product content type and has a value.'),
    '#options' => $fields,
    '#default_value' => $this->configuration['field'],
  ];
  return $form;
}