class Suggester in Search API Solr 8.2
Same name and namespace in other branches
- 8.3 src/Plugin/search_api_autocomplete/suggester/Suggester.php \Drupal\search_api_solr\Plugin\search_api_autocomplete\suggester\Suggester
- 4.x src/Plugin/search_api_autocomplete/suggester/Suggester.php \Drupal\search_api_solr\Plugin\search_api_autocomplete\suggester\Suggester
Provides a suggester plugin that retrieves suggestions from the server.
The server needs to support the "search_api_autocomplete" feature for this to work.
Plugin annotation
@SearchApiAutocompleteSuggester(
id = "search_api_solr_suggester",
label = @Translation("Solr Suggester"),
description = @Translation("Suggest complete phrases for the entered string based on Solr's suggest component."),
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
- class \Drupal\search_api\Plugin\ConfigurablePluginBase implements ConfigurablePluginInterface uses PluginDependencyTrait
- class \Drupal\search_api_autocomplete\Plugin\PluginBase implements PluginInterface
- class \Drupal\search_api_autocomplete\Suggester\SuggesterPluginBase implements SuggesterInterface
- class \Drupal\search_api_solr\Plugin\search_api_autocomplete\suggester\Suggester implements PluginFormInterface uses PluginFormTrait
- class \Drupal\search_api_autocomplete\Suggester\SuggesterPluginBase implements SuggesterInterface
- class \Drupal\search_api_autocomplete\Plugin\PluginBase implements PluginInterface
- class \Drupal\search_api\Plugin\ConfigurablePluginBase implements ConfigurablePluginInterface uses PluginDependencyTrait
- class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Suggester
File
- src/
Plugin/ search_api_autocomplete/ suggester/ Suggester.php, line 29
Namespace
Drupal\search_api_solr\Plugin\search_api_autocomplete\suggesterView source
class Suggester extends SuggesterPluginBase implements PluginFormInterface {
use PluginFormTrait;
/**
* {@inheritdoc}
*/
public static function supportsSearch(SearchInterface $search) {
return (bool) static::getBackend($search
->getIndex());
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
'search_api_solr/site_hash' => TRUE,
'search_api/index' => '',
'drupal/langcode' => 'any',
];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$search = $this
->getSearch();
$server = $search
->getIndex()
->getServerInstance();
$form['search_api_solr/site_hash'] = [
'#type' => 'checkbox',
'#title' => $this
->t('From this site only'),
'#description' => $this
->t('Limit the suggestion dictionary to entries created by this site in case of a multisite setup.'),
'#default_value' => $this
->getConfiguration()['search_api_solr/site_hash'],
];
$index_options['any'] = $this
->t('Any index');
foreach ($server
->getIndexes() as $index) {
$index_options[$index
->id()] = $this
->t('Index @index', [
'@index' => $index
->label(),
]);
}
$form['search_api/index'] = [
'#type' => 'radios',
'#title' => $this
->t('Index'),
'#description' => $this
->t('Limit the suggestion dictionary to entries to those created by a specific index.'),
'#options' => $index_options,
'#default_value' => $this
->getConfiguration()['search_api/index'] ?: $search
->getIndex()
->id(),
];
$langcode_options['any'] = $this
->t('Any language');
if ($server
->getBackend() instanceof SolrMultilingualBackendInterface) {
$langcode_options['multilingual'] = $this
->t('Let the multilingual Solr server handle it dynamically.');
}
foreach (\Drupal::languageManager()
->getLanguages() as $language) {
$langcode_options[$language
->getId()] = $language
->getName();
}
$langcode_options['und'] = $this
->t('Undefined');
$form['drupal/langcode'] = [
'#type' => 'radios',
'#title' => $this
->t('Language'),
'#description' => $this
->t('Limit the suggestion dictionary to entries that belong to a specific language.'),
'#options' => $langcode_options,
'#default_value' => $this
->getConfiguration()['drupal/langcode'],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
$values = $form_state
->getValues();
$this
->setConfiguration($values);
}
/**
* {@inheritdoc}
*/
public function getAutocompleteSuggestions(QueryInterface $query, $incomplete_key, $user_input) {
if (!($backend = static::getBackend($this
->getSearch()
->getIndex()))) {
return [];
}
$config = $this
->getConfiguration();
$options['context_filter_tags'] = [];
if ($config['search_api_solr/site_hash']) {
$options['context_filter_tags'][] = 'search_api_solr/site_hash:' . Utility::getSiteHash();
}
if (!empty($config['search_api/index']) && 'any' != $config['search_api/index']) {
$options['context_filter_tags'][] = 'search_api/index:' . $config['search_api/index'];
}
if ('any' != $config['drupal/langcode']) {
$options['context_filter_tags'][] = 'drupal/langcode:' . $config['drupal/langcode'];
}
return $backend
->getSuggesterSuggestions($query, $this
->getSearch(), $incomplete_key, $user_input, $options);
}
/**
* Retrieves the backend for the given index, if it supports autocomplete.
*
* @param \Drupal\search_api\IndexInterface $index
* The search index.
*
* @return SolrAutocompleteInterface|null
* The backend plugin of the index's server, if it exists and supports
* autocomplete; NULL otherwise.
*
* @throws \Drupal\search_api\SearchApiException
*/
protected static function getBackend(IndexInterface $index) {
if (!$index
->hasValidServer()) {
return NULL;
}
$server = $index
->getServerInstance();
$backend = $server
->getBackend();
if ($server
->supportsFeature('search_api_autocomplete') && $backend instanceof SolrAutocompleteInterface) {
return $backend;
}
return NULL;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigurablePluginBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
ConfigurablePluginBase:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | |
ConfigurablePluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
4 |
ConfigurablePluginBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
ConfigurablePluginBase:: |
public | function |
Returns the plugin's description. Overrides ConfigurablePluginInterface:: |
|
ConfigurablePluginBase:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
ConfigurablePluginBase:: |
public | function |
Returns the label for use on the administration pages. Overrides ConfigurablePluginInterface:: |
|
ConfigurablePluginBase:: |
protected | function | Wraps the module handler. | |
ConfigurablePluginBase:: |
public | function |
Informs the plugin that some of its dependencies are being removed. Overrides ConfigurablePluginInterface:: |
5 |
ConfigurablePluginBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
3 |
ConfigurablePluginBase:: |
protected | function | Wraps the theme handler. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. | |
HideablePluginBase:: |
public | function |
Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface:: |
1 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | The search this suggester is attached to. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Retrieves the search this plugin is configured for. Overrides PluginInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function |
Sets the search this plugin is configured for. Overrides PluginInterface:: |
|
PluginBase:: |
public | function |
Constructs a SearchPluginBase object. Overrides ConfigurablePluginBase:: |
1 |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. Aliased as: traitCalculatePluginDependencies | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. Aliased as: traitGetPluginDependencies | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. Aliased as: traitModuleHandler | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. Aliased as: traitThemeHandler | 1 |
PluginFormTrait:: |
public | function | Form validation handler. | 2 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
Suggester:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
|
Suggester:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurablePluginBase:: |
|
Suggester:: |
public | function |
Retrieves autocompletion suggestions for some user input. Overrides SuggesterInterface:: |
|
Suggester:: |
protected static | function | Retrieves the backend for the given index, if it supports autocomplete. | |
Suggester:: |
public | function |
Form submission handler. Overrides PluginFormTrait:: |
|
Suggester:: |
public static | function |
Determines whether this plugin supports the given search. Overrides SuggesterPluginBase:: |
|
SuggesterPluginBase:: |
public | function |
Alters an autocomplete element that should use this suggester. Overrides SuggesterInterface:: |
1 |