You are here

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

class TestSuggester in Search API Autocomplete 8

Defines a test suggester class.

Plugin annotation


@SearchApiAutocompleteSuggester(
  id = "search_api_autocomplete_test",
  label = @Translation("Test suggester"),
  description = @Translation("Suggester used for tests."),
)

Hierarchy

Expanded class hierarchy of TestSuggester

File

tests/search_api_autocomplete_test/src/Plugin/search_api_autocomplete/suggester/TestSuggester.php, line 23

Namespace

Drupal\search_api_autocomplete_test\Plugin\search_api_autocomplete\suggester
View source 
class TestSuggester extends SuggesterPluginBase implements PluginFormInterface {
  use TestPluginTrait;

  /**
   * {@inheritdoc}
   */
  public static function supportsSearch(SearchInterface $search) {
    $key = 'search_api_test.suggester.method.' . __FUNCTION__;
    $override = \Drupal::state()
      ->get($key);
    if ($override) {
      return call_user_func($override, $search);
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $this
      ->logMethodCall(__FUNCTION__, func_get_args());
    if ($override = $this
      ->getMethodOverride(__FUNCTION__)) {
      return call_user_func($override, $this, $form, $form_state);
    }
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this
      ->logMethodCall(__FUNCTION__, func_get_args());
    if ($override = $this
      ->getMethodOverride(__FUNCTION__)) {
      call_user_func($override, $this, $form, $form_state);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this
      ->logMethodCall(__FUNCTION__, func_get_args());
    if ($override = $this
      ->getMethodOverride(__FUNCTION__)) {
      call_user_func($override, $this, $form, $form_state);
      return;
    }
    $this
      ->setConfiguration($form_state
      ->getValues());
  }

  /**
   * {@inheritdoc}
   */
  public function getAutocompleteSuggestions(QueryInterface $query, $incomplete_key, $user_input) {
    $this
      ->logMethodCall(__FUNCTION__, func_get_args());
    if ($override = $this
      ->getMethodOverride(__FUNCTION__)) {
      return call_user_func($override, $this, $query, $incomplete_key, $user_input);
    }
    $suggestions = [];
    $factory = new SuggestionFactory($user_input);

    // Add some suffix-based suggestions and one URL-based suggestion.
    for ($i = 1; $i < $query
      ->getOption('limit', 10); ++$i) {
      $suggestions[] = $factory
        ->createFromSuggestionSuffix("-suggester-{$i}", $i);
    }
    $account = \Drupal::currentUser()
      ->getAccount();
    if ($uid = $account
      ->id()) {
      $url = Url::fromRoute('entity.user.canonical', [
        'user' => $uid,
      ]);
    }
    else {
      $url = Url::fromRoute('user.login');
    }
    $suggestions[] = $factory
      ->createUrlSuggestion($url, "{$user_input}-suggester-url");
    return $suggestions;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $this
      ->logMethodCall(__FUNCTION__, func_get_args());
    if ($override = $this
      ->getMethodOverride(__FUNCTION__)) {
      return call_user_func($override, $this);
    }
    if (!empty($this->configuration['dependencies'])) {
      return $this->configuration['dependencies'];
    }
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function onDependencyRemoval(array $dependencies) {
    $remove = $this
      ->getReturnValue(__FUNCTION__, FALSE);
    if ($remove) {
      unset($this->configuration['dependencies']);
    }
    return $remove;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 11
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::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 3
ConfigurablePluginBase::themeHandler Deprecated protected function Wraps the theme handler.
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
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.
SuggesterPluginBase::alterAutocompleteElement public function Alters an autocomplete element that should use this suggester. Overrides SuggesterInterface::alterAutocompleteElement 1
TestPluginTrait::$pluginType protected property This object's plugin type.
TestPluginTrait::checkError protected function Throws an exception if set in the Drupal state for the given method.
TestPluginTrait::getMethodOverride protected function Retrieves a possible override set for the given method.
TestPluginTrait::getPluginType protected function Returns the plugin type of this object.
TestPluginTrait::getReturnValue protected function Retrieves the value to return for a certain method.
TestPluginTrait::logMethodCall protected function Logs a method call to the site state.
TestPluginTrait::__call public function Implements the magic __call() method.
TestSuggester::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
TestSuggester::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides ConfigurablePluginBase::calculateDependencies
TestSuggester::getAutocompleteSuggestions public function Retrieves autocompletion suggestions for some user input. Overrides SuggesterInterface::getAutocompleteSuggestions
TestSuggester::onDependencyRemoval public function Informs the plugin that some of its dependencies are being removed. Overrides ConfigurablePluginBase::onDependencyRemoval
TestSuggester::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
TestSuggester::supportsSearch public static function Determines whether this plugin supports the given search. Overrides SuggesterPluginBase::supportsSearch
TestSuggester::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm