class SuggestionIndexForm in Autocomplete Search Suggestions 8

Suggestion indexing form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\suggestion\Form\SuggestionIndexForm

1 string reference to 'SuggestionIndexForm'

suggestion.routing.yml in ./suggestion.routing.yml

suggestion.routing.yml

File

src/Form/SuggestionIndexForm.php, line 14

Namespace

Drupal\suggestion\Form

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::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
SuggestionIndexForm::buildForm	public	function	The suggestion indexing form. Overrides FormInterface::buildForm
SuggestionIndexForm::getFormId	public	function	The form ID. Overrides FormInterface::getFormId
SuggestionIndexForm::submitForm	public	function	AJAX callback for the indexing form. Overrides FormInterface::submitForm
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.