MediaWiki\Extension\Translate\TtmServer\WritableTtmServer Interface Reference

Interface for TTMServer that can be updated. More...

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

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.
	getMirrors ()
	Get the list of services to duplicate writes to make them "mirrors" of this service.
	setDoReIndex ()
	Instruct the service to fully wipe the index and start from scratch.

Detailed Description

Interface for TTMServer that can be updated.

Definition at line 12 of file WritableTtmServer.php.

Member Function Documentation

batchInsertDefinitions()

MediaWiki\Extension\Translate\TtmServer\WritableTtmServer::batchInsertDefinitions

(

array

$batch

)

Called multiple times per batch if necessary.

Implemented in MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer, MediaWiki\Extension\Translate\TtmServer\FakeWritableTtmServer, ElasticSearchTTMServer, and FakeTTMServer.

batchInsertTranslations()

MediaWiki\Extension\Translate\TtmServer\WritableTtmServer::batchInsertTranslations

(

array

$batch

)

Called multiple times per batch if necessary.

Implemented in MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer, MediaWiki\Extension\Translate\TtmServer\FakeWritableTtmServer, ElasticSearchTTMServer, and FakeTTMServer.

beginBatch()

MediaWiki\Extension\Translate\TtmServer\WritableTtmServer::beginBatch

(

)

Called before every batch (MessageGroup).

Implemented in MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer, MediaWiki\Extension\Translate\TtmServer\FakeWritableTtmServer, ElasticSearchTTMServer, and FakeTTMServer.

beginBootstrap()

MediaWiki\Extension\Translate\TtmServer\WritableTtmServer::beginBootstrap

(

)

Called when starting to fill the translation memory.

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

Implemented in MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer, MediaWiki\Extension\Translate\TtmServer\FakeWritableTtmServer, ElasticSearchTTMServer, and FakeTTMServer.

endBatch()

MediaWiki\Extension\Translate\TtmServer\WritableTtmServer::endBatch

(

)

Called after every batch (MessageGroup).

Implemented in MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer, MediaWiki\Extension\Translate\TtmServer\FakeWritableTtmServer, ElasticSearchTTMServer, and FakeTTMServer.

endBootstrap()

MediaWiki\Extension\Translate\TtmServer\WritableTtmServer::endBootstrap

(

)

Do any cleanup, optimizing etc.

Implemented in MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer, MediaWiki\Extension\Translate\TtmServer\FakeWritableTtmServer, ElasticSearchTTMServer, and FakeTTMServer.

getMirrors()

MediaWiki\Extension\Translate\TtmServer\WritableTtmServer::getMirrors

(

)

Get the list of services to duplicate writes to make them "mirrors" of this service.

Returns

string[]

Implemented in MediaWiki\Extension\Translate\TtmServer\FakeWritableTtmServer, and FakeTTMServer.

setDoReIndex()

MediaWiki\Extension\Translate\TtmServer\WritableTtmServer::setDoReIndex

(

)

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

Implemented in MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer, MediaWiki\Extension\Translate\TtmServer\FakeWritableTtmServer, ElasticSearchTTMServer, and FakeTTMServer.

update()

MediaWiki\Extension\Translate\TtmServer\WritableTtmServer::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.

Implemented in MediaWiki\Extension\Translate\TtmServer\DatabaseTtmServer, MediaWiki\Extension\Translate\TtmServer\FakeWritableTtmServer, ElasticSearchTTMServer, and FakeTTMServer.

---

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

• src/TtmServer/WritableTtmServer.php