SearchableTTMServer Interface Reference

Interface for TTMServer that can act as backend for translation search. More...

Inheritance diagram for SearchableTTMServer:

Public Member Functions
	search ( $queryString, $opts, $highlight)
	Performs a search in the translation database.
	getFacets ( $resultset)
	getTotalHits ( $resultset)
	getDocuments ( $resultset)

Detailed Description

Interface for TTMServer that can act as backend for translation search.

Since

2014.04

Definition at line 133 of file Interfaces.php.

Member Function Documentation

getDocuments()

SearchableTTMServer::getDocuments

(

$resultset

)

Parameters

mixed

$resultset

Returns

array[]

Implemented in ElasticSearchTTMServer.

getFacets()

SearchableTTMServer::getFacets

(

$resultset

)

Parameters

mixed

$resultset

Returns

array[]

Implemented in ElasticSearchTTMServer.

getTotalHits()

SearchableTTMServer::getTotalHits

(

$resultset

)

Parameters

mixed

$resultset

Returns

int

Implemented in ElasticSearchTTMServer.

search()

SearchableTTMServer::search	(		$queryString,
			$opts,
			$highlight )

Performs a search in the translation database.

Parameters

string	$queryString	String to search for.
array	$opts	Query options like language.
array	$highlight	Tags for highlighting.

Returns

mixed Result set

Implemented in ElasticSearchTTMServer.

---

The documentation for this interface was generated from the following file:

• ttmserver/Interfaces.php