TTMServer backed based on ElasticSearch. More...

Inheritance diagram for 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.

	createIndex ( $rebuild)
	Create index.

	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 ( $logger)

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

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

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

	getFacets ( $resultset)
	@inheritDoc

	getTotalHits ( $resultset)
	@inheritDoc

	getDocuments ( $resultset)
	@inheritDoc

Public Member Functions inherited from TTMServer
	__construct (array $config)

	getMirrors ()

Public Member Functions inherited from MediaWiki\Extension\Translate\TtmServer\WritableTtmServer
	getMirrors ()
	Get the list of services to duplicate writes to make them "mirrors" of this service.

Public Member Functions inherited from MediaWiki\Extension\Translate\TtmServer\SearchableTtmServer
	search (string $queryString, array $opts, array $highlight)
	Performs a search in the translation database.

Protected Member Functions
	doQuery ( $sourceLanguage, $targetLanguage, $text)

	createDocument (MessageHandle $handle, $text, $revId)

	getShardCount ()

	getReplicaCount ()

	getIndexHealth ( $indexName)
	Get index health TODO: Remove this code in the future as we drop support for older versions of the Elastica extension.

	waitForGreen ( $indexName, $timeout)
	Wait for the index to go green.

	waitUntilReady ()

	logOutput ( $text)

	parseQueryString ( $queryString, array $opts)
	Parse query string and build the search query.

Protected Attributes
	$client

	$logger
	Reference to the maintenance script to relay logging output.

	$updateMapping = false
	Used for Reindex.

Protected Attributes inherited from TTMServer
	$config

Additional Inherited Members
Static Public Member Functions inherited from TTMServer
static	sortSuggestions (array $suggestions)

static	levenshtein ( $str1, $str2, $length1, $length2)
	PHP implementation of Levenshtein edit distance algorithm.

static	onDelete (WikiPage $wikipage)
	Hook: ArticleDeleteComplete.

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

static	onGroupChange (MessageHandle $handle, $old)

Detailed Description

TTMServer backed based on ElasticSearch.

Depends on Elastica.

Since: 2014.04

Definition at line 34 of file ElasticSearchTTMServer.php.

Member Function Documentation

◆ batchInsertDefinitions()

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 425 of file ElasticSearchTTMServer.php.

◆ batchInsertTranslations()

ElasticSearchTTMServer::batchInsertTranslations ( array $batch )

Called multiple times per batch if necessary.

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 435 of file ElasticSearchTTMServer.php.

◆ beginBatch()

ElasticSearchTTMServer::beginBatch ( )

Called before every batch (MessageGroup).

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 418 of file ElasticSearchTTMServer.php.

◆ beginBootstrap()

ElasticSearchTTMServer::beginBootstrap ( )

Begin the bootstrap process.

Exceptions

RuntimeException

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 356 of file ElasticSearchTTMServer.php.

◆ createDocument()

ElasticSearchTTMServer::createDocument	(	MessageHandle	$handle,
			$text,
			$revId )

protected

Parameters

MessageHandle	$handle
string	$text
int	$revId

Returns: Document

Definition at line 294 of file ElasticSearchTTMServer.php.

◆ createIndex()

ElasticSearchTTMServer::createIndex ( $rebuild )

Create index.

Parameters

bool $rebuild Deletes index first if already exists

Definition at line 317 of file ElasticSearchTTMServer.php.

◆ createSearch()

ElasticSearchTTMServer::createSearch	(	$queryString,
		$opts,
		$highlight )

Search interface.

Parameters

string	$queryString
array	$opts
array	$highlight

Returns: \Elastica\Search

Definition at line 658 of file ElasticSearchTTMServer.php.

◆ doQuery()

ElasticSearchTTMServer::doQuery	(	$sourceLanguage,
		$targetLanguage,
		$text )

protected

Definition at line 79 of file ElasticSearchTTMServer.php.

◆ endBatch()

ElasticSearchTTMServer::endBatch ( )

Called after every batch (MessageGroup).

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 456 of file ElasticSearchTTMServer.php.

◆ endBootstrap()

ElasticSearchTTMServer::endBootstrap ( )

Do any cleanup, optimizing etc.

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 459 of file ElasticSearchTTMServer.php.

◆ expandLocation()

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 67 of file ElasticSearchTTMServer.php.

◆ getClient()

ElasticSearchTTMServer::getClient ( )

Definition at line 466 of file ElasticSearchTTMServer.php.

◆ getDocuments()

ElasticSearchTTMServer::getDocuments ( $resultset )

@inheritDoc

Implements MediaWiki\Extension\Translate\TtmServer\SearchableTtmServer.

Definition at line 763 of file ElasticSearchTTMServer.php.

◆ getFacets()

ElasticSearchTTMServer::getFacets ( $resultset )

@inheritDoc

Implements MediaWiki\Extension\Translate\TtmServer\SearchableTtmServer.

Definition at line 737 of file ElasticSearchTTMServer.php.

◆ getIndex()

ElasticSearchTTMServer::getIndex ( )

Definition at line 487 of file ElasticSearchTTMServer.php.

◆ getIndexHealth()

ElasticSearchTTMServer::getIndexHealth ( $indexName )

protected

Get index health TODO: Remove this code in the future as we drop support for older versions of the Elastica extension.

Parameters

string $indexName

Returns: array the index health status

Definition at line 508 of file ElasticSearchTTMServer.php.

◆ getReplicaCount()

ElasticSearchTTMServer::getReplicaCount ( )

protected

Definition at line 496 of file ElasticSearchTTMServer.php.

◆ getShardCount()

ElasticSearchTTMServer::getShardCount ( )

protected

Definition at line 492 of file ElasticSearchTTMServer.php.

◆ getTotalHits()

ElasticSearchTTMServer::getTotalHits ( $resultset )

@inheritDoc

Implements MediaWiki\Extension\Translate\TtmServer\SearchableTtmServer.

Definition at line 757 of file ElasticSearchTTMServer.php.

◆ isLocalSuggestion()

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 63 of file ElasticSearchTTMServer.php.

◆ logOutput()

ElasticSearchTTMServer::logOutput ( $text )

protected

Definition at line 570 of file ElasticSearchTTMServer.php.

◆ parseQueryString()

ElasticSearchTTMServer::parseQueryString	(		$queryString,
		array	$opts )

protected

Parse query string and build the search query.

Parameters

string	$queryString
array	$opts

Returns: array

Definition at line 586 of file ElasticSearchTTMServer.php.

◆ query()

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:

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

Implements MediaWiki\Extension\Translate\TtmServer\ReadableTtmServer.

Definition at line 71 of file ElasticSearchTTMServer.php.

◆ search()

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

Search interface.

Parameters

string	$queryString
array	$opts
array	$highlight

Exceptions

TTMServerException

Returns: ResultSet

Definition at line 726 of file ElasticSearchTTMServer.php.

◆ setDoReIndex()

ElasticSearchTTMServer::setDoReIndex ( )

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

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 576 of file ElasticSearchTTMServer.php.

◆ setLogger()

ElasticSearchTTMServer::setLogger ( $logger )

Definition at line 565 of file ElasticSearchTTMServer.php.

◆ update()

ElasticSearchTTMServer::update	(	MessageHandle	$handle,
		?string	$targetText )

Shovels the new translation into translation memory.

Use this for single updates (=after message edit). If no text is provided, entry will be removed from the translation memory.

Parameters

MessageHandle	$handle
string \| null	$targetText	Use null to only delete.

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 232 of file ElasticSearchTTMServer.php.

◆ useWikimediaExtraPlugin()

ElasticSearchTTMServer::useWikimediaExtraPlugin ( )

Returns: true if the backend is configured with the wikimedia extra plugin

Definition at line 478 of file ElasticSearchTTMServer.php.

◆ waitForGreen()

ElasticSearchTTMServer::waitForGreen	(		$indexName,
			$timeout )

protected

Wait for the index to go green.

NOTE: This method has been copied and adjusted from CirrusSearch/includes/Maintenance/ConfigUtils.php. Ideally we'd like to make these utility methods available in the Elastica extension, but this one requires some refactoring in cirrus first. TODO: Remove this code in the future as we drop support for older versions of the Elastica extension.

Parameters

string	$indexName
int	$timeout

Returns: bool true if the index is green false otherwise.

Definition at line 531 of file ElasticSearchTTMServer.php.

◆ waitUntilReady()

ElasticSearchTTMServer::waitUntilReady ( )

protected

Definition at line 550 of file ElasticSearchTTMServer.php.

Member Data Documentation

◆ $client

ElasticSearchTTMServer::$client

protected

Definition at line 53 of file ElasticSearchTTMServer.php.

◆ $logger

ElasticSearchTTMServer::$logger

protected

Reference to the maintenance script to relay logging output.

Definition at line 57 of file ElasticSearchTTMServer.php.

◆ $updateMapping

ElasticSearchTTMServer::$updateMapping = false

protected

Used for Reindex.

Definition at line 61 of file ElasticSearchTTMServer.php.

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

ttmserver/ElasticSearchTTMServer.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ batchInsertDefinitions()

◆ batchInsertTranslations()

◆ beginBatch()

◆ beginBootstrap()

◆ createDocument()

◆ createIndex()

◆ createSearch()

◆ doQuery()

◆ endBatch()

◆ endBootstrap()

◆ expandLocation()

◆ getClient()

◆ getDocuments()

◆ getFacets()

◆ getIndex()

◆ getIndexHealth()

◆ getReplicaCount()

◆ getShardCount()

◆ getTotalHits()

◆ isLocalSuggestion()

◆ logOutput()

◆ parseQueryString()

◆ query()

◆ search()

◆ setDoReIndex()

◆ setLogger()

◆ update()

◆ useWikimediaExtraPlugin()

◆ waitForGreen()

◆ waitUntilReady()

Member Data Documentation

◆ $client

◆ $logger

◆ $updateMapping