class SuggestionIndexForm in Autocomplete Search Suggestions 3.0.x
Same name and namespace in other branches
- 8.2 src/Form/SuggestionIndexForm.php \Drupal\suggestion\Form\SuggestionIndexForm
- 8 src/Form/SuggestionIndexForm.php \Drupal\suggestion\Form\SuggestionIndexForm
Suggestion indexing form.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\suggestion\Form\SuggestionIndexForm
Expanded class hierarchy of SuggestionIndexForm
1 string reference to 'SuggestionIndexForm'
File
- src/
Form/ SuggestionIndexForm.php, line 14
Namespace
Drupal\suggestion\FormView source
class SuggestionIndexForm extends FormBase {
/**
* The suggestion indexing form.
*
* @param array $form
* A drupal form array.
* @param Drupal\Core\Form\FormStateInterface $form_state
* A Drupal form state object.
*
* @return array
* A Drupal form array.
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$synced = SuggestionHelper::getConfig('synced');
$form['feedback'] = [
'#markup' => '<div id="suggestion-index-feedback">' . ($synced ? $this
->t('No indexing required.') : $this
->t('Indexing required.')) . '</div>',
'#weight' => 10,
];
$form['flush'] = [
'#title' => $this
->t('Flush all suggestions'),
'#description' => $this
->t('Flushes all suggestions including priority and surfer suggestions.'),
'#type' => 'checkbox',
'#default_value' => FALSE,
'#required' => FALSE,
'#weight' => 20,
];
$form['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Index Suggestions'),
'#weight' => 30,
'#ajax' => [
'callback' => '\\Drupal\\suggestion\\Form\\SuggestionIndexForm::submitForm',
'effect' => 'fade',
'method' => 'replace',
'wrapper' => 'suggestion-index-feedback',
'progress' => [
'type' => 'throbber',
'message' => 'Please wait...',
],
],
];
return $form;
}
/**
* The form ID.
*
* @return string
* The form ID.
*/
public function getFormId() {
return 'suggestion_index';
}
/**
* AJAX callback for the indexing form.
*
* @param array $form
* A drupal form array.
* @param Drupal\Core\Form\FormStateInterface $form_state
* A Drupal form state object.
*
* @return array
* A Drupal form array.
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$t = new TranslatableMarkup('Suggestions Indexed');
if ($form_state
->getValue('flush')) {
SuggestionStorage::truncateSuggestion();
}
SuggestionHelper::index();
return [
'#markup' => '<div id="suggestion-index-feedback"><p>' . $t
->render() . '</p></div>',
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
105 |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
72 |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
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. | |
SuggestionIndexForm:: |
public | function |
The suggestion indexing form. Overrides FormInterface:: |
|
SuggestionIndexForm:: |
public | function |
The form ID. Overrides FormInterface:: |
|
SuggestionIndexForm:: |
public | function |
AJAX callback for the indexing form. Overrides FormInterface:: |