You are here

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

class SearchApiAutocomplete in Search API Autocomplete 8

Provides a Search API Autocomplete form element.

Plugin annotation

@FormElement("search_api_autocomplete");

Hierarchy

Expanded class hierarchy of SearchApiAutocomplete

File

src/Element/SearchApiAutocomplete.php, line 15

Namespace

Drupal\search_api_autocomplete\Element
View source 
class SearchApiAutocomplete extends Textfield {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $info = parent::getInfo();
    $class = get_class($this);

    // Apply default form element properties.
    $info['#search_id'] = NULL;
    $info['#data'] = [];
    array_unshift($info['#process'], [
      $class,
      'processSearchApiAutocomplete',
    ]);
    return $info;
  }

  /**
   * Adds Search API Autocomplete functionality to a form element.
   *
   * @param array $element
   *   The form element to process. Properties used:
   *   - #search_id: The entity ID of the Search config entity.
   *   - #additional_data: (optional) Additional data to pass to the
   *     autocomplete callback as GET parameters.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed form element.
   *
   * @throws \InvalidArgumentException
   *   Thrown if the #search_id property is missing or invalid.
   */
  public static function processSearchApiAutocomplete(array &$element, FormStateInterface $form_state, array &$complete_form) {

    // Require a search ID argument. If the #search_id key is not set on the
    // element, we can't load the Search entity so we should throw an exception.
    if (empty($element['#search_id'])) {
      throw new \InvalidArgumentException('Missing required "#search_id" parameter.');
    }

    /** @var \Drupal\search_api_autocomplete\SearchInterface $search */
    $search = Search::load($element['#search_id']);
    if (!$search) {
      $search_id = $element['#search_id'];
      throw new \InvalidArgumentException("Search entity with ID \"{$search_id}\" not found.");
    }
    $access = \Drupal::getContainer()
      ->get('search_api_autocomplete.helper')
      ->access($search, \Drupal::currentUser());
    $metadata = BubbleableMetadata::createFromRenderArray($element);
    $metadata
      ->merge(BubbleableMetadata::createFromObject($access))
      ->applyTo($element);
    if (!$access
      ->isAllowed()) {

      // Don't process if access isn't allowed.
      return $element;
    }

    // Add option defaults (in case of updates from earlier versions).
    $options = $search
      ->getOptions();
    $js_settings = [];
    if ($options['submit_button_selector'] != ':submit') {
      $js_settings['selector'] = $options['submit_button_selector'];
    }
    $delay = $search
      ->getOption('delay');
    if ($delay !== NULL) {
      $js_settings['delay'] = $delay;
    }
    if ($options['autosubmit']) {
      $js_settings['auto_submit'] = TRUE;
    }
    if ($options['min_length'] > 1) {
      $js_settings['min_length'] = $options['min_length'];
    }
    $element['#attached']['library'][] = 'search_api_autocomplete/search_api_autocomplete';
    if ($js_settings) {
      $element['#attached']['drupalSettings'] = [
        'search_api_autocomplete' => [
          $search
            ->id() => $js_settings,
        ],
      ];
    }
    $element['#autocomplete_route_name'] = 'search_api_autocomplete.autocomplete';
    $element['#autocomplete_route_parameters'] = [
      'search_api_autocomplete_search' => $search
        ->id(),
    ];
    if (!empty($element['#additional_data'])) {
      $element['#autocomplete_route_parameters'] += $element['#additional_data'];
    }
    $element['#attributes']['data-search-api-autocomplete-search'] = $search
      ->id();
    foreach ($search
      ->getSuggesters() as $suggester) {
      $suggester
        ->alterAutocompleteElement($element);
    }
    return $element;
  }

}

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
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
SearchApiAutocomplete::getInfo public function Returns the element properties for this element. Overrides Textfield::getInfo
SearchApiAutocomplete::processSearchApiAutocomplete public static function Adds Search API Autocomplete functionality to a form element.
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.
Textfield::preRenderTextfield public static function Prepares a #type 'textfield' render element for input.html.twig.
Textfield::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback 3