You are here

public function TaxTypeBase::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

6 calls to TaxTypeBase::buildConfigurationForm()
CanadianSalesTax::buildConfigurationForm in modules/tax/src/Plugin/Commerce/TaxType/CanadianSalesTax.php
Form constructor.
Custom::buildConfigurationForm in modules/tax/src/Plugin/Commerce/TaxType/Custom.php
Form constructor.
EuropeanUnionVat::buildConfigurationForm in modules/tax/src/Plugin/Commerce/TaxType/EuropeanUnionVat.php
Form constructor.
NorwegianVat::buildConfigurationForm in modules/tax/src/Plugin/Commerce/TaxType/NorwegianVat.php
Form constructor.
SwissVat::buildConfigurationForm in modules/tax/src/Plugin/Commerce/TaxType/SwissVat.php
Form constructor.

... See full list

6 methods override TaxTypeBase::buildConfigurationForm()
CanadianSalesTax::buildConfigurationForm in modules/tax/src/Plugin/Commerce/TaxType/CanadianSalesTax.php
Form constructor.
Custom::buildConfigurationForm in modules/tax/src/Plugin/Commerce/TaxType/Custom.php
Form constructor.
EuropeanUnionVat::buildConfigurationForm in modules/tax/src/Plugin/Commerce/TaxType/EuropeanUnionVat.php
Form constructor.
NorwegianVat::buildConfigurationForm in modules/tax/src/Plugin/Commerce/TaxType/NorwegianVat.php
Form constructor.
SwissVat::buildConfigurationForm in modules/tax/src/Plugin/Commerce/TaxType/SwissVat.php
Form constructor.

... See full list

File

modules/tax/src/Plugin/Commerce/TaxType/TaxTypeBase.php, line 162

Class

TaxTypeBase
Provides the base class for tax types.

Namespace

Drupal\commerce_tax\Plugin\Commerce\TaxType

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['display_inclusive'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Display taxes of this type inclusive in product prices.'),
    '#default_value' => $this->configuration['display_inclusive'],
  ];
  return $form;
}