interface SearchApiMultiServiceInterface in Search API Multi-Index Searches 7

Interface for services supporting the "search_api_multi" feature.

The interface shouldn't be implemented directly (i.e., with a proper "implements" statement) since this would introduce a needless dependency.

Hierarchy

• interface \SearchApiServiceInterface
  • interface \SearchApiMultiServiceInterface

File

./search_api_multi.service.inc, line 9

interface SearchApiMultiServiceInterface extends SearchApiServiceInterface {

  /**
   * Executes a search on the server represented by this object.
   *
   * @param SearchApiMultiQueryInterface $query
   *   The search query to execute.
   *
   * @throws SearchApiException
   *   If an error prevented the search from completing.
   *
   * @return array
   *   An associative array containing the search results, as required by
   *   SearchApiMultiQueryInterface::execute().
   */
  public function searchMultiple(SearchApiMultiQueryInterface $query);

}

Members

Name	Modifiers	Type	Description	Overrides
SearchApiMultiServiceInterface::searchMultiple	public	function	Executes a search on the server represented by this object.
SearchApiServiceInterface::addIndex	public	function	Adds a new index to this server.	2
SearchApiServiceInterface::configurationForm	public	function	Form constructor for the server configuration form.	2
SearchApiServiceInterface::configurationFormSubmit	public	function	Submit callback for the form returned by configurationForm().	2
SearchApiServiceInterface::configurationFormValidate	public	function	Validation callback for the form returned by configurationForm().	2
SearchApiServiceInterface::deleteItems	public	function	Deletes indexed items from this server.	2
SearchApiServiceInterface::fieldsUpdated	public	function	Notifies the server that the field settings for the index have changed.	2
SearchApiServiceInterface::indexItems	public	function	Indexes the specified items.	2
SearchApiServiceInterface::postCreate	public	function	Reacts to the server's creation.	2
SearchApiServiceInterface::postUpdate	public	function	Notifies this server that its fields are about to be updated.	2
SearchApiServiceInterface::preDelete	public	function	Notifies this server that it is about to be deleted from the database.	2
SearchApiServiceInterface::query	public	function	Creates a query object for searching on an index lying on this server.	2
SearchApiServiceInterface::removeIndex	public	function	Removes an index from this server.	2
SearchApiServiceInterface::search	public	function	Executes a search on the server represented by this object.	3
SearchApiServiceInterface::supportsFeature	public	function	Determines whether this service class supports a given feature.	2
SearchApiServiceInterface::viewSettings	public	function	Displays this server's settings.	2
SearchApiServiceInterface::__construct	public	function	Constructs a service object.	2