public function LiveResults::buildConfigurationForm in Search API Autocomplete 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 PluginFormInterface::buildConfigurationForm

File

src/Plugin/search_api_autocomplete/suggester/LiveResults.php, line 136

Class

LiveResults

Provides a suggester plugin that displays live results.

Namespace

Drupal\search_api_autocomplete\Plugin\search_api_autocomplete\suggester

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['#attached']['library'][] = 'search_api/drupal.search_api.admin_css';

  // Let the user select the fulltext fields to use for the searches.
  $search = $this
    ->getSearch();
  $fields = $search
    ->getIndex()
    ->getFields();
  $fulltext_fields = $search
    ->getIndex()
    ->getFulltextFields();
  $options = [];
  foreach ($fulltext_fields as $field) {
    $options[$field] = $fields[$field]
      ->getFieldIdentifier();
  }
  $form['fields'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('Override used fields'),
    '#description' => $this
      ->t('Select the fields which should be searched for matches when looking for autocompletion suggestions. Leave blank to use the same fields as the underlying search.'),
    '#options' => $options,
    '#default_value' => array_combine($this->configuration['fields'], $this->configuration['fields']),
    '#attributes' => [
      'class' => [
        'search-api-checkboxes-list',
      ],
    ],
  ];
  $form['view_modes'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('View modes'),
    '#description' => $this
      ->t('Please select the view modes to use for live results.'),
  ];

  // Let the user select the view mode to use for live results.
  $selected_view_modes = $this->configuration['view_modes'];
  foreach ($search
    ->getIndex()
    ->getDatasources() as $datasource_id => $datasource) {
    foreach ($datasource
      ->getBundles() as $bundle => $name) {
      $view_modes = $datasource
        ->getViewModes($bundle);

      // If there are no view modes available, there's no need to display a
      // select box. Just default to "Use only label".
      if (!$view_modes) {
        $form['view_modes'][$datasource_id][$bundle] = [
          '#type' => 'value',
          '#value' => '',
        ];
        continue;
      }
      $default_value = '';
      if (isset($selected_view_modes[$datasource_id][$bundle])) {
        $default_value = $selected_view_modes[$datasource_id][$bundle];
      }
      $form['view_modes'][$datasource_id][$bundle] = [
        '#type' => 'select',
        '#title' => $name,
        '#options' => [
          '' => $this
            ->t('Use only label'),
        ] + $view_modes,
        '#default_value' => $default_value,
      ];
    }
  }
  $args = [
    '%highlight' => $this
      ->t('Highlight'),
  ];
  try {
    $args['%highlight'] = $this
      ->getProcessorPluginManager()
      ->createInstance('highlight')
      ->label();
  } catch (PluginException $e) {

    // Ignore – really not that important.
  }
  $form['highlight'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Highlight live results'),
    '#description' => $this
      ->t('Replace the live result with the output of a highlighted field, if available. Requires the %highlight processor to be enabled.', $args),
    '#description_display' => 'before',
    '#disabled' => !$this
      ->isHighlightingAvailable(),
    '#tree' => TRUE,
  ];
  $form['highlight']['enabled'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable highlighting of live results'),
    '#default_value' => $this->configuration['highlight']['enabled'],
  ];
  $form['highlight']['field'] = [
    '#type' => 'select',
    '#empty_value' => '',
    '#title' => $this
      ->t('Select the field to replace live result'),
    '#options' => $options,
    '#default_value' => $this->configuration['highlight']['field'],
    '#states' => [
      'visible' => [
        ':input[name="suggesters[settings][live_results][highlight][enabled]"]' => [
          'checked' => TRUE,
        ],
      ],
      'required' => [
        ':input[name="suggesters[settings][live_results][highlight][enabled]"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  return $form;
}