public function FindReplace::buildConfigurationForm in Tamper 8

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

File

src/Plugin/Tamper/FindReplace.php, line 44

Class

FindReplace

Plugin implementation of the find_replace plugin.

Namespace

Drupal\tamper\Plugin\Tamper

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form[self::SETTING_FIND] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Text to find'),
    '#default_value' => $this
      ->getSetting(self::SETTING_FIND),
  ];
  $form[self::SETTING_REPLACE] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Text to replace'),
    '#default_value' => $this
      ->getSetting(self::SETTING_REPLACE),
  ];
  $form[self::SETTING_CASE_SENSITIVE] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Case sensitive'),
    '#default_value' => $this
      ->getSetting(self::SETTING_CASE_SENSITIVE),
    '#description' => $this
      ->t('If checked, "book" will match "book" but not "Book" or "BOOK".'),
  ];
  $form[self::SETTING_WORD_BOUNDARIES] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Respect word boundaries'),
    '#default_value' => $this
      ->getSetting(self::SETTING_WORD_BOUNDARIES),
    '#description' => $this
      ->t('If checked, "book" will match "book" but not "bookcase".'),
  ];
  $form[self::SETTING_WHOLE] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Match whole word/phrase'),
    '#default_value' => $this
      ->getSetting(self::SETTING_WHOLE),
    '#description' => $this
      ->t('If checked, then the whole word or phrase will be matched, e.g. "book" will match "book" but not "the book". If this option is selected then "Respect word boundaries" above will be ignored.'),
  ];
  return $form;
}