8.5.x ConditionPluginBase.php ConditionPluginBase::buildConfigurationForm(array $form, FormStateInterface $form_state)
8.0.x ConditionPluginBase.php ConditionPluginBase::buildConfigurationForm(array $form, FormStateInterface $form_state)
8.1.x ConditionPluginBase.php ConditionPluginBase::buildConfigurationForm(array $form, FormStateInterface $form_state)
8.2.x ConditionPluginBase.php ConditionPluginBase::buildConfigurationForm(array $form, FormStateInterface $form_state)
8.3.x ConditionPluginBase.php ConditionPluginBase::buildConfigurationForm(array $form, FormStateInterface $form_state)
8.4.x ConditionPluginBase.php ConditionPluginBase::buildConfigurationForm(array $form, FormStateInterface $form_state)
8.6.x ConditionPluginBase.php ConditionPluginBase::buildConfigurationForm(array $form, FormStateInterface $form_state)

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

5 methods override ConditionPluginBase::buildConfigurationForm()
CurrentThemeCondition::buildConfigurationForm in core/modules/system/src/Plugin/Condition/CurrentThemeCondition.php
Form constructor.
Language::buildConfigurationForm in core/modules/language/src/Plugin/Condition/Language.php
Form constructor.
NodeType::buildConfigurationForm in core/modules/node/src/Plugin/Condition/NodeType.php
Form constructor.
RequestPath::buildConfigurationForm in core/modules/system/src/Plugin/Condition/RequestPath.php
Form constructor.
UserRole::buildConfigurationForm in core/modules/user/src/Plugin/Condition/UserRole.php
Form constructor.

File

core/lib/Drupal/Core/Condition/ConditionPluginBase.php, line 50

Class

ConditionPluginBase
Provides a basis for fulfilling contexts for condition plugins.

Namespace

Drupal\Core\Condition

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  if ($form_state instanceof SubformStateInterface) {
    $form_state = $form_state
      ->getCompleteFormState();
  }
  $contexts = $form_state
    ->getTemporaryValue('gathered_contexts') ?: [];
  $form['context_mapping'] = $this
    ->addContextAssignmentElement($this, $contexts);
  $form['negate'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Negate the condition'),
    '#default_value' => $this->configuration['negate'],
  ];
  return $form;
}