class IndexOverviewForm in Search API Autocomplete 8

Defines the overview of all search autocompletion configurations.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\search_api_autocomplete\Form\IndexOverviewForm

Expanded class hierarchy of IndexOverviewForm

1 string reference to 'IndexOverviewForm'

search_api_autocomplete.routing.yml in ./search_api_autocomplete.routing.yml: search_api_autocomplete.routing.yml

File

src/Form/IndexOverviewForm.php, line 23

Namespace

Drupal\search_api_autocomplete\Form

View source

class IndexOverviewForm extends FormBase {

  /**
   * The autocomplete suggester manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $suggesterManager;

  /**
   * The search plugin manager.
   *
   * @var \Drupal\search_api_autocomplete\Search\SearchPluginManager
   */
  protected $searchPluginManager;

  /**
   * The plugin helper.
   *
   * @var \Drupal\search_api_autocomplete\Utility\PluginHelperInterface
   */
  protected $pluginHelper;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The redirect destination.
   *
   * @var \Drupal\Core\Routing\RedirectDestinationInterface
   */
  protected $redirectDestination;

  /**
   * The messenger.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Creates a new AutocompleteSearchAdminOverview instance.
   *
   * @param \Drupal\Component\Plugin\PluginManagerInterface $suggester_manager
   *   The suggester manager.
   * @param \Drupal\search_api_autocomplete\Search\SearchPluginManager $search_plugin_manager
   *   The search plugin manager.
   * @param \Drupal\search_api_autocomplete\Utility\PluginHelperInterface $plugin_helper
   *   The plugin helper.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Routing\RedirectDestinationInterface $redirect_destination
   *   The redirect destination.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   */
  public function __construct(PluginManagerInterface $suggester_manager, SearchPluginManager $search_plugin_manager, PluginHelperInterface $plugin_helper, EntityTypeManagerInterface $entity_type_manager, RedirectDestinationInterface $redirect_destination, MessengerInterface $messenger) {
    $this->suggesterManager = $suggester_manager;
    $this->searchPluginManager = $search_plugin_manager;
    $this->pluginHelper = $plugin_helper;
    $this->entityTypeManager = $entity_type_manager;
    $this->redirectDestination = $redirect_destination;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.search_api_autocomplete.suggester'), $container
      ->get('plugin.manager.search_api_autocomplete.search'), $container
      ->get('search_api_autocomplete.plugin_helper'), $container
      ->get('entity_type.manager'), $container
      ->get('redirect.destination'), $container
      ->get('messenger'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'search_api_autocomplete_admin_overview';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, IndexInterface $search_api_index = NULL) {
    $form_state
      ->set('index', $search_api_index);
    $index_id = $search_api_index
      ->id();
    $form['#tree'] = TRUE;
    $form['#title'] = $this
      ->t('Manage autocomplete for search index %label', [
      '%label' => $search_api_index
        ->label(),
    ]);

    /** @var \Drupal\search_api_autocomplete\SearchInterface[] $searches_by_plugin */
    $searches_by_plugin = [];
    foreach ($this
      ->loadAutocompleteSearchByIndex($index_id) as $search) {
      $searches_by_plugin[$search
        ->getSearchPluginId()] = $search;
    }
    $used_ids = [];
    $plugins = $this->pluginHelper
      ->createSearchPluginsForIndex($index_id);
    foreach ($plugins as $plugin_id => $plugin) {
      $group_label = (string) $plugin
        ->getGroupLabel();
      if (empty($form[$group_label])) {
        $form[$group_label] = [
          '#type' => 'details',
          '#open' => TRUE,
          '#title' => $plugin
            ->getGroupLabel(),
        ];
        if ($description = $plugin
          ->getGroupDescription()) {
          $form[$group_label]['#description'] = '<p>' . $description . '</p>';
        }
        $form[$group_label]['searches']['#type'] = 'tableselect';
        $form[$group_label]['searches']['#header'] = [
          'label' => $this
            ->t('Label'),
          'operations' => $this
            ->t('Operations'),
        ];
        $form[$group_label]['searches']['#empty'] = '';
        $form[$group_label]['searches']['#js_select'] = TRUE;
      }
      if (isset($searches_by_plugin[$plugin_id])) {
        $search = $searches_by_plugin[$plugin_id];
      }
      else {
        $search = $this
          ->createSearchForPlugin($plugin, $used_ids);
        $used_ids[$search
          ->id()] = TRUE;
      }
      $id = $search
        ->id();
      $form_state
        ->set([
        'searches',
        $id,
      ], $search);
      $form[$group_label]['searches'][$id] = [
        '#type' => 'checkbox',
        '#default_value' => $search
          ->status(),
        '#parents' => [
          'searches',
          $id,
        ],
      ];
      $options =& $form[$group_label]['searches']['#options'][$id];
      $options['label'] = $search
        ->label();
      $items = [];
      if ($search
        ->status()) {
        $items[] = [
          'title' => $this
            ->t('Edit'),
          'url' => $search
            ->toUrl('edit-form'),
        ];
      }
      if (!$search
        ->isNew()) {
        $items[] = [
          'title' => $this
            ->t('Delete'),
          'url' => $search
            ->toUrl('delete-form'),
        ];
      }
      if ($items) {
        $options['operations'] = [
          'data' => [
            '#type' => 'operations',
            '#links' => $items,
          ],
        ];
      }
      else {
        $options['operations'] = '';
      }
      unset($options);
    }
    if (!Element::children($form)) {
      $form['message']['#markup'] = '<p>' . $this
        ->t('There are currently no searches known for this index. You need to create at least one search view.') . '</p>';
    }
    else {
      $form['actions'] = [
        '#type' => 'actions',
      ];
      $form['actions']['submit'] = [
        '#type' => 'submit',
        '#button_type' => 'primary',
        '#value' => $this
          ->t('Save'),
      ];
    }
    return $form;
  }

  /**
   * Creates a new search entity for the given search plugin.
   *
   * @param \Drupal\search_api_autocomplete\Search\SearchPluginInterface $plugin
   *   The search plugin for which to create a search entity.
   * @param true[] $used_ids
   *   The IDs of the searches created so far for this form (to avoid
   *   duplicates). IDs are used as array keys, mapping to TRUE.
   *
   * @return \Drupal\search_api_autocomplete\SearchInterface
   *   The new search entity.
   */
  protected function createSearchForPlugin(SearchPluginInterface $plugin, array $used_ids) {
    $plugin_id = $plugin
      ->getPluginId();
    $index_id = $plugin
      ->getIndexId();
    $id = $base_id = $plugin
      ->getDerivativeId() ?: $plugin_id;
    $search_storage = $this->entityTypeManager
      ->getStorage('search_api_autocomplete_search');
    $i = 0;
    while (!empty($used_ids[$id]) || $search_storage
      ->load($id)) {
      $id = $base_id . '_' . ++$i;
    }
    $search = Search::create([
      'id' => $id,
      'status' => FALSE,
      'label' => $plugin
        ->label(),
      'index_id' => $index_id,
      'search_settings' => [
        $plugin_id => [],
      ],
      'options' => [],
    ]);

    // Find a supported suggester and set it as the default for the search.
    $suggesters = array_map(function ($suggester_info) {
      return $suggester_info['class'];
    }, $this->suggesterManager
      ->getDefinitions());
    $filter_suggesters = function ($suggester_class) use ($search) {
      return $suggester_class::supportsSearch($search);
    };
    $available_suggesters = array_filter($suggesters, $filter_suggesters);
    if ($available_suggesters) {
      reset($available_suggesters);
      $suggester_id = key($available_suggesters);
      $suggester = $this->pluginHelper
        ->createSuggesterPlugin($search, $suggester_id);
      $search
        ->setSuggesters([
        $suggester_id => $suggester,
      ]);
    }
    return $search;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $messages = $this
      ->t('The settings have been saved.');
    foreach ($form_state
      ->getValue('searches') as $id => $enabled) {

      /** @var \Drupal\search_api_autocomplete\SearchInterface $search */
      $search = $form_state
        ->get([
        'searches',
        $id,
      ]);
      if ($search && $search
        ->status() != $enabled) {
        $change = TRUE;
        if ($search
          ->isNew()) {
          $options['query'] = $this->redirectDestination
            ->getAsArray();
          $options['fragment'] = 'module-search_api_autocomplete';
          $url = Url::fromRoute('user.admin_permissions', [], $options);
          if ($url
            ->access()) {
            $vars[':perm_url'] = $url
              ->toString();
            $messages = $this
              ->t('The settings have been saved. Please remember to set the <a href=":perm_url">permissions</a> for the newly enabled searches.', $vars);
          }
        }
        $search
          ->setStatus($enabled);
        $search
          ->save();
      }
    }
    $this->messenger
      ->addStatus(empty($change) ? $this
      ->t('No values were changed.') : $messages);
  }

  /**
   * Load the autocomplete plugins for an index.
   *
   * @param string $index_id
   *   The index ID.
   *
   * @return \Drupal\search_api_autocomplete\SearchInterface[]
   *   An array of autocomplete plugins.
   */
  protected function loadAutocompleteSearchByIndex($index_id) {

    /** @var \Drupal\search_api_autocomplete\SearchInterface[] $searches */
    $searches = $this->entityTypeManager
      ->getStorage('search_api_autocomplete_search')
      ->loadByProperties([
      'index_id' => $index_id,
    ]);
    return $searches;
  }

}

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::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
IndexOverviewForm::$entityTypeManager	protected	property	The entity type manager.
IndexOverviewForm::$messenger	protected	property	The messenger. Overrides MessengerTrait::$messenger
IndexOverviewForm::$pluginHelper	protected	property	The plugin helper.
IndexOverviewForm::$redirectDestination	protected	property	The redirect destination. Overrides RedirectDestinationTrait::$redirectDestination
IndexOverviewForm::$searchPluginManager	protected	property	The search plugin manager.
IndexOverviewForm::$suggesterManager	protected	property	The autocomplete suggester manager.
IndexOverviewForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
IndexOverviewForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
IndexOverviewForm::createSearchForPlugin	protected	function	Creates a new search entity for the given search plugin.
IndexOverviewForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
IndexOverviewForm::loadAutocompleteSearchByIndex	protected	function	Load the autocomplete plugins for an index.
IndexOverviewForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
IndexOverviewForm::__construct	public	function	Creates a new AutocompleteSearchAdminOverview instance.
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	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.
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.

You are here

class IndexOverviewForm in Search API Autocomplete 8

Hierarchy

File

Namespace

Members

API Navigation