public function CheckboxWithExclude::buildConfigurationForm in Block Style Plugins 8

Same name and namespace in other branches

1. 8.2 tests/modules/block_style_plugins_test/src/Plugin/BlockStyle/CheckboxWithExclude.php \Drupal\block_style_plugins_test\Plugin\BlockStyle\CheckboxWithExclude::buildConfigurationForm()

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 BlockStyleBase::buildConfigurationForm

File

tests/modules/block_style_plugins_test/src/Plugin/BlockStyle/CheckboxWithExclude.php, line 29

Class

CheckboxWithExclude

Class to demonstrate excluding a block.

Namespace

Drupal\block_style_plugins_test\Plugin\BlockStyle

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {

  // Checkboxes are do not apply a class automatically like other form
  // elements. Instead, they simply pass a boolean value that can be accessed
  // inside a Twig template like:
  // {% set checkbox_class = (block_styles.checkbox_with_exclude.checkbox_class == '1') ? TRUE : FALSE %}.
  $elements['checkbox_class'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Check this box to pass a boolean to the theme'),
    '#default_value' => $this->configuration['checkbox_class'],
  ];
  return $elements;
}