包简介

Yii2 integration for AirBnB Polyglot.js

README 文档

README

Polyglot.js is a tiny and powerful JavaScript i18n library from Airbnb.

This is a yii2-extension that helps integrating polyglot.js into your yii2 application.

Usage

First install extension through composer:

php composer.phar require --prefer-dist devgroup/yii2-polyglot

Create directory where you will place your translation js files. For example, if we our app is based on yii2-app-advanced - create directory common/polyglot.js/.

Now create your js translation files under this directory. Naming format is common/polyglot.js/%LANGUAGE%.js, where %LANGUAGE% is your Yii::$app->language, for example common/polyglot.js/ru-RU.js.

An example of js file contents(:en: version file common/polyglot.js/en-US.js:

polyglot.extend({
  "nav": {
    "hello": "Hello",
    "hello_name": "Hello, %{name}",
    "sidebar": {
      "welcome": "Welcome"
    }
  }
});

And an example for 🇷🇺 version file common/polyglot.js/ru-RU.js:

polyglot.extend({
  "nav": {
    "hello": "Привет",
    "hello_name": "Привет, %{name}",
    "sidebar": {
      "welcome": "Бобро пожаловать"
    }
  }
});

Now add a special yii2 application param PolyglotTranslationPath with your js translation path as value into your config file(ie. common/config/params.php):

<?php
return [
    'adminEmail' => 'admin@example.com',
    'supportEmail' => 'support@example.com',
    'user.passwordResetTokenExpire' => 3600,
    /**
     * This is a path where your js translation files are stored
     * You can use yii2 aliases here(@app, @common, etc.)
     */
    'PolyglotTranslationPath' => '@common/polyglot.js'
];

And the final thing is to register CurrentTranslation inside your layout view or add it as AssetBundle dependency.

For adding CurrentTranslation into your view just add the one line into views/layouts/main.php near your AppAsset::register call:

DevGroup\Polyglot\CurrentTranslation::register($this);

For adding CurrentTranslation as dependency for your AppAssetBundle modify your assets/AppAsset.php:

<?php

namespace frontend\assets;

use yii\web\AssetBundle;

class AppAsset extends AssetBundle
{
    public $sourcePath = '@frontend/assets/dist/';

    public $css = [
        'styles/main.min.css',
    ];
    public $js = [
        'scripts/main.js',
    ];
    public $depends = [
        'yii\web\JqueryAsset',
        'yii\web\YiiAsset',
        'yii\bootstrap\BootstrapAsset',
        'yii\bootstrap\BootstrapPluginAsset',
        /// !!! This is a dependency to CurrentTranslation !!!
        'DevGroup\Polyglot\CurrentTranslation',
    ];
}

That's it. Now on every request you will get:

Polyglot.js will be included in HEAD section of your HTML
Global polyglot variable will be initialized with current locale(Yii::$app->language).
Translation file based on app language will be added dynamically right after <body> tag.

Now you can use Polyglot.js as it is described in official documentation:

polyglot.t("nav.sidebar.welcome");
=> "Бобро пожаловать"

devgroup/yii2-polyglot 适用场景与选型建议

devgroup/yii2-polyglot 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 1.89k 次下载、GitHub Stars 达 3，最近一次更新时间为 2015 年 11 月 24 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「i18n」「translation」「javascript」「internationalisation」「JS」「extension」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 devgroup/yii2-polyglot 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 devgroup/yii2-polyglot 我们能提供哪些服务？

定制开发 / 二次开发

基于 devgroup/yii2-polyglot 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发