You are here

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

interface SearchInterface in Search API Autocomplete 8

Describes the autocomplete settings for a certain search.

Hierarchy

Expanded class hierarchy of SearchInterface

All classes that implement SearchInterface

18 files declare their use of SearchInterface
AccessTest.php in tests/src/Unit/AccessTest.php
AutocompleteController.php in src/Controller/AutocompleteController.php
AutocompleteHelper.php in src/Utility/AutocompleteHelper.php
AutocompleteHelperInterface.php in src/Utility/AutocompleteHelperInterface.php
CustomScript.php in src/Plugin/search_api_autocomplete/suggester/CustomScript.php

... See full list

File

src/SearchInterface.php, line 11

Namespace

Drupal\search_api_autocomplete
View source 
interface SearchInterface extends ConfigEntityInterface {

  /**
   * Retrieves the default options for a search.
   *
   * @return array
   *   An associative array of options.
   */
  public static function getDefaultOptions();

  /**
   * Retrieves the ID of the index this search belongs to.
   *
   * @return string
   *   The index ID.
   */
  public function getIndexId();

  /**
   * Determines whether this search has a valid index set.
   *
   * @return bool
   *   TRUE if the index this search belongs to can be loaded, FALSE otherwise.
   */
  public function hasValidIndex();

  /**
   * Retrieves the index this search belongs to.
   *
   * @return \Drupal\search_api\IndexInterface
   *   The index this search belongs to.
   *
   * @throws \Drupal\search_api_autocomplete\SearchApiAutocompleteException
   *   Thrown if the index couldn't be retrieved.
   */
  public function getIndex();

  /**
   * Retrieves this search's suggester plugins.
   *
   * @return \Drupal\search_api_autocomplete\Suggester\SuggesterInterface[]
   *   The suggester plugins used by this search, keyed by plugin ID.
   */
  public function getSuggesters();

  /**
   * Retrieves the IDs of all suggesters enabled for this search.
   *
   * @return string[]
   *   The IDs of the suggester plugins used by this search.
   */
  public function getSuggesterIds();

  /**
   * Determines whether the given suggester ID is valid for this search.
   *
   * The general contract of this method is that it should return TRUE if, and
   * only if, a call to getSuggester() with the same ID would not result in an
   * exception.
   *
   * @param string $suggester_id
   *   A suggester plugin ID.
   *
   * @return bool
   *   TRUE if the suggester with the given ID is enabled for this search and
   *   can be loaded. FALSE otherwise.
   */
  public function isValidSuggester($suggester_id);

  /**
   * Retrieves a specific suggester plugin for this search.
   *
   * @param string $suggester_id
   *   The ID of the suggester plugin to return.
   *
   * @return \Drupal\search_api_autocomplete\Suggester\SuggesterInterface
   *   The suggester plugin with the given ID.
   *
   * @throws \Drupal\search_api_autocomplete\SearchApiAutocompleteException
   *   Thrown if the specified suggester isn't enabled for this search, or
   *   couldn't be loaded.
   */
  public function getSuggester($suggester_id);

  /**
   * Adds a suggester to this search.
   *
   * An existing suggester with the same ID will be replaced.
   *
   * @param \Drupal\search_api_autocomplete\Suggester\SuggesterInterface $suggester
   *   The suggester to be added.
   *
   * @return $this
   */
  public function addSuggester(SuggesterInterface $suggester);

  /**
   * Removes a suggester from this search.
   *
   * @param string $suggester_id
   *   The ID of the suggester to remove.
   *
   * @return $this
   */
  public function removeSuggester($suggester_id);

  /**
   * Sets this search's suggester plugins.
   *
   * @param \Drupal\search_api_autocomplete\Suggester\SuggesterInterface[] $suggesters
   *   An array of suggesters.
   *
   * @return $this
   */
  public function setSuggesters(array $suggesters);

  /**
   * Retrieves the weights set for the search's suggesters.
   *
   * @return int[]
   *   The suggester weights, keyed by suggester ID.
   */
  public function getSuggesterWeights();

  /**
   * Retrieves the individual limits set for the search's suggesters.
   *
   * @return int[]
   *   The suggester limits (where set), keyed by suggester ID.
   */
  public function getSuggesterLimits();

  /**
   * Determines whether the search plugin set for this search is valid.
   *
   * @return bool
   *   TRUE if the search plugin is valid, FALSE otherwise.
   */
  public function hasValidSearchPlugin();

  /**
   * Retrieves the search plugin's ID.
   *
   * @return string
   *   The ID of the search plugin used by this search.
   */
  public function getSearchPluginId();

  /**
   * Retrieves the search plugin.
   *
   * @return \Drupal\search_api_autocomplete\Search\SearchPluginInterface
   *   The search's search plugin.
   *
   * @throws \Drupal\search_api_autocomplete\SearchApiAutocompleteException
   *   Thrown if the search plugin couldn't be instantiated.
   */
  public function getSearchPlugin();

  /**
   * Gets a specific option's value.
   *
   * @param string $key
   *   The key of the option.
   *
   * @return mixed|null
   *   The option's value, or NULL if the option is unknown.
   */
  public function getOption($key);

  /**
   * Gets the search's options.
   *
   * @return array
   *   The options.
   */
  public function getOptions();

  /**
   * Sets an option.
   *
   * @param string $name
   *   The name of an option.
   * @param mixed $option
   *   The new option.
   *
   * @return $this
   */
  public function setOption($name, $option);

  /**
   * Sets the search options.
   *
   * @param array $options
   *   The options.
   *
   * @return $this
   */
  public function setOptions(array $options);

  /**
   * Creates a query object for this search.
   *
   * @param string $keys
   *   The fulltext search keywords to place on the query.
   * @param array $data
   *   (optional) Additional data passed to the callback.
   *
   * @return \Drupal\search_api\Query\QueryInterface
   *   The query that would normally be executed when $keys is entered as the
   *   keywords for this search. Callers should check whether keywords are
   *   actually set on the query.
   *
   * @throws \Drupal\search_api_autocomplete\SearchApiAutocompleteException
   *   Thrown if the query couldn't be created.
   */
  public function createQuery($keys, array $data = []);

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
SearchInterface::addSuggester public function Adds a suggester to this search. 1
SearchInterface::createQuery public function Creates a query object for this search. 1
SearchInterface::getDefaultOptions public static function Retrieves the default options for a search. 1
SearchInterface::getIndex public function Retrieves the index this search belongs to. 1
SearchInterface::getIndexId public function Retrieves the ID of the index this search belongs to. 1
SearchInterface::getOption public function Gets a specific option's value. 1
SearchInterface::getOptions public function Gets the search's options. 1
SearchInterface::getSearchPlugin public function Retrieves the search plugin. 1
SearchInterface::getSearchPluginId public function Retrieves the search plugin's ID. 1
SearchInterface::getSuggester public function Retrieves a specific suggester plugin for this search. 1
SearchInterface::getSuggesterIds public function Retrieves the IDs of all suggesters enabled for this search. 1
SearchInterface::getSuggesterLimits public function Retrieves the individual limits set for the search's suggesters. 1
SearchInterface::getSuggesters public function Retrieves this search's suggester plugins. 1
SearchInterface::getSuggesterWeights public function Retrieves the weights set for the search's suggesters. 1
SearchInterface::hasValidIndex public function Determines whether this search has a valid index set. 1
SearchInterface::hasValidSearchPlugin public function Determines whether the search plugin set for this search is valid. 1
SearchInterface::isValidSuggester public function Determines whether the given suggester ID is valid for this search. 1
SearchInterface::removeSuggester public function Removes a suggester from this search. 1
SearchInterface::setOption public function Sets an option. 1
SearchInterface::setOptions public function Sets the search options. 1
SearchInterface::setSuggesters public function Sets this search's suggester plugins. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5