You are here

Home » API reference » Translation Management Tool 8 » tmgmt.api.php

Translators in Translation Management Tool 8

Same name and namespace in other branches
  1. 7 tmgmt.api.php \tmgmt_translator

A translator plugin integrates a translation service.

To define a translator, hook_tmgmt_translator_plugin_info() needs to be implemented and a controller class (specified in the info) created.

A translator plugin is then responsible for sending out a translation job and storing the translated texts back into the job and marking it as needs review once it's finished.

TBD.

File

./tmgmt.api.php, line 124
Hooks provided by the Translation Management module.

Functions

Namesort descending Location Description
hook_tmgmt_translator_plugin_info_alter ./tmgmt.api.php Alter information about translator plugins.
tmgmt_translator_auto_create ./tmgmt.module Auto creates a translator from a translator plugin definition.
tmgmt_translator_busy ./tmgmt.module Checks whether a translator with a certain name is busy and therefore can't be modified or deleted. A translator is considered 'busy' if there are jobs attached to it that are in an active state.
tmgmt_translator_labels ./tmgmt.module Returns a list of all available translator labels.
tmgmt_translator_labels_flagged ./tmgmt.module Returns a list of flagged translator labels.
tmgmt_translator_load_available ./tmgmt.module Loads all translators that are available and, if a translation job is given, support translations for that job with its current configuration.

Classes

Namesort descending Location Description
Translator src/Entity/Translator.php Entity class for the tmgmt_translator entity.
TranslatorAccessControlHandler src/Entity/Controller/TranslatorAccessControlHandler.php Access control handler for the translator entity.
TranslatorForm src/Form/TranslatorForm.php Form controller for the translator edit forms.
TranslatorPluginBase src/TranslatorPluginBase.php Default controller class for service plugins.
TranslatorPluginUiBase src/TranslatorPluginUiBase.php Default ui controller class for translator plugins.

Interfaces

Namesort descending Location Description
ContinuousTranslatorInterface src/ContinuousTranslatorInterface.php Interface for continuous translators.
TranslatorInterface src/TranslatorInterface.php Interface for the tmgmt_translator entity.
TranslatorPluginInterface src/TranslatorPluginInterface.php Interface for service plugin controllers.
TranslatorPluginUiInterface src/TranslatorPluginUiInterface.php Interface for translator ui controllers.
TranslatorRejectDataInterface src/TranslatorRejectDataInterface.php Handle reject on data item level.