TtmServer backend based on ElasticSearch. More...

Inheritance diagram for MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer:

Public Member Functions
	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.

	query (string $sourceLanguage, string $targetLanguage, string $text)
	Fetches all relevant suggestions for given text.

	update (MessageHandle $handle, ?string $targetText)
	Shovels the new translation into translation memory.

	beginBootstrap ()
	Begin the bootstrap process.

	beginBatch ()
	Called before every batch (MessageGroup).

	batchInsertDefinitions (array $batch)

	batchInsertTranslations (array $batch)
	Called multiple times per batch if necessary.

	endBatch ()
	Called after every batch (MessageGroup).

	endBootstrap ()
	Do any cleanup, optimizing etc.

	getClient ()

	useWikimediaExtraPlugin ()

	getIndex ()

	setLogger (TTMServerBootstrap $logger)

	setDoReIndex ()
	Instruct the service to fully wipe the index and start from scratch.

	createSearch (string $queryString, array $opts, array $highlight)
	Search interface.

	search (string $queryString, array $opts, array $highlight)
	Search interface.

	getFacets ( $resultset)
	@inheritDoc

	getTotalHits ( $resultset)
	@inheritDoc

	getDocuments ( $resultset)
	@inheritDoc

Public Member Functions inherited from MediaWiki\Extension\Translate\TtmServer\TtmServer
	__construct (array $config)

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Extension\Translate\TtmServer\TtmServer
static	sortSuggestions (array $suggestions)

static	onDelete (WikiPage $wikipage)
	Hook: ArticleDeleteComplete.

static	onChange (MessageHandle $handle)
	Called from TranslateEditAddons::onSave.

static	onGroupChange (MessageHandle $handle, array $old)

Protected Attributes inherited from MediaWiki\Extension\Translate\TtmServer\TtmServer
array	$config

Detailed Description

TtmServer backend based on ElasticSearch.

Depends on Elastica.

Author: Niklas Laxström @license GPL-2.0-or-later

Since: 2014.04

Definition at line 38 of file ElasticSearchTtmServer.php.

Member Function Documentation

◆ batchInsertDefinitions()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::batchInsertDefinitions ( array $batch )

Parameters

array[] $batch @phan-param array<int,array{0:MessageHandle,1:string,2:string}> $batch

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 402 of file ElasticSearchTtmServer.php.

◆ batchInsertTranslations()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::batchInsertTranslations ( array $batch )

Called multiple times per batch if necessary.

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 412 of file ElasticSearchTtmServer.php.

◆ beginBatch()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::beginBatch ( )

Called before every batch (MessageGroup).

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 395 of file ElasticSearchTtmServer.php.

◆ beginBootstrap()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::beginBootstrap ( )

Begin the bootstrap process.

Exceptions

RuntimeException

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 345 of file ElasticSearchTtmServer.php.

◆ createSearch()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::createSearch	(	string	$queryString,
		array	$opts,
		array	$highlight )

Search interface.

Definition at line 573 of file ElasticSearchTtmServer.php.

◆ endBatch()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::endBatch ( )

Called after every batch (MessageGroup).

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 433 of file ElasticSearchTtmServer.php.

◆ endBootstrap()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::endBootstrap ( )

Do any cleanup, optimizing etc.

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 436 of file ElasticSearchTtmServer.php.

◆ expandLocation()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::expandLocation ( array $suggestion )

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

Returns: string URL

Implements MediaWiki\Extension\Translate\TtmServer\ReadableTtmServer.

Definition at line 66 of file ElasticSearchTtmServer.php.

◆ getClient()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::getClient ( )

Definition at line 443 of file ElasticSearchTtmServer.php.

◆ getDocuments()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::getDocuments ( $resultset )

@inheritDoc

Implements MediaWiki\Extension\Translate\TtmServer\SearchableTtmServer.

Definition at line 674 of file ElasticSearchTtmServer.php.

◆ getFacets()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::getFacets ( $resultset )

@inheritDoc

Implements MediaWiki\Extension\Translate\TtmServer\SearchableTtmServer.

Definition at line 648 of file ElasticSearchTtmServer.php.

◆ getIndex()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::getIndex ( )

Definition at line 463 of file ElasticSearchTtmServer.php.

◆ getTotalHits()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::getTotalHits ( $resultset )

@inheritDoc

Implements MediaWiki\Extension\Translate\TtmServer\SearchableTtmServer.

Definition at line 668 of file ElasticSearchTtmServer.php.

◆ isLocalSuggestion()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::isLocalSuggestion ( array $suggestion )

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

Implements MediaWiki\Extension\Translate\TtmServer\ReadableTtmServer.

Definition at line 62 of file ElasticSearchTtmServer.php.

◆ query()

MediaWiki\Extension\Translate\TtmServer\ElasticSearchTtmServer::query	(	string	$sourceLanguage,
		string	$targetLanguage,
		string	$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: