class SuggestionsSpellCheck in Search API Spellcheck 8.3
Provides an area for messages.
Plugin annotation
@ViewsArea("search_api_spellcheck_suggestions");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\HandlerBase implements ViewsHandlerInterface
- class \Drupal\views\Plugin\views\area\AreaPluginBase
- class \Drupal\search_api_spellcheck\Plugin\views\area\DidYouMeanSpellCheck
- class \Drupal\search_api_spellcheck\Plugin\views\area\SuggestionsSpellCheck
- class \Drupal\search_api_spellcheck\Plugin\views\area\DidYouMeanSpellCheck
- class \Drupal\views\Plugin\views\area\AreaPluginBase
- class \Drupal\views\Plugin\views\HandlerBase implements ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of SuggestionsSpellCheck
File
- src/
Plugin/ views/ area/ SuggestionsSpellCheck.php, line 15
Namespace
Drupal\search_api_spellcheck\Plugin\views\areaView source
class SuggestionsSpellCheck extends DidYouMeanSpellCheck {
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['search_api_spellcheck_collate']['default'] = FALSE;
return $options;
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$form['search_api_spellcheck_count'] = [
'#default_value' => $this->options['search_api_spellcheck_count'] ?? TRUE,
'#title' => $this
->t('The amount of results to show.'),
'#type' => 'number',
];
}
/**
* Render the area.
*
* @param bool $empty
* (optional) Indicator if view result is empty or not. Defaults to FALSE.
*
* @return array
* In any case we need a valid Drupal render array to return.
*/
public function render($empty = FALSE) {
if (!$this->options['search_api_spellcheck_hide_on_result'] || $empty) {
/** @var ResultSetInterface $result */
$result = $this->query
->getSearchApiResults();
if ($spellcheck = $result
->getExtraData('search_api_spellcheck')) {
$filter_field_key = $this
->getFilterFieldKey();
$exposed_input = $this->view
->getExposedInput();
$keys = $exposed_input[$filter_field_key] ?? '';
$new_keys = $spellcheck['collation'] ?? $keys;
$key_suggestions = [];
if (empty($spellcheck['collation']) && !empty($spellcheck['suggestions'])) {
$combined_suggestions[$new_keys] = $this
->combineArrays(array_values($spellcheck['suggestions']));
// Loop over the combined suggestions and replace the keys.
foreach ($combined_suggestions as $key => $values) {
foreach ($values as $value) {
if (!empty($key)) {
$key_suggestions[] = str_ireplace($key, $value, $new_keys);
}
}
}
}
else {
return [];
}
if (empty($key_suggestions)) {
return [];
}
$suggestions = [];
foreach ($key_suggestions as $suggestion) {
$suggestions[] = $this
->getSuggestionLink($suggestion, $filter_field_key);
}
return [
'#theme' => 'search_api_spellcheck_suggestions',
'#label' => $this
->getSuggestionLabel(),
'#suggestions' => $suggestions,
];
}
}
return [];
}
/**
* Gets the suggestion label.
*
* @return \Drupal\Core\StringTranslation\TranslatableMarkup
* The suggestion label translated.
*/
protected function getSuggestionLabel() {
return $this
->t('Spellcheck keyword variations:');
}
/**
* Combine multiple arrays to one array with all possible suggestions.
*/
protected function combineArrays(array $suggestions) {
$odometer = array_fill(0, count($suggestions), 0);
$combined_suggestions[] = $this
->formCombination($odometer, $suggestions);
while ($this
->odometerIncrement($odometer, $suggestions)) {
$combined_suggestions[] = $this
->formCombination($odometer, $suggestions);
}
return $combined_suggestions;
}
/**
* Combine a suggestion based on the odometer.
*/
protected function formCombination(array $odometer, array $suggestions) {
$output = '';
$count = count($odometer);
for ($i = 0; $i < $count; $i++) {
if ($i === 0) {
$output .= $suggestions[$i][$odometer[$i]];
}
else {
$output .= ' ' . $suggestions[$i][$odometer[$i]];
}
}
return $output;
}
/**
* Increment the odometer.
*/
protected function odometerIncrement(array &$odometer, array $suggestions) {
// Basically, work your way from the rightmost digit of the "odometer"...
// if you're able to increment without cycling that digit back to zero,
// you're all done, otherwise, cycle that digit to zero and go one digit to
// the left, and begin again until you're able to increment a digit without
// cycling it.
$count = count($odometer);
for ($i = $count - 1; $i >= 0; $i--) {
$max = count($suggestions[$i]) - 1;
if ($odometer[$i] + 1 <= $max) {
// Increment and done.
$odometer[$i]++;
return TRUE;
}
if ($i - 1 < 0) {
// No more digits left to increment, end of the line.
break;
}
// Can't increment this digit, cycle it to zero and continue the loop
// to go over to the next digit.
$odometer[$i] = 0;
}
return FALSE;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AreaPluginBase:: |
public | property | The type of this area handler, i.e. 'header', 'footer', or 'empty'. | |
AreaPluginBase:: |
public | function |
Provide text for the administrative summary. Overrides HandlerBase:: |
|
AreaPluginBase:: |
public | function |
Overrides Drupal\views\Plugin\views\HandlerBase::init(). Overrides HandlerBase:: |
1 |
AreaPluginBase:: |
public | function | Does that area have nothing to show. | 1 |
AreaPluginBase:: |
public | function | Performs any operations needed before full rendering. | 1 |
AreaPluginBase:: |
public | function |
Provides the handler some groupby. Overrides HandlerBase:: |
|
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 | |
DidYouMeanSpellCheck:: |
protected | property | The current query parameters. | |
DidYouMeanSpellCheck:: |
protected | function | Gets the current query parameters. | |
DidYouMeanSpellCheck:: |
protected | function | Gets the filter field key for the current view. Having multiple full text search filters are currently not supported. | |
DidYouMeanSpellCheck:: |
protected | function | Gets the suggestion link. | |
DidYouMeanSpellCheck:: |
public | function |
Overrides HandlerBase:: |
|
HandlerBase:: |
public | property | With field you can override the realField if the real field is not set. | |
HandlerBase:: |
protected | property | The module handler. | 3 |
HandlerBase:: |
public | property | Where the $query object will reside: | 7 |
HandlerBase:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
HandlerBase:: |
public | property | The relationship used for this field. | |
HandlerBase:: |
public | property | The table this handler is attached to. | |
HandlerBase:: |
public | property | The alias of the table of this handler which is used in the query. | |
HandlerBase:: |
protected | property | The views data service. | |
HandlerBase:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
HandlerBase:: |
public | function |
Check whether given user has access to this handler. Overrides ViewsHandlerInterface:: |
4 |
HandlerBase:: |
public | function |
Return a string representing this handler's name in the UI. Overrides ViewsHandlerInterface:: |
4 |
HandlerBase:: |
public static | function |
Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Determines if the handler is considered 'broken', meaning it's a
placeholder used when a handler can't be found. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | Render our chunk of the exposed handler form when selecting | 1 |
HandlerBase:: |
public | function | Form for exposed handler options. | 2 |
HandlerBase:: |
public | function | Provide a form for setting options. | 1 |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 1 |
HandlerBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginBase:: |
10 |
HandlerBase:: |
public | function | Determine if a handler can be exposed. | 2 |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
public | function | Displays the Expose form. | |
HandlerBase:: |
public | function |
Ensure the main table for this handler is in the query. This is used
a lot. Overrides ViewsHandlerInterface:: |
2 |
HandlerBase:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | 2 |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | 2 |
HandlerBase:: |
public | function |
Determines the entity type used by this handler. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Get the join object that should be used for this handler. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
protected | function | Gets the module handler. | |
HandlerBase:: |
public static | function |
Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
protected | function | Gets views data service. | |
HandlerBase:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
HandlerBase:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
HandlerBase:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 1 |
HandlerBase:: |
protected | function | Provides a unique placeholders for handlers. | |
HandlerBase:: |
public | function |
Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Run before the view is built. Overrides ViewsHandlerInterface:: |
2 |
HandlerBase:: |
public | function |
Sanitize the value for output. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | Sets the module handler. | |
HandlerBase:: |
public | function |
Called just prior to query(), this lets a handler set up any relationship
it needs. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | ||
HandlerBase:: |
public | function | Shortcut to display the expose/hide button. | 2 |
HandlerBase:: |
public | function |
Shortcut to display the exposed options form. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
HandlerBase:: |
public | function | Submit the exposed handler form | |
HandlerBase:: |
public | function | Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data. | |
HandlerBase:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
HandlerBase:: |
public | function | Calculates options stored on the handler | 1 |
HandlerBase:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 1 |
HandlerBase:: |
public | function | A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests. | |
HandlerBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides PluginBase:: |
2 |
HandlerBase:: |
public | function | Validate the exposed handler form | 4 |
HandlerBase:: |
public | function | Validate the options form. | 1 |
HandlerBase:: |
public | function | Validate the options form. | |
HandlerBase:: |
public | function |
Constructs a Handler object. Overrides PluginBase:: |
44 |
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:: |
public | property | Plugins's definition | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | 3 |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
62 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Clears a plugin. Overrides ViewsPluginInterface:: |
2 |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function |
Filter out stored options depending on the defined options. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns an array of available token replacements. Overrides ViewsPluginInterface:: |
|
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 |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
protected | function | Returns the render API renderer. | 1 |
PluginBase:: |
public | function |
Adds elements for available core tokens to a form. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns a string with any core tokens replaced. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function |
Return the human readable name of the display. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Flattens the structure of form elements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function |
Handle any special handling on the validate form. Overrides ViewsPluginInterface:: |
16 |
PluginBase:: |
public | function |
Returns the summary of the settings in the display. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
public | function |
Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface:: |
1 |
PluginBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface:: |
6 |
PluginBase:: |
public | function |
Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns the usesOptions property. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public | function |
Validate the options form. Overrides ViewsPluginInterface:: |
15 |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | 1 |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
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. | |
SuggestionsSpellCheck:: |
public | function |
Provide a form to edit options for this plugin. Overrides DidYouMeanSpellCheck:: |
|
SuggestionsSpellCheck:: |
protected | function | Combine multiple arrays to one array with all possible suggestions. | |
SuggestionsSpellCheck:: |
protected | function |
Information about options for all kinds of purposes will be held here. Overrides DidYouMeanSpellCheck:: |
|
SuggestionsSpellCheck:: |
protected | function | Combine a suggestion based on the odometer. | |
SuggestionsSpellCheck:: |
protected | function |
Gets the suggestion label. Overrides DidYouMeanSpellCheck:: |
|
SuggestionsSpellCheck:: |
protected | function | Increment the odometer. | |
SuggestionsSpellCheck:: |
public | function |
Render the area. Overrides DidYouMeanSpellCheck:: |
|
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. |