MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer Class Reference

MySQL/MariaDB-based based backend for translation memory. More...

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

Public Member Functions
	update (MessageHandle $handle, ?string $targetText)
	Shovels the new translation into translation memory.
	beginBootstrap ()
	Called when starting to fill the translation memory.
	beginBatch ()
	Called before every batch (MessageGroup).
	batchInsertDefinitions (array $batch)
	Called multiple times per batch if necessary.
	batchInsertTranslations (array $batch)
	Called multiple times per batch if necessary.
	endBatch ()
	Called after every batch (MessageGroup).
	endBootstrap ()
	Do any cleanup, optimizing etc.
	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.
	setDoReIndex ()
	Instruct the service to fully wipe the index and start from scratch.
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.

Protected Member Functions
	filterForFulltext (string $languageCode, string $input)
	Tokenizes the text for fulltext search.

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)
Protected Attributes inherited from TTMServer
	$config

Detailed Description

MySQL/MariaDB-based based backend for translation memory.

Author

Niklas Laxström

Copyright

Copyright © 2012-2013, Niklas Laxström @license GPL-2.0-or-later

Definition at line 22 of file DatabaseTtmServer.php.

Member Function Documentation

batchInsertDefinitions()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::batchInsertDefinitions

(

array

$batch

)

Called multiple times per batch if necessary.

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 154 of file DatabaseTtmServer.php.

batchInsertTranslations()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::batchInsertTranslations

(

array

$batch

)

Called multiple times per batch if necessary.

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 166 of file DatabaseTtmServer.php.

beginBatch()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::beginBatch

(

)

Called before every batch (MessageGroup).

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 150 of file DatabaseTtmServer.php.

beginBootstrap()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::beginBootstrap

(

)

Called when starting to fill the translation memory.

Set up necessary variables and remove old content from the server.

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 136 of file DatabaseTtmServer.php.

endBatch()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::endBatch

(

)

Called after every batch (MessageGroup).

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 185 of file DatabaseTtmServer.php.

endBootstrap()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::endBootstrap

(

)

Do any cleanup, optimizing etc.

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 188 of file DatabaseTtmServer.php.

expandLocation()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::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 200 of file DatabaseTtmServer.php.

filterForFulltext()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::filterForFulltext ( string $languageCode, string $input )

protected

Tokenizes the text for fulltext search.

Tries to find the most useful tokens.

Definition at line 114 of file DatabaseTtmServer.php.

isLocalSuggestion()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::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 196 of file DatabaseTtmServer.php.

query()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::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 204 of file DatabaseTtmServer.php.

setDoReIndex()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::setDoReIndex

(

)

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

Implements MediaWiki\Extension\Translate\TtmServer\WritableTtmServer.

Definition at line 281 of file DatabaseTtmServer.php.

update()

MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer::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 31 of file DatabaseTtmServer.php.

---

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

• src/TtmServer/DatabaseTtmServer.php