多言語化

概要

初期設定では日本語で表示されますが、英語やその他の言語で表示するための機構が組み込まれています。表示言語は、環境変数でロケールを指定することで切り替えられ、現時点では日本語または英語が利用できます。

言語の切り替え

環境変数でロケールを指定し、言語表示を切り替えることが出来ます。

EC-CUBEのルートディレクトリ直下の.envファイルのECCUBE_LOCALEを設定します。初期状態ではコメントアウトされています。.envファイルで何も設定されていなければ日本語が利用されます。

//.env

#ECCUBE_LOCALE=ja
ECCUBE_LOCALE=en

環境変数設定後、画面をリロードすると、表示言語が切り替わります。 キャッシュの削除を行う必要はありません。

インストール時の言語指定

インストール時に言語指定をするためには、EC-CUBEのルートディレクトリ直下の.env.installにECCUBE_LOCALEを設定します。何も指定しなければ日本語でインストールされます。/src/Eccube/Resource/doctrine/import_csv配下に対象の言語の初期データが存在する場合はそのデータが利用され、マスタデータ等が指定した言語でインストールされます。

//.env.install

ECCUBE_LOCALE=en

現状ではインストール直後は日本語が言語設定として指定されます。インストール後にEC-CUBEのルートディレクトリ直下の.env.installのECCUBE_LOCALEの値を利用したい言語に設定します。

※ 現時点では、データベースに保持されているデータは翻訳されません。 ※ ショップ画面/管理画面ともに表示言語が切り替わります。

メッセージファイル(翻訳ファイル)

メッセージファイルは、src/Eccube/Resouce/locale以下に保存されています。 ECCUBE_LOCALEの値に応じて、

  • messages.xxx.yaml
  • validators.xxx.yaml

のファイルが読み込まれます。

メッセージファイルはハッシュのyamlファイルです。 ハッシュのキーはメッセージのID、値は翻訳された文字列を表します。

#====================================================================================
# 共通
#====================================================================================

common.select: 選択してください
common.select__pref: 都道府県を選択
common.select__unspecified: 指定なし
common.select__all_products: 全ての商品
    ...

trans関数とtransフィルタ

trans関数やtransフィルタを使用することで、翻訳された文字列を表示することができます。 php内で翻訳する場合はtrans関数を、twig内で翻訳する場合はtransフィルタを使用します。

trans関数

trans関数にメッセージIDを指定することで、翻訳された文字列を取得できます。 基本的な使い方は以下のとおりです。

<?php

// 'common.label.add' => '新規作成',

$message = trans('common.label.edit');
var_dump($message);

// 編集

メッセージがパラメータ付きで定義されている場合は、以下のように使用します。

<?php

// 'admin.order.index.paginator_total_count' => '検索結果：%count%件が該当しました',

$message = trans('admin.order.index.paginator_total_count', ['%count%' => 10]);
var_dump($message);

// 検索結果：10件が該当しました

※ FormTypeのラベルやエラーメッセージは自動で翻訳されるため、FormType内でtransする必要はありません。

class TemplateType extends AbstractType
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder

            ...

            ->add('file', FileType::class, array(
                'mapped' => false,
                'required' => true,
                'constraints' => array(
                    // メッセージIDのみ指定する
                    new Assert\NotBlank(array('message' => 'template.text.message.select_file')),
                    new Assert\File(array(
                        'mimeTypes' => array('application/zip', 'application/x-tar', 'application/x-gzip'),
                        'mimeTypesMessage' => 'template.text.message.upload_files',
                    )),
                ),
            ));
    }

transフィルタ

twig内で翻訳する場合は、transフィルタを使用します。 基本的な使い方は以下の通りです。


{{ 'common.label.add'|trans }}

{# 編集 #}

メッセージがパラメータ付きで定義されている場合は、以下のように使用します。


{{ 'admin.order.index.paginator_total_count'|trans({
    '%count%' : 10
}) }}

{# 検索結果：10件が該当しました #}

参考

EC-CUBEの翻訳機構は、SymfonyのTranslationコンポーネントを利用しています。 より詳しく知りたい場合は、Symfonyの公式ドキュメントを参照してみてください。

Translations

更新日時: