ReadableTTMServer Interface Reference

Interface for TTMServer that can be queried (=all of them). More...

Inheritance diagram for ReadableTTMServer:

Public Member Functions
	query ( $sourceLanguage, $targetLanguage, $text)
	Fetches all relevant suggestions for given text.
	isLocalSuggestion (array $suggestion)
	Determines if the suggestion returned by this TTMServer comes from this wiki or any other wiki.
	expandLocation (array $suggestion)
	Given suggestion returned by this TTMServer, constructs fully qualified URL to the location of the translation.

Detailed Description

Interface for TTMServer that can be queried (=all of them).

Since

2012-06-27

Definition at line 17 of file Interfaces.php.

Member Function Documentation

expandLocation()

ReadableTTMServer::expandLocation

(

array

$suggestion

)

Given suggestion returned by this TTMServer, constructs fully qualified URL to the location of the translation.

Parameters

array

$suggestion

Returns

string URL

Implemented in DatabaseTTMServer, ElasticSearchTTMServer, FakeTTMServer, and RemoteTTMServer.

isLocalSuggestion()

ReadableTTMServer::isLocalSuggestion

(

array

$suggestion

)

Determines if the suggestion returned by this TTMServer comes from this wiki or any other wiki.

Parameters

array

$suggestion

Returns

bool

Implemented in DatabaseTTMServer, ElasticSearchTTMServer, FakeTTMServer, and RemoteTTMServer.

query()

ReadableTTMServer::query	(		$sourceLanguage,
			$targetLanguage,
			$text )

Fetches all relevant suggestions for given text.

Parameters

string	$sourceLanguage	language code for the provide text
string	$targetLanguage	language code for the suggestions
string	$text	the text for which to search suggestions

Returns

array List: unordered suggestions, which each has fields:

• source: String: the original text of the suggestion
• target: String: the suggestion
• context: String: title of the page where the suggestion comes from
• quality: Float: the quality of suggestion, 1 is perfect match

Implemented in DatabaseTTMServer, ElasticSearchTTMServer, FakeTTMServer, and RemoteTTMServer.

---

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

• ttmserver/Interfaces.php