JsTranslationBundle 技术文档

1. 安装指南

1.1 使用 Composer 安装

首先，确保你已经安装了 Composer，然后在项目根目录下运行以下命令来安装 JsTranslationBundle：

composer require willdurand/js-translation-bundle

1.2 启用 Bundle

安装完成后，需要在 config/bundles.php 文件中启用该 Bundle：

return [
    // 其他 bundles
    Bazinga\JsTranslationBundle\BazingaJsTranslationBundle::class => ['all' => true],
];

1.3 配置

在 config/packages/bazinga_js_translation.yaml 文件中添加以下配置：

bazinga_js_translation:
    locale_fallback: 'en'

2. 项目的使用说明

2.1 暴露翻译消息

JsTranslationBundle 的主要功能是将 Symfony 的翻译消息暴露给客户端应用程序。你可以在 Twig 模板中使用以下代码来加载翻译消息：

<script src="{{ asset('bundles/bazingajstranslation/js/translator.min.js') }}"></script>
<script src="{{ path('bazinga_jstranslation_js', { 'domain_name': 'messages' }) }}"></script>

2.2 使用翻译消息

在 JavaScript 中，你可以使用 Translator 对象来获取翻译消息：

Translator.trans('key.of.message');

3. 项目API使用文档

3.1 获取翻译消息

Translator.trans(id, parameters, domain, locale)

• id: 翻译消息的键。
• parameters: 可选参数，用于替换消息中的占位符。
• domain: 可选参数，指定翻译域。
• locale: 可选参数，指定语言环境。

示例：

Translator.trans('hello.world', {}, 'messages', 'en');

3.2 设置语言环境

Translator.setLocale(locale)

• locale: 要设置的语言环境。

示例：

Translator.setLocale('fr');

4. 项目安装方式

4.1 通过 Composer 安装

如前所述，使用 Composer 是安装 JsTranslationBundle 的推荐方式。运行以下命令即可：

composer require willdurand/js-translation-bundle

4.2 手动安装

如果你不想使用 Composer，也可以手动下载并安装该 Bundle。首先，从 GitHub 下载最新版本的 Bundle，然后将其放置在 src/Bazinga/JsTranslationBundle 目录下，并在 config/bundles.php 中启用它。

return [
    // 其他 bundles
    Bazinga\JsTranslationBundle\BazingaJsTranslationBundle::class => ['all' => true],
];

4.3 配置文件

无论使用哪种安装方式，都需要在 config/packages/bazinga_js_translation.yaml 中进行配置，如前所述。

---

通过以上步骤，你可以成功安装并使用 JsTranslationBundle，将 Symfony 的翻译消息暴露给客户端应用程序。