vovan-ve/yii2-i18n-json-export

Export and import i18n JSON messages

v1.0.5 2018-07-27 00:40 UTC

Requires

• php: >=7.0
• yiisoft/yii2: ~2.0.15

MIT

• Vovan-VE

• json
• i18n
• import
• export
• merge
• yii2

README

Imagine your project has multiple parts with its own separate I18N translations. That parts may be for example backend, server side of frontend, and client side of frontend.

Of cause, some parts may share some messages, and you sure to provide the same translations for such shared messages:

// frontend server side
\Yii::t('app/ui', 'Save')

// frontend client side
i18n.t('app/ui', 'Save')

Solution

1. Export all translations from all source parts into single merged file per each language.
2. Translate messages for specific language in a single JSON file.
3. Import it back to update existing translations in source parts.

Installation

Install through composer:

composer require vovan-ve/yii2-i18n-json-export

or add to require section in your composer.json:

"vovan-ve/yii2-i18n-json-export": "~1.0.0"

Usage

Add app configuration like following:

'components' => [
    'i18nJsonExport' => [
        'class' => \VovanVE\Yii2I18nJsonExport\Manager::class,
        // list of source drivers
        'sourceDrivers' => [
            [
                'class' => \VovanVE\Yii2I18nJsonExport\drivers\SubdirCategoryPhpDriver::class,
                'path' => '@app/messages',
                // strip category prefix
                //'categoryPrefix' => 'app/',
            ],
        ],
        'exportDriver' => [
            'class' => \VovanVE\Yii2I18nJsonExport\drivers\FlatCategoryDriver::class,
            'path' => '@app/i18n',
            // turn on to bubble empty translations to top
            //'sortEmptyFirst' => true,
        ],
        // whether to import back in same files
        //'overwrite' => true,
    ],
],

Use component for example from CLI controller:

// @app/commands/I18nDumpController.php:
<?php
namespace app\commands;

use VovanVE\Yii2I18nJsonExport\Manager;
use yii\console\Controller;
use yii\di\Instance;

class I18nDumpController extends Controller
{
    public function actionExport()
    {
        $this->getManager()->export();
    }

    public function actionImport()
    {
        $this->getManager()->import();
    }

    /** @var Manager */
    private $manager;

    /**
     * @return Manager
     */
    private function getManager()
    {
        return $this->manager ?? (
            $this->manager = Instance::ensure('i18nJsonExport', Manager::class)
        );
    }
}

You are ready:

$ cd /project

# assume you has already extracted messages under ./messages/
$ cat ./messages/ru-RU/category/subcategory.php
<?php
return [
    'Test message' => '',
];

# export to outsource
$ ./yii i18n-dump/export

# see the result
$ cat ./i18n/ru-RU.json
{
    "category/subcategory": {
        "Test message": ""
    }
}

# translate it somehow like so
$ cat ./i18n/ru-RU.json
{
    "category/subcategory": {
        "Test message": "Тестовое сообщение"
    }
}

# import back
$ ./yii i18n-dump/import

# see new file
# notice `.new` in the end which is covered by default 'overwrite' => false in Manager
$ cat ./messages/ru-RU/category/subcategory.php.new
<?php
return [
    'Test message' => 'Тестовое сообщение',
];

License

This package is under MIT License