public function HtmlFilter::buildConfigurationForm in Search API 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 FieldsProcessorPluginBase::buildConfigurationForm

File

src/Plugin/search_api/processor/HtmlFilter.php, line 90

Class

HtmlFilter

Strips HTML tags from fulltext fields and decodes HTML entities.

Namespace

Drupal\search_api\Plugin\search_api\processor

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);
  $form['title'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Index title attribute'),
    '#description' => $this
      ->t('If set, the contents of title attributes will be indexed.'),
    '#default_value' => $this->configuration['title'],
  ];
  $form['alt'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Index alt attribute'),
    '#description' => $this
      ->t('If set, the alternative text of images will be indexed.'),
    '#default_value' => $this->configuration['alt'],
  ];
  $dumper = new Dumper();
  $tags = $dumper
    ->dump($this->configuration['tags'], 2);
  $tags = str_replace('\\r\\n', "\n", $tags);
  $tags = str_replace('"', '', $tags);
  $t_args[':url'] = Url::fromUri('https://en.wikipedia.org/wiki/YAML')
    ->toString();
  $form['tags'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Tag boosts'),
    '#description' => $this
      ->t('Specify special boost values for certain HTML elements, in <a href=":url">YAML file format</a>. The boost values of nested elements are multiplied, elements not mentioned will have the default boost value of 1. Assign a boost of 0 to ignore the text content of that HTML element.', $t_args),
    '#default_value' => $tags,
  ];
  return $form;
}