revenuewire/translation

RW Translation Service

4.0.2 2023-02-01 18:32 UTC

Requires

• google/cloud: ^0.196
• onehourtranslation/api2: ^1.0
• symfony/yaml: 3.2

Requires (Dev)

• phpunit/phpunit: ^6.5

Apache-2.0

• Scott Wang

README

Install

composer require revenuewire/translation

Description

Translation Services using DyanmoDB or Redis as cache options. We also embedded two translation service providers, One Hour Translation and Google Cloud Translation.

OneHourTranslation provides human translators to translate your project where Google Cloud Translation charges a flat fee for Neural Machine Translation (NMT). Both service providers provide simple machine translation but are not supported for the purpose of this project.

Requirements

Generally, there are two modes (live or db) of configurations you can choose from.

Live Mode

Live mode uses Google Cloud Translation APIs that translate the texts directly to targeted languages. You need a Google Cloud account and key in order to use it. You also need Redis cache for better performance. No memcached support yet.

Requirement Summary

• Google Cloud Account
• Redis

DB Mode

Database mode uses AWS DynamoDB as a storage choice. Redis is suggested but not required.

Requirement Summary

• AWS DynamoDB
• Redis (optional)

Configurations

Live Mode

$defaultLanguage = "en";
$supportLanguages = ["en", "fr", "zh"];
$redisConfig = [
    "host" => "REDIS_HOST",
    "timeout" => "0.5",
    "port" => "6379",
    "prefix" => "t_2sx_", //optional, to prevent cache key collision
];
$gct = [
    "project" => "GOOGLE_CLOUD_PROJECT_ID",
    "key" => "GOOGLE_CLOUD_PROJECT_KEY"
];
$translationService = new \RW\Translation(null, $supportLanguages, $cache, $defaultLanguage, $gct);

//translate to Simple Chinese
echo $translationService->translate("Hello World", "zh");
print_r($translationService->batchTranslate([
   "hello" => "Hello World",
   "how-s-going" => "How's going?"
],"zh"));

DB Mode

Install

php vendor/revenuewire/translation/bin/cli.php \
    --region=[AWS_REGION] \
    --translation=[TRANSLATION_TABLE] \
    --translation_queue=[TRANSLATION_QUEUE_TABLE] \
    --translation_project=[TRANSLATION_PROJECT_TABLE] \
    init 

Usage

$defaultLanguage = "en";
$supportLanguages = ["en", "fr", "zh"];

$dynamoConfig = [
   "region" => "us-west-2",
   "table" => "YOUR TABLE NAME",
   "version" => "2012-08-10"
];

$redisConfig = [
    "host" => "YOUR REDIS HOST",
    "timeout" => "0.5",
    "port" => "6379",
    "prefix" => "t_2sx_", //optional, to prevent cache key collision
];

$translationService = new \RW\Translation($dynamoConfig, $supportLanguages, $cache, $defaultLanguage);

//translate to Simple Chinese
echo $translationService->translate("Hello World", "zh");
print_r($translationService->batchTranslate([
   "hello" => "Hello World",
   "how-s-going" => "How's going?"
],"zh"));

Working with Translation Services

Once you go through all your pages, your translation table should have collected all texts you need to translate.

diff

Calculate the difference between existing texts and targeted translation texts. For example, if your source table have a English word "Hello World", and the following command will generate two queue items that aim to translate "Hello World" to Chinese and French.

php vendor/revenuewire/translation/bin/cli.php \
        --provider=[OTH or GCT] \
        --region=[AWS_REGION] \
        --translation=[TRANSLATION_TABLE] \
        --translation_queue=[TRANSLATION_QUEUE_TABLE] \
        --translation_project=[TRANSLATION_PROJECT_TABLE] \
   	    diff zh fr

add

The add command will add all pending items into projects. This is useful when working with OneHourTranslation which had limits on how many texts you can schedule to translate per batch.

php vendor/revenuewire/translation/bin/cli.php \
        --region=[AWS_REGION] \
        --translation=[TRANSLATION_TABLE] \
        --translation_queue=[TRANSLATION_QUEUE_TABLE] \
        --translation_project=[TRANSLATION_PROJECT_TABLE] \
        --oth_pubkey=[ONE_HOUR_TRANSLATION_PUB_KEY] \
        --oth_secret=[ONE_HOUR_TRANSLATION_SECRET] \
        --oth_sandbox=[ONE_HOUR_TRANSLATION_SANDBOX] \
        --gct_project=[GOOGLE_CLOUD_PROJECT] \
        --gct_key=[GOOGLE_CLOUD_KEY] \
        add 

commit

Commit the projects to service provider. The commit only available for One Hour Translation.

php vendor/revenuewire/translation/bin/cli.php \
        --region=[AWS_REGION] \
        --translation=[TRANSLATION_TABLE] \
        --translation_queue=[TRANSLATION_QUEUE_TABLE] \
        --translation_project=[TRANSLATION_PROJECT_TABLE] \
        --oth_pubkey=[ONE_HOUR_TRANSLATION_PUB_KEY] \
        --oth_secret=[ONE_HOUR_TRANSLATION_SECRET] \
        --oth_sandbox=[ONE_HOUR_TRANSLATION_SANDBOX] \
        commit 

push

Push the translated texts back to translation table.

php vendor/revenuewire/translation/bin/cli.php \
        --region=[AWS_REGION] \
        --translation=[TRANSLATION_TABLE] \
        --translation_queue=[TRANSLATION_QUEUE_TABLE] \
        --translation_project=[TRANSLATION_PROJECT_TABLE] \
   	    push

Languages Support

Most language code parameters conform to ISO-639-1 identifiers, except where noted.

Code	Google Cloud Translation	One Hour Translation	Language	Display	Note
en	en	en-us	English	English
af	af	af	Afrikaans	Afrikaans
ar	ar	ar-sa	Arabic	العربية
bg	bg	bg-bg	Bulgarian	Български
zh	zh	zh-cn-cmn-s	Chinese (Simple)	简体中文
zh-cn	zh-cn	zh-cn-cmn-s	Chinese (Simple)	简体中文	BCP-47
zh-tw	zh-tw	zh-cn-cmn-t	Chinese (Traditional)	繁體中文	BCP-47
hr	hr	hr-hr	Croatian	hrvatski
cs	cs	cs-cz	Czech	český
da	da	da-dk	Danish	dansk
nl	nl	nl-nl	Dutch	Nederlands
fr	fr	fr-fr	French	français
de	de	de-de	German	Deutsch
el	el	el-gr	Greek	ελληνικά
iw	iw	N/A	Hebrew	עברית
hi	hi	hi-in	Hindi	हिन्दी
is	is	is-is	Icelandic	íslenska
id	id	id-id	Indonesian	Bahasa Indonesia
it	it	it-it	Italian	italiano
ja	ja	jp-jp	Japanese	日本語
ko	ko	ko-kp	Korean	한국어
no	no	no-no	Norwegian	Norsk
pl	pl	pl-pl	Polish	polski
pt	pt	pt-pt	Portuguese	português
pt-br	N/A	pt-br	Portuguese (Brazil)	português - Brasil	ISO 639.2
pt-pt	pt	pt-pt	Portuguese (Portugal)	português	ISO 639.2
ro	ro	ro-ro	Romanian	limba română
ru	ru	ru-ru	Russian	Русский
sk	sk	sk-sk	Slovak	slovenčina
es	es	es-es	Spanish	español
sv	sv	sv-se	Swedish	svenska
th	th	th-th	Thai	ภาษาไทย
tr	tr	tr-tr	Turkish	Türkçe
vi	vi	vi-vn	Vietnamese	Tiếng Việt
fi	N/A	fi-fi	Finnish	suomi