Lazy translations for queue jobs

[brandonkelly]

Description

Adds a new craft\i18n\Translation class with two static methods:

• prep() – Has same arguments as Craft::t(), but instead of translating the message immediately, it will package the arguments up into a JSON-encoded string prefixed with t9n:.
• translate() – Takes a prepared string from prep() and unpacks it, then translates it for the current application language (which could be different than whatever it was when prep() was called).

All built-in queue jobs are now calling Translation::prep() instead of Craft::t() when defining their descriptions and progress labels, and the built-in queue driver is calling Translation::translate() on job descriptions and progress labels from getJobDetails() and getJobInfo().

The result is that queue messages are now always translated for the current user’s language, rather than whatever language was active at the time the job was queued up, or whatever language the queue runner is using.

Examples

Queuing up a job with a custom description:

use craft\elements\Entry;
use craft\helpers\Queue;
use craft\i18n\Translation;
use craft\queue\jobs\ResaveElements;

Queue::push(new ResaveElements([
    'elementType' => Entry::class,
    'criteria' => ['section' => 'news'],
    'description' => Translation::prep('site', 'Resaving News entries'),
]));

Defining a default description from a job type:

use craft\i18n\Translation;

protected function defaultDescription(): ?string
{
    return Translation::prep('app', 'Resaving {type}', [
        'type' => $this->elementType::pluralLowerDisplayName(),
    ]);
}

Setting the progress:

use craft\i18n\Translation;

$progress = ($step - 1) / $total;
$this->setProgress($queue, $progress, Translation::prep('app', '{step, number} of {total, number}', [
    'step' => $step,
    'total' => $total,
]));

Related issues

• Queue job descriptions not translated #9696

[linear]

DEV-97 Translate queue job descriptions/progress from UI

Will require storing translation categories/mesages/params in an array.

The Yii2 Inspections plugin is going to need to be updated to understand these as well.

[linear]

DEV-97 Translate queue job descriptions/progress from UI

Will require storing translation categories/mesages/params in an array.

The Yii2 Inspections plugin is going to need to be updated to understand these as well.