TTMServer backed based on ElasticSearch. More...
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) | |
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 () | |
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 | onDelete (WikiPage $wikipage) |
Hook: ArticleDeleteComplete. | |
static | onChange (MessageHandle $handle) |
Called from TranslateEditAddons::onSave. | |
static | onGroupChange (MessageHandle $handle, $old) |
TTMServer backed based on ElasticSearch.
Depends on Elastica.
Definition at line 38 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::batchInsertDefinitions | ( | array | $batch | ) |
array[] | $batch | @phan-param array<int,array{0:MessageHandle,1:string,2:string}> $batch |
Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.
Definition at line 429 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::batchInsertTranslations | ( | array | $batch | ) |
Called multiple times per batch if necessary.
Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.
Definition at line 439 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::beginBatch | ( | ) |
Called before every batch (MessageGroup).
Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.
Definition at line 422 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::beginBootstrap | ( | ) |
Begin the bootstrap process.
RuntimeException |
Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.
Definition at line 360 of file ElasticSearchTTMServer.php.
|
protected |
MessageHandle | $handle | |
string | $text | |
int | $revId |
Definition at line 298 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::createIndex | ( | $rebuild | ) |
Create index.
bool | $rebuild | Deletes index first if already exists |
Definition at line 321 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::createSearch | ( | $queryString, | |
$opts, | |||
$highlight ) |
Search interface.
string | $queryString | |
array | $opts | |
array | $highlight |
Definition at line 612 of file ElasticSearchTTMServer.php.
|
protected |
Definition at line 83 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::endBatch | ( | ) |
Called after every batch (MessageGroup).
Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.
Definition at line 460 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::endBootstrap | ( | ) |
Do any cleanup, optimizing etc.
Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.
Definition at line 463 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::expandLocation | ( | array | $suggestion | ) |
Given suggestion returned by this TTMServer, constructs fully qualified URL to the location of the translation.
Implements MediaWiki\Extension\Translate\TtmServer\ReadableTtmServer.
Definition at line 71 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::getClient | ( | ) |
Definition at line 470 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::getDocuments | ( | $resultset | ) |
@inheritDoc
Implements MediaWiki\Extension\Translate\TtmServer\SearchableTtmServer.
Definition at line 717 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::getFacets | ( | $resultset | ) |
@inheritDoc
Implements MediaWiki\Extension\Translate\TtmServer\SearchableTtmServer.
Definition at line 691 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::getIndex | ( | ) |
Definition at line 491 of file ElasticSearchTTMServer.php.
|
protected |
Definition at line 500 of file ElasticSearchTTMServer.php.
|
protected |
Definition at line 496 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::getTotalHits | ( | $resultset | ) |
@inheritDoc
Implements MediaWiki\Extension\Translate\TtmServer\SearchableTtmServer.
Definition at line 711 of file ElasticSearchTTMServer.php.
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 67 of file ElasticSearchTTMServer.php.
|
protected |
Definition at line 524 of file ElasticSearchTTMServer.php.
|
protected |
Parse query string and build the search query.
string | $queryString | |
array | $opts |
Definition at line 540 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::query | ( | string | $sourceLanguage, |
string | $targetLanguage, | ||
string | $text ) |
Fetches all relevant suggestions for given text.
string | $sourceLanguage | language code for the provide text |
string | $targetLanguage | language code for the suggestions |
string | $text | the text for which to search suggestions |
Implements MediaWiki\Extension\Translate\TtmServer\ReadableTtmServer.
Definition at line 75 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::search | ( | $queryString, | |
$opts, | |||
$highlight ) |
Search interface.
string | $queryString | |
array | $opts | |
array | $highlight |
TtmServerException |
Definition at line 680 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::setDoReIndex | ( | ) |
Instruct the service to fully wipe the index and start from scratch.
Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.
Definition at line 530 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::setLogger | ( | $logger | ) |
Definition at line 519 of file ElasticSearchTTMServer.php.
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.
MessageHandle | $handle | |
string | null | $targetText | Use null to only delete. |
Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.
Definition at line 236 of file ElasticSearchTTMServer.php.
ElasticSearchTTMServer::useWikimediaExtraPlugin | ( | ) |
Definition at line 482 of file ElasticSearchTTMServer.php.
|
protected |
Definition at line 504 of file ElasticSearchTTMServer.php.
|
protected |
Definition at line 57 of file ElasticSearchTTMServer.php.
|
protected |
Reference to the maintenance script to relay logging output.
Definition at line 61 of file ElasticSearchTTMServer.php.
|
protected |
Used for Reindex.
Definition at line 65 of file ElasticSearchTTMServer.php.