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

Translation aid that provides an url where users can ask for help. More...

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

Public Member Functions
	getData ()
	Translation aid class should implement this function.
Public Member Functions inherited from MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid
	__construct (MessageGroup $group, MessageHandle $handle, IContextSource $context, TranslationAidDataProvider $dataProvider)

Static Public Member Functions
static	getSupportUrl (MessageHandle $handle)
	Target URL for a link provided by a support button/aid.
Static Public Member Functions inherited from MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid
static	getTypes ()
	List of available message types mapped to the classes implementing them.

Additional Inherited Members
Protected Attributes inherited from MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid
	$group
	$handle
	$context
	$dataProvider

Detailed Description

Translation aid that provides an url where users can ask for help.

Author

Niklas Laxström @license GPL-2.0-or-later

Since

2013-01-02

Definition at line 18 of file SupportAid.php.

Member Function Documentation

getData()

MediaWiki\Extension\Translate\TranslatorInterface\Aid\SupportAid::getData

(

)

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 from MediaWiki\Extension\Translate\TranslatorInterface\Aid\TranslationAid.

Definition at line 19 of file SupportAid.php.

getSupportUrl()

static MediaWiki\Extension\Translate\TranslatorInterface\Aid\SupportAid::getSupportUrl ( MessageHandle $handle )

static

Target URL for a link provided by a support button/aid.

Parameters

MessageHandle

$handle

MessageHandle object for the translation message.

Returns

string

Exceptions

TranslationHelperException

Definition at line 31 of file SupportAid.php.

---

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

• src/TranslatorInterface/Aid/SupportAid.php