Translate extension for MediaWiki
 
Loading...
Searching...
No Matches
MediaWiki\Extension\Translate\TtmServer\RemoteTtmServer Class Reference

Class for handling remote TTMServers over MediaWiki API. More...

Inheritance diagram for MediaWiki\Extension\Translate\TtmServer\RemoteTtmServer:
TTMServer MediaWiki\Extension\Translate\TtmServer\ReadableTtmServer

Public Member Functions

 query (string $sourceLanguage, string $targetLanguage, string $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.
 
- Public Member Functions inherited from TTMServer
 __construct (array $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)
 
- Protected Attributes inherited from TTMServer
 $config
 

Detailed Description

Class for handling remote TTMServers over MediaWiki API.

Currently, querying is done in TranslationHelpers, and this class only handles location retrieval.

Author
Niklas Laxström

Definition at line 18 of file RemoteTtmServer.php.

Member Function Documentation

◆ expandLocation()

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

◆ isLocalSuggestion()

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

◆ query()

MediaWiki\Extension\Translate\TtmServer\RemoteTtmServer::query ( string $sourceLanguage,
string $targetLanguage,
string $text )

Fetches all relevant suggestions for given text.

Parameters
string$sourceLanguagelanguage code for the provide text
string$targetLanguagelanguage code for the suggestions
string$textthe 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 19 of file RemoteTtmServer.php.


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