You are here

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

class CustomScript in Search API Autocomplete 8

Uses a custom (non-Drupal) script for generating autocomplete suggestions.

Plugin annotation


@SearchApiAutocompleteSuggester(
  id = "custom_script",
  label = @Translation("Use custom script"),
  description = @Translation("Specify the path to a PHP script file (or Drupal route) which should be used to generate autocomplete suggestions. This can be used to completely bypass Drupal for improved performance.<br />(<strong>Caution:</strong> If a non-Drupal script is used, Drupal's access restrictions will also be bypassed.)<br />(Note: Due to the nature of this suggester, some of the other settings for this search will be ignored (including other enabled suggesters).)"),
)

Hierarchy

Expanded class hierarchy of CustomScript

See also

custom_autocomplete_script.php

File

src/Plugin/search_api_autocomplete/suggester/CustomScript.php, line 25

Namespace

Drupal\search_api_autocomplete\Plugin\search_api_autocomplete\suggester
View source 
class CustomScript extends SuggesterPluginBase implements PluginFormInterface {
  use PluginFormTrait;

  /**
   * {@inheritdoc}
   */
  public static function supportsSearch(SearchInterface $search) {
    return (bool) \Drupal::config('search_api_autocomplete.settings')
      ->get('enable_custom_scripts');
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'path' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom script path'),
      '#description' => $this
        ->t('The internal path or external URL to use for autocompletion. A local path should start with a leading slash. For using an external URL, please take CSRF protection into account.'),
      '#default_value' => $this->configuration['path'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('path', '') === '') {
      $args = [
        '%field' => $form['path']['#title'],
      ];
      $message = $this
        ->t('The %field field is required.', $args);
      $form_state
        ->setError($form['path'], $message);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function alterAutocompleteElement(array &$element) {
    $options['query'] = $element['#autocomplete_route_parameters'];
    unset($element['#autocomplete_route_name'], $element['#autocomplete_route_parameters']);
    $path = $this->configuration['path'];
    $path_len = strlen($path);

    // We allow both internal and external URLs to be used.
    if ($path_len > 1 && $path[0] === '/' && ($path_len < 2 || $path[1] !== '/')) {
      $url = Url::fromUserInput($path, $options);
    }
    else {
      $url = Url::fromUri($path, $options);
    }
    $url = $url
      ->toString(TRUE);

    // Without the "#autocomplete_route_name", we need to inline
    // \Drupal\Core\Render\Element\FormElement::processAutocomplete().
    $element['#attributes']['class'][] = 'form-autocomplete';

    // Provide a data attribute for the JavaScript behavior to bind to.
    $element['#attributes']['data-autocomplete-path'] = $url
      ->getGeneratedUrl();
    $metadata = BubbleableMetadata::createFromRenderArray($element);
    $metadata
      ->merge($url)
      ->applyTo($element);
  }

  /**
   * {@inheritdoc}
   */
  public function getAutocompleteSuggestions(QueryInterface $query, $incomplete_key, $user_input) {

    // Autocomplete suggestions are created elsewhere if this plugin is used.
    return [];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurablePluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
ConfigurablePluginBase::calculatePluginDependencies Deprecated protected function Calculates and adds dependencies of a specific plugin instance.
ConfigurablePluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 4
ConfigurablePluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurablePluginBase::getDescription public function Returns the plugin's description. Overrides ConfigurablePluginInterface::getDescription
ConfigurablePluginBase::getPluginDependencies Deprecated protected function Calculates and returns dependencies of a specific plugin instance.
ConfigurablePluginBase::label public function Returns the label for use on the administration pages. Overrides ConfigurablePluginInterface::label
ConfigurablePluginBase::moduleHandler Deprecated protected function Wraps the module handler.
ConfigurablePluginBase::onDependencyRemoval public function Informs the plugin that some of its dependencies are being removed. Overrides ConfigurablePluginInterface::onDependencyRemoval 5
ConfigurablePluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 3
ConfigurablePluginBase::themeHandler Deprecated protected function Wraps the theme handler.
CustomScript::alterAutocompleteElement public function Alters an autocomplete element that should use this suggester. Overrides SuggesterPluginBase::alterAutocompleteElement
CustomScript::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
CustomScript::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurablePluginBase::defaultConfiguration
CustomScript::getAutocompleteSuggestions public function Retrieves autocompletion suggestions for some user input. Overrides SuggesterInterface::getAutocompleteSuggestions
CustomScript::supportsSearch public static function Determines whether this plugin supports the given search. Overrides SuggesterPluginBase::supportsSearch
CustomScript::validateConfigurationForm public function Form validation handler. Overrides PluginFormTrait::validateConfigurationForm
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
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
HideablePluginBase::isHidden public function Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface::isHidden 1
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::$search protected property The search this suggester is attached to.
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::getSearch public function Retrieves the search this plugin is configured for. Overrides PluginInterface::getSearch
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::setSearch public function Sets the search this plugin is configured for. Overrides PluginInterface::setSearch
PluginBase::__construct public function Constructs a SearchPluginBase object. Overrides ConfigurablePluginBase::__construct 1
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. Aliased as: traitCalculatePluginDependencies 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance. Aliased as: traitGetPluginDependencies
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. Aliased as: traitModuleHandler 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. Aliased as: traitThemeHandler 1
PluginFormTrait::submitConfigurationForm public function Form submission handler. 7
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.