FakeTTMServer Class Reference

NO-OP version of TTMServer when it is disabled. More...

Inheritance diagram for FakeTTMServer:

Public Member Functions
	query ( $sourceLanguage, $targetLanguage, $text)
	Fetches all relevant suggestions for given text.
	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.
	update (MessageHandle $handle, $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 before 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.
	isFrozen ()
	Check if the service is frozen, attempting to write to a frozen service may lead to errors or unexpected behaviors.
	setDoReIndex ()
	Instruct the service to fully wipe the index and start from scratch.

Detailed Description

NO-OP version of TTMServer when it is disabled.

Keeps other code simpler when they can just do TTMServer::primary()->update( ... );

Since

2012-01-28

Definition at line 19 of file FakeTTMServer.php.

Member Function Documentation

batchInsertDefinitions()

FakeTTMServer::batchInsertDefinitions

(

array

$batch

)

Called multiple times per batch if necessary.

Parameters

array

$batch

Implements WritableTTMServer.

Definition at line 41 of file FakeTTMServer.php.

batchInsertTranslations()

FakeTTMServer::batchInsertTranslations

(

array

$batch

)

Called multiple times per batch if necessary.

Parameters

array

$batch

Implements WritableTTMServer.

Definition at line 44 of file FakeTTMServer.php.

beginBatch()

FakeTTMServer::beginBatch

(

)

Called before every batch (MessageGroup).

Implements WritableTTMServer.

Definition at line 38 of file FakeTTMServer.php.

beginBootstrap()

FakeTTMServer::beginBootstrap

(

)

Called when starting to fill the translation memory.

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

Implements WritableTTMServer.

Definition at line 35 of file FakeTTMServer.php.

endBatch()

FakeTTMServer::endBatch

(

)

Called before every batch (MessageGroup).

Implements WritableTTMServer.

Definition at line 47 of file FakeTTMServer.php.

endBootstrap()

FakeTTMServer::endBootstrap

(

)

Do any cleanup, optimizing etc.

Implements WritableTTMServer.

Definition at line 50 of file FakeTTMServer.php.

expandLocation()

FakeTTMServer::expandLocation

(

array

$suggestion

)

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

Parameters

array

$suggestion

Returns

string URL

Implements ReadableTTMServer.

Definition at line 28 of file FakeTTMServer.php.

getMirrors()

FakeTTMServer::getMirrors

(

)

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

Since

2017.04

Returns

string[]

Implements WritableTTMServer.

Definition at line 53 of file FakeTTMServer.php.

isFrozen()

FakeTTMServer::isFrozen

(

)

Check if the service is frozen, attempting to write to a frozen service may lead to errors or unexpected behaviors.

Since

2017.04

Deprecated

since 2022.04

Returns

bool true if the service is frozen

Implements WritableTTMServer.

Definition at line 57 of file FakeTTMServer.php.

isLocalSuggestion()

FakeTTMServer::isLocalSuggestion

(

array

$suggestion

)

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

Parameters

array

$suggestion

Returns

bool

Implements ReadableTTMServer.

Definition at line 24 of file FakeTTMServer.php.

query()

FakeTTMServer::query	(		$sourceLanguage,
			$targetLanguage,
			$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 ReadableTTMServer.

Definition at line 20 of file FakeTTMServer.php.

setDoReIndex()

FakeTTMServer::setDoReIndex

(

)

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

Since

2020.01

Implements WritableTTMServer.

Definition at line 61 of file FakeTTMServer.php.

update()

FakeTTMServer::update	(	MessageHandle	$handle,
			$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 WritableTTMServer.

Definition at line 32 of file FakeTTMServer.php.

---

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

• ttmserver/FakeTTMServer.php