level51/silverstripe-fluent-autotranslate

Module for auto translation using Google Translate or OpenAI for Silverstripe with Fluent

0.3.1 2024-10-11 00:00 UTC

Requires

• php: >=7.1
• ext-intl: *
• ext-json: *
• silverstripe/framework: ^4 || ^5

MIT

• Level51

• fluent
• silverstripe
• translate
• google translate
• autotranslate
• openai

README

Module for auto translation using Google Cloud Translation for Silverstripe with Fluent.

Content

• Requirements
• Installation
• Setup Google Cloud Translation API
• Setup OpenAI API
• Maintainer
• Disable extension for specific field types

Requirements

• Silverstripe ^4 || ^5
• Fluent >=4
• PHP >= 7.1
• ext-json

Installation

composer require level51/silverstripe-fluent-autotranslate

Setup Google Cloud Translation API

Define the API key for the Google Cloud Translation API like this:

Level51\Autotranslate\AutotranslateFieldExtension:
    translation_provider: 'google' # 'google' or 'openai' (default: google)
    google_cloud_translation_api_key: 'YOUR_API_KEY'

See https://cloud.google.com/translate/docs/setup for setup instructions.

Setup OpenAI API

See https://platform.openai.com/docs/quickstart/create-and-export-an-api-key for setup instructions and how to get an API key.

Define the API key for the OpenAI API like this in your config.yml:

Level51\Autotranslate\AutotranslateFieldExtension:
  translation_provider: 'openai' # 'google' or 'openai' (default: google)
  openai_translation_api_key: 'YOUR_API_KEY'

For Open AI you can specify terms to avoid translation by adding them to the openai_translation_blacklist in the backend admin settings. If you want to use this feature you have to add the BlackListExtension to the SiteConfig class.

SilverStripe\SiteConfig\SiteConfig:
  extensions:
    - Level51\Autotranslate\BlackListExtension

Maintainer

• Level51 [e-mail]

Disable extension for specific field types

Level51\Autotranslate\AutotranslateFieldExtension:
  class_blacklist:
    - SilverStripe\Forms\HTMLEditor\HTMLEditorField