You are here

Home » API reference » Search API 8 » TestSearch.php

class TestSearch in Search API 8

Defines a test type class.

Plugin annotation


@SearchApiAutocompleteSearch(
  id = "search_api_db_test_autocomplete",
  label = @Translation("Autocomplete test module search"),
  description = @Translation("Test autocomplete search"),
  group_label = @Translation("Test search"),
  group_description = @Translation("Searches used for tests"),
  index = "database_search_index",
)

Hierarchy

Expanded class hierarchy of TestSearch

File

modules/search_api_db/tests/search_api_db_test_autocomplete/src/Plugin/search_api_autocomplete/search/TestSearch.php, line 22

Namespace

Drupal\search_api_db_test_autocomplete\Plugin\search_api_autocomplete\search
View source 
class TestSearch extends SearchPluginBase implements PluginFormInterface {
  use TestPluginTrait;

  /**
   * {@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 createQuery($keys, array $data = []) {
    $this
      ->logMethodCall(__FUNCTION__, func_get_args());
    if ($override = $this
      ->getMethodOverride(__FUNCTION__)) {
      return call_user_func($override, $this, $keys, $data);
    }
    return $this->search
      ->getIndex()
      ->query()
      ->keys($keys);
  }

}

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::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::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.
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
SearchPluginBase::$entityTypeManager protected property The entity manager. 1
SearchPluginBase::create public static function Creates an instance of the plugin. Overrides ConfigurablePluginBase::create 2
SearchPluginBase::getEntityTypeManager public function Retrieves the entity manager.
SearchPluginBase::getGroupDescription public function Retrieves a description for this search's group. Overrides SearchPluginInterface::getGroupDescription
SearchPluginBase::getGroupLabel public function Retrieves a group label for this search. Overrides SearchPluginInterface::getGroupLabel
SearchPluginBase::getIndex public function Retrieves the index to which this search plugin belongs. Overrides SearchPluginInterface::getIndex
SearchPluginBase::getIndexId public function Retrieves the ID of the index to which this search plugin belongs. Overrides SearchPluginInterface::getIndexId
SearchPluginBase::setEntityTypeManager public function Sets the entity manager.
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.
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.
TestSearch::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
TestSearch::createQuery public function Creates a search query based on this search. Overrides SearchPluginInterface::createQuery
TestSearch::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
TestSearch::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm