View source
<?php
namespace Drupal\search_api_autocomplete\Form;
use Drupal\Component\Plugin\PluginManagerInterface;
use Drupal\Component\Serialization\Json;
use Drupal\Component\Utility\SortArray;
use Drupal\Core\Entity\EntityForm;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Form\SubformState;
use Drupal\Core\Plugin\PluginFormInterface;
use Drupal\search_api_autocomplete\Suggester\SuggesterInterface;
use Drupal\search_api_autocomplete\Search\SearchPluginManager;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Messenger\MessengerInterface;
class SearchEditForm extends EntityForm {
protected $entity;
protected $suggesterManager;
protected $searchPluginManager;
protected $logger;
protected $messenger;
public function __construct(PluginManagerInterface $suggester_manager, SearchPluginManager $search_plugin_manager, LoggerInterface $logger, MessengerInterface $messenger) {
$this->suggesterManager = $suggester_manager;
$this->searchPluginManager = $search_plugin_manager;
$this->logger = $logger;
$this->messenger = $messenger;
}
public static function create(ContainerInterface $container) {
$logger = $container
->get('logger.channel.search_api_autocomplete');
return new static($container
->get('plugin.manager.search_api_autocomplete.suggester'), $container
->get('plugin.manager.search_api_autocomplete.search'), $logger, $container
->get('messenger'));
}
public function buildForm(array $form, FormStateInterface $form_state) {
$form = parent::buildForm($form, $form_state);
$search = $this->entity;
$form['#title'] = $this
->t('Configure autocompletion for %search', [
'%search' => $search
->label(),
]);
$form['#tree'] = TRUE;
$form['status'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enabled'),
'#default_value' => $search
->status(),
];
$form['suggesters'] = $this
->buildSuggestersForm($form_state);
if (!$search
->hasValidSearchPlugin()) {
$this->messenger
->addError($this
->t('No information about this search could be found. Unless this is a temporary problem for some reason, you are advised to delete this search configuration.'));
}
else {
$search_plugin = $search
->getSearchPlugin();
if ($search_plugin instanceof PluginFormInterface) {
$form['search_settings'] = [];
$plugin_form_state = SubFormState::createForSubform($form['search_settings'], $form, $form_state);
$form['search_settings'] = $search_plugin
->buildConfigurationForm($form['search_settings'], $plugin_form_state);
}
}
$form['options']['limit'] = [
'#type' => 'number',
'#title' => $this
->t('Maximum number of suggestions'),
'#description' => $this
->t('The maximum number of autocomplete suggestions to display in total.'),
'#required' => TRUE,
'#min' => 1,
'#step' => 1,
'#default_value' => $search
->getOption('limit'),
];
$form['options']['min_length'] = [
'#type' => 'number',
'#title' => $this
->t('Minimum length of keywords for autocompletion'),
'#description' => $this
->t('If the entered keywords are shorter than this, no autocomplete suggestions will be displayed.'),
'#min' => 1,
'#step' => 1,
'#default_value' => $search
->getOption('min_length'),
];
$form['options']['show_count'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Display result count estimates'),
'#description' => $this
->t('Display the estimated number of result for each suggestion. This option might not have an effect for some servers or types of suggestion.'),
'#default_value' => (bool) $search
->getOption('show_count'),
];
$form['advanced'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Advanced settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
];
$form['advanced']['autosubmit'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable auto-submit'),
'#description' => $this
->t('When enabled, the search form will automatically be submitted when a selection is made by pressing "Enter".'),
'#default_value' => $search
->getOption('autosubmit'),
'#parents' => [
'options',
'autosubmit',
],
];
$form['advanced']['submit_button_selector'] = [
'#type' => 'textfield',
'#title' => $this
->t('Search button selector'),
'#description' => $this
->t('<a href="@jquery_url">jQuery selector</a> identifying the button to use for submitting the search form. Use the ID attribute of the "Search" submit button to prevent issues when another button is present (e.g., "Reset"). The selector is evaluated relative to the form. The default value is "@default".', [
'@jquery_url' => 'https://api.jquery.com/category/selectors/',
'@default' => ':submit',
]),
'#default_value' => $search
->getOption('submit_button_selector'),
'#required' => TRUE,
'#parents' => [
'options',
'submit_button_selector',
],
'#states' => [
'visible' => [
':input[name="options[autosubmit]"]' => [
'checked' => TRUE,
],
],
],
];
$form['advanced']['delay'] = [
'#type' => 'number',
'#title' => $this
->t('Delay (in ms)'),
'#description' => $this
->t('The delay in milliseconds between when a keystroke occurs and when a search is performed. Low values will result in a more responsive experience for users, but can also cause a higher load on the server. Defaults to 300 ms.'),
'#min' => 0,
'#step' => 1,
'#default_value' => $search
->getOption('delay'),
'#parents' => [
'options',
'delay',
],
];
return $form;
}
protected function buildSuggestersForm(FormStateInterface $form_state) {
$search = $this->entity;
$available_suggesters = $this
->getAvailableSuggesters();
$suggester_ids = array_keys($available_suggesters);
$suggester_weights = $search
->getSuggesterWeights();
$suggester_weights += array_fill_keys($suggester_ids, 0);
$suggester_limits = $search
->getSuggesterLimits();
$suggester_limits += array_fill_keys($suggester_ids, NULL);
$form = [
'#type' => 'fieldset',
'#title' => $this
->t('Suggester plugins'),
'#description' => $this
->t('Suggester plugins represent methods for creating autocomplete suggestions from user input.'),
];
$form['enabled'] = [
'#type' => 'checkboxes',
'#title' => $this
->t('Enabled suggesters'),
'#description' => $this
->t('Choose the suggester plugins to use for creating autocomplete suggestions.'),
'#options' => [],
'#required' => TRUE,
'#default_value' => $search
->getSuggesterIds(),
];
$form['weights'] = [
'#type' => 'table',
];
$form['weights']['#tabledrag'][] = [
'action' => 'order',
'relationship' => 'sibling',
'group' => 'search-api-autocomplete-suggester-weight',
];
$sentence = (string) $this
->t('At most @num results');
list($prefix, $suffix) = explode('@num', $sentence);
$prefix = '<div class="container-inline">' . $prefix;
$suffix .= '</div>';
foreach ($available_suggesters as $suggester_id => $suggester) {
$label = $suggester
->label();
$form['enabled']['#options'][$suggester_id] = $label;
$form['enabled'][$suggester_id] = [
'#description' => $suggester
->getDescription(),
];
$states = [
'visible' => [
":input[name=\"suggesters[enabled][{$suggester_id}]\"]" => [
'checked' => TRUE,
],
],
];
$form['weights'][$suggester_id] = [
'#weight' => $suggester_weights[$suggester_id],
'label' => [
'#plain_text' => $label,
],
'limit' => [
'#type' => 'number',
'#prefix' => $prefix,
'#suffix' => $suffix,
'#min' => 1,
'#step' => 1,
'#size' => 2,
'#default_value' => $suggester_limits[$suggester_id],
],
'weight' => [
'#type' => 'weight',
'#title' => $this
->t('Weight for suggester %label', [
'%label' => $label,
]),
'#title_display' => 'invisible',
'#delta' => 50,
'#default_value' => $suggester_weights[$suggester_id],
'#attributes' => [
'class' => [
'search-api-autocomplete-suggester-weight',
],
],
],
'#attributes' => [
'class' => [
'draggable',
'js-form-wrapper',
],
'data-drupal-states' => Json::encode($states),
],
];
if ($suggester instanceof PluginFormInterface) {
$args = [
'%label' => $suggester
->label(),
];
$form['settings'][$suggester_id] = [
'#type' => 'details',
'#title' => $this
->t('Configure suggester %label', $args),
'#states' => $states,
];
$suggester_form_state = SubformState::createForSubform($form['settings'][$suggester_id], $form, $form_state);
$form['settings'][$suggester_id] += $suggester
->buildConfigurationForm($form['settings'][$suggester_id], $suggester_form_state);
}
}
if (!empty($form['weights'])) {
uasort($form['weights'], [
SortArray::class,
'sortByWeightProperty',
]);
}
return $form;
}
public function validateForm(array &$form, FormStateInterface $form_state) {
$values =& $form_state
->getValues();
$available_suggesters = $this
->getAvailableSuggesters();
$enabled_suggesters = array_keys(array_filter($values['suggesters']['enabled']));
foreach ($enabled_suggesters as $suggester_id) {
$suggester = $available_suggesters[$suggester_id];
if ($suggester instanceof PluginFormInterface) {
$suggester_form_state = SubformState::createForSubform($form['suggesters']['settings'][$suggester_id], $form, $form_state);
$suggester
->validateConfigurationForm($form['suggesters']['settings'][$suggester_id], $suggester_form_state);
}
}
$search_plugin = $this->entity
->getSearchPlugin();
if ($search_plugin instanceof PluginFormInterface) {
$plugin_form_state = SubFormState::createForSubform($form['search_settings'], $form, $form_state);
$search_plugin
->validateConfigurationForm($form['search_settings'], $plugin_form_state);
}
}
public function submitForm(array &$form, FormStateInterface $form_state) {
$form_state
->cleanValues();
$this->entity = $this
->buildEntity($form, $form_state);
$search = $this->entity;
$values = $form_state
->getValues();
$available_suggesters = $this
->getAvailableSuggesters();
$enabled_suggesters = array_intersect_key($available_suggesters, array_filter($values['suggesters']['enabled']));
$suggester_weights = [];
$suggester_limits = [];
foreach ($enabled_suggesters as $suggester_id => $suggester) {
if ($suggester instanceof PluginFormInterface) {
$suggester_form_state = SubformState::createForSubform($form['suggesters']['settings'][$suggester_id], $form, $form_state);
$suggester
->submitConfigurationForm($form['suggesters']['settings'][$suggester_id], $suggester_form_state);
}
$suggester_weights[$suggester_id] = (int) $values['suggesters']['weights'][$suggester_id]['weight'];
if (is_numeric($values['suggesters']['weights'][$suggester_id]['limit'])) {
$suggester_limits[$suggester_id] = (int) $values['suggesters']['weights'][$suggester_id]['limit'];
}
}
$search
->setSuggesters($enabled_suggesters);
$search
->set('suggester_weights', $suggester_weights);
$search
->set('suggester_limits', $suggester_limits);
$search_plugin = $this->entity
->getSearchPlugin();
if ($search_plugin instanceof PluginFormInterface) {
$plugin_form = empty($form['search_settings']) ? [] : $form['search_settings'];
$plugin_form_state = SubFormState::createForSubform($form['search_settings'], $form, $form_state);
$search_plugin
->submitConfigurationForm($plugin_form, $plugin_form_state);
$search
->set('search_settings', $search_plugin
->getConfiguration());
}
$form_state
->setRedirect('search_api_autocomplete.admin_overview', [
'search_api_index' => $search
->getIndexId(),
]);
$this->messenger
->addStatus($this
->t('The autocompletion settings for the search have been saved.'));
}
protected function getAvailableSuggesters() {
$suggesters = $this->entity
->getSuggesters();
$settings['#search'] = $this->entity;
$definitions = $this->suggesterManager
->getDefinitions();
foreach ($definitions as $plugin_id => $definition) {
if (isset($suggesters[$plugin_id])) {
continue;
}
if (class_exists($definition['class'])) {
$method = [
$definition['class'],
'supportsSearch',
];
if (call_user_func($method, $this->entity)) {
$suggester = $this->suggesterManager
->createInstance($plugin_id, $settings);
$suggesters[$plugin_id] = $suggester;
}
}
else {
$this->logger
->warning('Suggester %id specifies a non-existing class %class.', [
'%id' => $plugin_id,
'%class' => $definition['class'],
]);
}
}
$compare = function (SuggesterInterface $a, SuggesterInterface $b) {
return strnatcasecmp($a
->label(), $b
->label());
};
uasort($suggesters, $compare);
return $suggesters;
}
}
