Programmer's Reference Guide

翻訳アダプタの使用法

次は、アダプタをコード内で使用する方法です。

例1 単一言語の PHP コードの例

print "Example\n";
print "=======\n";
print "Here is line one\n";
print "Today is the " . date("d.m.Y") . "\n";
print "\n";
print "Here is line two\n";

上の例の出力は、翻訳に対応していません。おそらく実際はあなたの母国語でコードを書くでしょう。翻訳しなければならないのは、普通は出力内容だけではありません。たとえばエラーメッセージやログメッセージなども対象となります。

次のステップは、既存のコードに Zend Translate を組み込むことです。もちろん、あとからコードを変更するよりも最初から翻訳を意識したコードを書くほうがずっと簡単です。

例2 多言語対応の PHP コードの例

$translate = new Zend_Translate(
    array(
        'adapter' => 'gettext',
        'content' => '/my/path/source-de.mo',
        'locale'  => 'de'
    )
);
$translate->addTranslation(
    array(
        'content' => '/path/to/translation/fr-source.mo',
        'locale'  => 'fr'
    )
);
 
print $translate->_("Example") . "\n";
print "=======\n";
print $translate->_("Here is line one") . "\n";
printf($translate->_("Today is the %1\$s") . "\n", date('d.m.Y'));
print "\n";
 
$translate->setLocale('fr');
print $translate->_("Here is line two") . "\n";

では、何が起こっているのか、そしてどうやって Zend_Translate をコードに組み込むのかについてもうすこし詳しく見ていきましょう。

新しい Zend_Translate オブジェクトを作成し、もととなるアダプタを定義します。

$translate = new Zend_Translate(
    array(
        'adapter' => 'gettext',
        'content' => '/path/to/translation/source-de.mo',
        'locale'  => 'de'
    )
);

この例では、 Gettext アダプタ を使うことにしました。 source-de.mo というファイルを /path/to/translation に置いています。この gettext ファイルにはドイツ語の翻訳が含まれています。また、その後で別途フランス語のファイルも追加しています。

次に行うのは、翻訳対象の文字列をすべてラップすることです。一番シンプルな手法は、このように文字列や文章を囲むことです。

print $translate->_("Example") . "\n";
print "=======\n";
print $translate->_("Here is line one") . "\n";

中には翻訳する必要のない文字列もあるでしょう。区切り線などは、たとえ言語が何であっても同じです。

データの値を翻訳文字列に組み込むこともできます。この場合は埋め込みパラメータを使用します。

printf($translate->_("Today is the %1\$s") . "\n", date("d.m.Y"));

print() の代わりに printf() 関数を使用し、すべてのパラメータを %1\$s のように置き換えます。最初のパラメータが %1\$s、その次が %2\$s、といったようになります。これにより、実際の値を知らなくても翻訳を進めることができます。今回の例では、日付は常に今日の日付になります。しかし、文字列を翻訳する際には、実際の日付が何であるかを知る必要はありません。

各文字列は、メッセージ ID によって識別します。文字列の代わりに、コード内でメッセージ ID を指定することもできます。その場合は、このようになります。

print $translate->_(1) . "\n";
print "=======\n";
print $translate->_(2) . "\n";

しかし、この方法にはいくつか欠点があります。

コードを見ただけでは、そこでどんな内容が出力されるのかがわかりません。

また、文字列の一部が翻訳されていない場合にも問題が起こるでしょう。翻訳の動作原理について考えてみましょう。まず Zend_Translate は、指定した ID あるいは文字列に対応する翻訳がその言語に存在するかどうかを探します。翻訳文字列が見つからない場合は、Zend_Locale で定義されているその次の言語の翻訳を探します。つまり "de_AT" の場合は "de" のみで探します。 "de" の翻訳も見つからない場合は、もとのメッセージをそのまま返します。このようにして、たとえ翻訳文字列がなくても何らかの出力を得ることになっています。 Zend_Translate は、文字列の翻訳の際にエラーや例外を発生させることはありません。

翻訳ソースの構造

次に行うのは、翻訳したい言語用の翻訳ソースを作成することです。それぞれのアダプタには個別の方法があるので、それをここで説明します。その前に、すべてのアダプタに共通する一般的な事項について説明しておきます。

どこに翻訳ソースファイルを保存すべきなのかを知っておきましょう。 Zend_Translate では特に制限はありませんが、以下のような構造を推奨します。

単一構造のソース
1. /application/
2. /languages/
3. /languages/lang.en
4. /languages/lang.de
5. /library/
利点: すべての言語のソースファイルを同じディレクトリに配置できます。関連するファイルを分割する必要がありません。
言語ごとに分けた構造
1. /application/
2. /languages/
3. /languages/en/
4. /languages/en/first.en
5. /languages/en/second.en
6. /languages/de/
7. /languages/de/first.de
8. /languages/de/second.de
9. /library
利点: すべての言語がひとつのディレクトリにまとめられます。各言語のチームは、ひとつのディレクトリを翻訳するだけですみます。また、複数のファイルを透過的に使用できます。
アプリケーションごとに分けた構造
1. /application/
2. /application/languages/
3. /application/languages/first.en
4. /application/languages/first.de
5. /application/languages/second.en
6. /application/languages/second.de
7. /library/
利点: すべての言語のソースファイルを同じディレクトリに配置できます。関連するファイルを分割する必要がありません。

欠点: 同じ言語で複数のファイルを使用する場合に問題が発生します。
Gettext 形式の構造
1. /application/
2. /languages/
3. /languages/de/
4. /languages/de/LC_MESSAGES/
5. /languages/de/LC_MESSAGES/first.mo
6. /languages/de/LC_MESSAGES/second.mo
7. /languages/en/
8. /languages/en/LC_MESSAGES/
9. /languages/en/LC_MESSAGES/first.mo
10. /languages/en/LC_MESSAGES/second.mo
11. /library/
利点: 以前から使っている gettext 形式のソースを、そのままの形式で使用できます。

欠点: これまでに gettext を使ったことがない人たちにとって、サブディレクトリの中にまたサブディレクトリという構造は不可解でしょう。
ファイル構造のソース
1. /application/
2. /application/models/
3. /application/models/MyModel.php
4. /application/models/MyModel.de
5. /application/models/MyModel.en
6. /application/controllers/
7. /application/controllers/MyController.php
8. /application/controllers/MyController.de
9. /application/controllers/MyController.en
10. /library/
利点: すべてのファイルについて、翻訳ソースを関連付けられます。

欠点: 小さな翻訳ファイルがあちこちに散らばってしまうので、翻訳が面倒です。また、すべてのファイルに対して翻訳ソースを追加する必要があります。

Zend_Translate で最も便利なのは、単一構造か言語ごとに分けた構造でしょう。

さあ、これでどんな構造でいくかが決まりました。次に翻訳ソースファイルを作っていきましょう。

Zend_Translate のアダプタ

Zend_Translate
プログラマ向けリファレンスガイド

ソースファイルの作成

Comments

Posted by: melkorm on: 2010-06-18 13:38:54 ⁋

it's not:



printf($translate->_("Today is the %1\$s") . "\n", date('d.m.Y'));

but :



printf($translate->_("Today is the %1$s") . "\n", date('d.m.Y'));

Posted by: Simon on: 2010-08-27 03:13:14 ⁋

I would like to point out a use case:



$this->translate->_($vartext);

This is possible. It will not be properly scanned by gettext, poedit, or whatever else. However, if the text in $vartext is contained in a translation source, it will be translated. Therefore in order to do this, you may need to declare a bunch of


_('text');

statements in an unused "reference" file. If you are using array, CSV, or ini, that is not necessary.

I've tested this with gettext sources, and it works. I've not tested with others.

This is useful when... well it should be more than obvious why. For me it was because the page was completely dynamic - the text was being read from a DB. I do not want to maintain so many tables of translations.

HTH

Posted by: nevvermind1 on: 2011-05-26 10:45:26 ⁋

@Simon - thanks for the tip. I wondered how this could be done and your post gives a good start. But, in heaven's name, could you be more specific? What do you mean by "the text in $vartext is contained in a translation source"? How do you actually associate $var with a source?

Posted by: Eduardo on: 2011-07-15 15:08:18 ⁋

In this case

$this->translate->_($vartext);

I do prefer using it in other way. something like:

if ( $x==1)
$vartext = $this->translate->_("MSG1");
else
$vartext = $this->translate->_("MSG2");

print( $vartext );

This way it will be properly scanned by gettext, poedit, or whatever else.