You are here

Home » API reference » Search API Autocomplete 8 » SearchEditForm.php

class SearchEditForm in Search API Autocomplete 8

Provides an edit form for autocomplete search entities.

Hierarchy

Expanded class hierarchy of SearchEditForm

File

src/Form/SearchEditForm.php, line 21

Namespace

Drupal\search_api_autocomplete\Form
View source 
class SearchEditForm extends EntityForm {

  /**
   * The entity.
   *
   * @var \Drupal\search_api_autocomplete\SearchInterface
   */
  protected $entity;

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

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

  /**
   * The logger to use.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

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

  /**
   * Creates a new SearchEditForm 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 \Psr\Log\LoggerInterface $logger
   *   The logger.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   */
  public function __construct(PluginManagerInterface $suggester_manager, SearchPluginManager $search_plugin_manager, LoggerInterface $logger, MessengerInterface $messenger) {
    $this->suggesterManager = $suggester_manager;
    $this->searchPluginManager = $search_plugin_manager;
    $this->logger = $logger;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @var \Psr\Log\LoggerInterface $logger */
    $logger = $container
      ->get('logger.channel.search_api_autocomplete');
    return new static($container
      ->get('plugin.manager.search_api_autocomplete.suggester'), $container
      ->get('plugin.manager.search_api_autocomplete.search'), $logger, $container
      ->get('messenger'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $search = $this->entity;
    $form['#title'] = $this
      ->t('Configure autocompletion for %search', [
      '%search' => $search
        ->label(),
    ]);
    $form['#tree'] = TRUE;
    $form['status'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enabled'),
      '#default_value' => $search
        ->status(),
    ];
    $form['suggesters'] = $this
      ->buildSuggestersForm($form_state);
    if (!$search
      ->hasValidSearchPlugin()) {
      $this->messenger
        ->addError($this
        ->t('No information about this search could be found. Unless this is a temporary problem for some reason, you are advised to delete this search configuration.'));
    }
    else {
      $search_plugin = $search
        ->getSearchPlugin();
      if ($search_plugin instanceof PluginFormInterface) {
        $form['search_settings'] = [];
        $plugin_form_state = SubFormState::createForSubform($form['search_settings'], $form, $form_state);
        $form['search_settings'] = $search_plugin
          ->buildConfigurationForm($form['search_settings'], $plugin_form_state);
      }
    }
    $form['options']['limit'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum number of suggestions'),
      '#description' => $this
        ->t('The maximum number of autocomplete suggestions to display in total.'),
      '#required' => TRUE,
      '#min' => 1,
      '#step' => 1,
      '#default_value' => $search
        ->getOption('limit'),
    ];
    $form['options']['min_length'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Minimum length of keywords for autocompletion'),
      '#description' => $this
        ->t('If the entered keywords are shorter than this, no autocomplete suggestions will be displayed.'),
      '#min' => 1,
      '#step' => 1,
      '#default_value' => $search
        ->getOption('min_length'),
    ];
    $form['options']['show_count'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display result count estimates'),
      '#description' => $this
        ->t('Display the estimated number of result for each suggestion. This option might not have an effect for some servers or types of suggestion.'),
      '#default_value' => (bool) $search
        ->getOption('show_count'),
    ];
    $form['advanced'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Advanced settings'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $form['advanced']['autosubmit'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable auto-submit'),
      '#description' => $this
        ->t('When enabled, the search form will automatically be submitted when a selection is made by pressing "Enter".'),
      '#default_value' => $search
        ->getOption('autosubmit'),
      '#parents' => [
        'options',
        'autosubmit',
      ],
    ];
    $form['advanced']['submit_button_selector'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Search button selector'),
      '#description' => $this
        ->t('<a href="@jquery_url">jQuery selector</a> identifying the button to use for submitting the search form. Use the ID attribute of the "Search" submit button to prevent issues when another button is present (e.g., "Reset"). The selector is evaluated relative to the form. The default value is "@default".', [
        '@jquery_url' => 'https://api.jquery.com/category/selectors/',
        '@default' => ':submit',
      ]),
      '#default_value' => $search
        ->getOption('submit_button_selector'),
      '#required' => TRUE,
      '#parents' => [
        'options',
        'submit_button_selector',
      ],
      '#states' => [
        'visible' => [
          ':input[name="options[autosubmit]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['advanced']['delay'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Delay (in ms)'),
      '#description' => $this
        ->t('The delay in milliseconds between when a keystroke occurs and when a search is performed. Low values will result in a more responsive experience for users, but can also cause a higher load on the server. Defaults to 300 ms.'),
      '#min' => 0,
      '#step' => 1,
      '#default_value' => $search
        ->getOption('delay'),
      '#parents' => [
        'options',
        'delay',
      ],
    ];
    return $form;
  }

  /**
   * Builds a form for the search's suggester plugins.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the (parent) form.
   *
   * @return array
   *   A form for selecting and configuring the search's suggesters.
   */
  protected function buildSuggestersForm(FormStateInterface $form_state) {
    $search = $this->entity;
    $available_suggesters = $this
      ->getAvailableSuggesters();
    $suggester_ids = array_keys($available_suggesters);
    $suggester_weights = $search
      ->getSuggesterWeights();
    $suggester_weights += array_fill_keys($suggester_ids, 0);
    $suggester_limits = $search
      ->getSuggesterLimits();
    $suggester_limits += array_fill_keys($suggester_ids, NULL);
    $form = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Suggester plugins'),
      '#description' => $this
        ->t('Suggester plugins represent methods for creating autocomplete suggestions from user input.'),
    ];
    $form['enabled'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Enabled suggesters'),
      '#description' => $this
        ->t('Choose the suggester plugins to use for creating autocomplete suggestions.'),
      '#options' => [],
      '#required' => TRUE,
      '#default_value' => $search
        ->getSuggesterIds(),
    ];
    $form['weights'] = [
      '#type' => 'table',
    ];
    $form['weights']['#tabledrag'][] = [
      'action' => 'order',
      'relationship' => 'sibling',
      'group' => 'search-api-autocomplete-suggester-weight',
    ];

    // For the "limit" setting we use a sentence. This requires a bit of
    // preparation.
    $sentence = (string) $this
      ->t('At most @num results');
    list($prefix, $suffix) = explode('@num', $sentence);
    $prefix = '<div class="container-inline">' . $prefix;
    $suffix .= '</div>';
    foreach ($available_suggesters as $suggester_id => $suggester) {
      $label = $suggester
        ->label();

      // Option (with additional description) for the "Enabled" checkboxes.
      $form['enabled']['#options'][$suggester_id] = $label;
      $form['enabled'][$suggester_id] = [
        '#description' => $suggester
          ->getDescription(),
      ];
      $states = [
        'visible' => [
          ":input[name=\"suggesters[enabled][{$suggester_id}]\"]" => [
            'checked' => TRUE,
          ],
        ],
      ];

      // Entry in the "Suggester order" table. (Hidden while the suggester is
      // disabled.)
      $form['weights'][$suggester_id] = [
        '#weight' => $suggester_weights[$suggester_id],
        'label' => [
          '#plain_text' => $label,
        ],
        'limit' => [
          '#type' => 'number',
          '#prefix' => $prefix,
          '#suffix' => $suffix,
          '#min' => 1,
          '#step' => 1,
          '#size' => 2,
          '#default_value' => $suggester_limits[$suggester_id],
        ],
        'weight' => [
          '#type' => 'weight',
          '#title' => $this
            ->t('Weight for suggester %label', [
            '%label' => $label,
          ]),
          '#title_display' => 'invisible',
          '#delta' => 50,
          '#default_value' => $suggester_weights[$suggester_id],
          '#attributes' => [
            'class' => [
              'search-api-autocomplete-suggester-weight',
            ],
          ],
        ],
        '#attributes' => [
          'class' => [
            'draggable',
            'js-form-wrapper',
          ],
          'data-drupal-states' => Json::encode($states),
        ],
      ];

      // "Details" container with the suggester config form, if any. (Hidden
      // while the suggester is disabled.)
      if ($suggester instanceof PluginFormInterface) {
        $args = [
          '%label' => $suggester
            ->label(),
        ];
        $form['settings'][$suggester_id] = [
          '#type' => 'details',
          '#title' => $this
            ->t('Configure suggester %label', $args),
          '#states' => $states,
        ];
        $suggester_form_state = SubformState::createForSubform($form['settings'][$suggester_id], $form, $form_state);
        $form['settings'][$suggester_id] += $suggester
          ->buildConfigurationForm($form['settings'][$suggester_id], $suggester_form_state);
      }
    }
    if (!empty($form['weights'])) {
      uasort($form['weights'], [
        SortArray::class,
        'sortByWeightProperty',
      ]);
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $values =& $form_state
      ->getValues();

    // Iterate over all suggesters that have a form and are enabled.
    $available_suggesters = $this
      ->getAvailableSuggesters();
    $enabled_suggesters = array_keys(array_filter($values['suggesters']['enabled']));
    foreach ($enabled_suggesters as $suggester_id) {
      $suggester = $available_suggesters[$suggester_id];
      if ($suggester instanceof PluginFormInterface) {
        $suggester_form_state = SubformState::createForSubform($form['suggesters']['settings'][$suggester_id], $form, $form_state);
        $suggester
          ->validateConfigurationForm($form['suggesters']['settings'][$suggester_id], $suggester_form_state);
      }
    }
    $search_plugin = $this->entity
      ->getSearchPlugin();
    if ($search_plugin instanceof PluginFormInterface) {
      $plugin_form_state = SubFormState::createForSubform($form['search_settings'], $form, $form_state);
      $search_plugin
        ->validateConfigurationForm($form['search_settings'], $plugin_form_state);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Remove button and internal Form API values from submitted values.
    $form_state
      ->cleanValues();
    $this->entity = $this
      ->buildEntity($form, $form_state);
    $search = $this->entity;
    $values = $form_state
      ->getValues();

    // Iterate over all suggesters that are enabled.
    $available_suggesters = $this
      ->getAvailableSuggesters();

    /** @var \Drupal\search_api_autocomplete\Suggester\SuggesterInterface[] $enabled_suggesters */
    $enabled_suggesters = array_intersect_key($available_suggesters, array_filter($values['suggesters']['enabled']));
    $suggester_weights = [];
    $suggester_limits = [];
    foreach ($enabled_suggesters as $suggester_id => $suggester) {

      // Submit the form, if there is one.
      if ($suggester instanceof PluginFormInterface) {
        $suggester_form_state = SubformState::createForSubform($form['suggesters']['settings'][$suggester_id], $form, $form_state);
        $suggester
          ->submitConfigurationForm($form['suggesters']['settings'][$suggester_id], $suggester_form_state);
      }
      $suggester_weights[$suggester_id] = (int) $values['suggesters']['weights'][$suggester_id]['weight'];
      if (is_numeric($values['suggesters']['weights'][$suggester_id]['limit'])) {
        $suggester_limits[$suggester_id] = (int) $values['suggesters']['weights'][$suggester_id]['limit'];
      }
    }
    $search
      ->setSuggesters($enabled_suggesters);
    $search
      ->set('suggester_weights', $suggester_weights);
    $search
      ->set('suggester_limits', $suggester_limits);
    $search_plugin = $this->entity
      ->getSearchPlugin();
    if ($search_plugin instanceof PluginFormInterface) {
      $plugin_form = empty($form['search_settings']) ? [] : $form['search_settings'];
      $plugin_form_state = SubFormState::createForSubform($form['search_settings'], $form, $form_state);
      $search_plugin
        ->submitConfigurationForm($plugin_form, $plugin_form_state);
      $search
        ->set('search_settings', $search_plugin
        ->getConfiguration());
    }
    $form_state
      ->setRedirect('search_api_autocomplete.admin_overview', [
      'search_api_index' => $search
        ->getIndexId(),
    ]);
    $this->messenger
      ->addStatus($this
      ->t('The autocompletion settings for the search have been saved.'));
  }

  /**
   * Returns all suggesters available for this search.
   *
   * @return \Drupal\search_api_autocomplete\Suggester\SuggesterInterface[]
   *   The available suggesters, sorted by label.
   */
  protected function getAvailableSuggesters() {
    $suggesters = $this->entity
      ->getSuggesters();
    $settings['#search'] = $this->entity;
    $definitions = $this->suggesterManager
      ->getDefinitions();
    foreach ($definitions as $plugin_id => $definition) {
      if (isset($suggesters[$plugin_id])) {
        continue;
      }
      if (class_exists($definition['class'])) {
        $method = [
          $definition['class'],
          'supportsSearch',
        ];
        if (call_user_func($method, $this->entity)) {

          /** @var \Drupal\search_api_autocomplete\Suggester\SuggesterInterface $suggester */
          $suggester = $this->suggesterManager
            ->createInstance($plugin_id, $settings);
          $suggesters[$plugin_id] = $suggester;
        }
      }
      else {
        $this->logger
          ->warning('Suggester %id specifies a non-existing class %class.', [
          '%id' => $plugin_id,
          '%class' => $definition['class'],
        ]);
      }
    }
    $compare = function (SuggesterInterface $a, SuggesterInterface $b) {
      return strnatcasecmp($a
        ->label(), $b
        ->label());
    };
    uasort($suggesters, $compare);
    return $suggesters;
  }

}

Members

Namesort descending 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
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$privateEntityManager private property The entity manager.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 29
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 2
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties 7
EntityForm::form public function Gets the actual form array to be built. 30
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 5
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 1
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 10
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::save public function Form submission handler for the 'save' action. Overrides EntityFormInterface::save 41
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::__get public function
EntityForm::__set public function
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.
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::$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.
SearchEditForm::$entity protected property The entity. Overrides EntityForm::$entity
SearchEditForm::$logger protected property The logger to use.
SearchEditForm::$messenger protected property The messenger. Overrides MessengerTrait::$messenger
SearchEditForm::$searchPluginManager protected property The autocomplete search plugin manager.
SearchEditForm::$suggesterManager protected property The autocomplete suggester manager.
SearchEditForm::buildForm public function Form constructor. Overrides EntityForm::buildForm
SearchEditForm::buildSuggestersForm protected function Builds a form for the search's suggester plugins.
SearchEditForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
SearchEditForm::getAvailableSuggesters protected function Returns all suggesters available for this search.
SearchEditForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides EntityForm::submitForm
SearchEditForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
SearchEditForm::__construct public function Creates a new SearchEditForm instance.
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.