MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid Class Reference

Inheritance diagram for MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid:

Public Member Functions
	__construct (MessageGroup $group, MessageHandle $handle, IContextSource $context, TranslationAidDataProvider $dataProvider)
	getData ()
	Translation aid class should implement this function.

Static Public Member Functions
static	getTypes ()
	List of available message types mapped to the classes implementing them.

Protected Attributes
	$group
	$handle
	$context
	$dataProvider

Detailed Description

Definition at line 21 of file TranslationAid.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid::__construct	(	MessageGroup	$group,
		MessageHandle	$handle,
		IContextSource	$context,
		TranslationAidDataProvider	$dataProvider )

Definition at line 31 of file TranslationAid.php.

Member Function Documentation

getData()

MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid::getData ( )

abstract

Translation aid class should implement this function.

Return value should be an array with keys and values. Because these are used in the MediaWiki API, lists (numeric keys) should have key '**' set to element name that describes the list values. For example if the translation aid provides translation suggestions, it would return an array which has key '**' set to 'suggestion' and then list of arrays, each containing fields for the information of the suggestions. See InOtherLanguagesAid for example.

Exceptions

TranslationHelperException

Used to signal unexpected errors to aid debugging

Returns

array

Reimplemented in MediaWiki\Extension\Translate\TranslatorInterface\Aid\CurrentTranslationAid, MediaWiki\Extension\Translate\TranslatorInterface\Aid\DocumentationAid, MediaWiki\Extension\Translate\TranslatorInterface\Aid\EditSummariesAid, MediaWiki\Extension\Translate\TranslatorInterface\Aid\GettextDocumentationAid, MediaWiki\Extension\Translate\TranslatorInterface\Aid\GroupsAid, MediaWiki\Extension\Translate\TranslatorInterface\Aid\InOtherLanguagesAid, MediaWiki\Extension\Translate\TranslatorInterface\Aid\InsertablesAid, MediaWiki\Extension\Translate\TranslatorInterface\Aid\MachineTranslationAid, MediaWiki\Extension\Translate\TranslatorInterface\Aid\MessageDefinitionAid, MediaWiki\Extension\Translate\TranslatorInterface\Aid\SupportAid, MediaWiki\Extension\Translate\TranslatorInterface\Aid\TTMServerAid, MediaWiki\Extension\Translate\TranslatorInterface\Aid\UnsupportedTranslationAid, and MediaWiki\Extension\Translate\TranslatorInterface\Aid\UpdatedDefinitionAid.

getTypes()

static MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid::getTypes ( )

static

List of available message types mapped to the classes implementing them.

Returns

array

Definition at line 64 of file TranslationAid.php.

Member Data Documentation

$context

MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid::$context

protected

Definition at line 27 of file TranslationAid.php.

$dataProvider

MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid::$dataProvider

protected

Definition at line 29 of file TranslationAid.php.

$group

MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid::$group

protected

Definition at line 23 of file TranslationAid.php.

$handle

MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid::$handle

protected

Definition at line 25 of file TranslationAid.php.

---

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

• src/TranslatorInterface/Aid/TranslationAid.php