Translation Jobs in Translation Management Tool 8

Same name and namespace in other branches

1. 7 tmgmt.api.php \tmgmt_job

A single task to translate something into a given language using a translator.

Attached to these jobs are job items, which specify which sources are to be translated.

To create a new translation job, first create a job and then assign items to each. Each item needs to specify the source plugin that should be used and the type and id, which the source plugin then uses to identify it later on.

$job = tmgmt_job_create('en', $target_language);
for ($i = 1; $i < 3; $i++) {
  $job
    ->addItem('test_source', 'test', $i);
}

Once a job has been created, it can be assigned to a translator plugin, which is the service that is going to do the translation.

$job->translator = 'test_translator';

// Translator specific settings.
$job->settings = array(
  'priority' => 5,
);
$job
  ->save();

// Get the translator plugin and request a translation.
if ($job
  ->isTranslatable()) {
  $job
    ->requestTranslation();
}

The translation plugin will then request the text from the source plugin. Depending on the plugin, the text might be sent to an external service or assign it to a local user or team of users. At some point, a translation will be returned and saved in the job items.

The translation can now be reviewed, accepted and the source plugins be told to save the translation.

$job
  ->accepted('Optional message');

File

./tmgmt.api.php, line 72

Hooks provided by the Translation Management module.

Functions

Constants

Classes

Interfaces