オブジェクトのクローンを作成し、 ロケールオブジェクトを正確かつ効率的に複製できます。 ロケール対応のメソッドのほとんどは、$locale->toString() が返す文字列表現のロケールを受け付けます。

$locale = new Zend_Locale('ar');

// $locale オブジェクトをシリアライズして保存します
$serializedLocale = $locale->serialize();
// もとのオブジェクトを再度作成します
$localeObject = unserialize($serializedLocale);

// ロケールの文字列表記を取得します
$stringLocale = $locale->toString();

// $local オブジェクトの複製を作成します
$copiedLocale = clone $locale;

print "copied: ", $copiedLocale->toString();

// PHP は、__toString() 経由で自動的に toString() をコールします
print "copied: ", $copiedLocale;

Zend_Locale は、 二つのロケールを比較するための便利な関数も提供しています。 ロケール対応のクラスはすべて、これと同等の同一性チェック機能を提供しなければなりません。

$locale = new Zend_Locale();
$mylocale = new Zend_Locale('en_US');

// ロケールが同一かどうかを調べます
if ($locale->equals($mylocale)) {
    print "これらのロケールは同一です";
}

getDefault() メソッドは、関連するロケールの配列を返します。 これは、ユーザのウェブブラウザからの情報 (取得できる場合)、 ホストサーバの環境変数および Zend Framework の設定をもとに取得します。 Zend_Locale のコンストラクタの最初のパラメータで、 (BROWSER、ENVIRONMENT あるいは FRAMEWORK のうちの) どの情報を優先するかを選択します。 二番目のパラメータでは、マッチしたロケールをすべて返すのか あるいは最初にマッチした/一番マッチしたものを返すのかを指定します。 ロケール対応のコンポーネントは、通常は最初のロケールのみを使用します。 優先度が指定されている場合は、それも考慮します。

$locale = new Zend_Locale();

// すべてのデフォルトロケールを返します
$found = $locale->getDefault();
print_r($found);

// ブラウザのロケールのみを返します
$found2 = $locale->getDefault(Zend_Locale::BROWSER,TRUE);
print_r($found2);

BROWSER、ENVIRONMENT あるいは FRAMEWORK のいずれかに対応するデフォルトロケールを取得するには、 それぞれ対応するメソッドを使用します。

新しいロケールを設定するには、関数 setLocale() を使用します。この関数は、ロケール文字列をパラメータとして受け取ります。 ロケールを省略した場合は、ロケールが 自動的に選択 されます。

$locale = new Zend_Locale();

// 実際のロケール
print $locale->toString();

// 新しいロケール
$locale->setLocale('aa_DJ');
print $locale->toString();

getLanguage() を使用して、二文字の言語コード文字列を ロケール識別文字列から取得します。また、 getRegion() を使用して、二文字の地域コード文字列を ロケール識別文字列から取得します。

$locale = new Zend_Locale();

// ロケールが 'ja_JP' の場合は、'ja' が言語として返されます
print $locale->getLanguage();

// ロケールが 'ja_JP' の場合は、地域として 'JP' が返されます
print $locale->getRegion();

When you only have the territory or country then it's also possible to get a locale from that information. You can manually search if there is a locale for this territory by using getLocaleToTerritory(). This method returns a locale for the given territory or NULL when there was has no locale been found.

$locale = Zend_Locale::getLocaleToTerritory('US');
// returns 'en_US'

getTranslationList() を使用すると、地域化された情報を利用できます。 これらの情報は、各地域に特化したデータを顧客に対して提供する際に 翻訳の必要がなくなるので便利です。 これらはすでに使用可能となっています。

情報の一覧は、常に連想配列形式で返されます。 複数の値を明示的な型に渡したい場合は、複数の値ではなく配列を渡す必要があります。

$list = Zend_Locale::getTranslationList('language', 'de_AT');

print_r ($list);
// キーと値の組み合わせの例...
// [de] -> Deutsch
// [en] -> Englisch

// これらのキーのいずれかを getTranslation() メソッドで使用します
print Zend_Locale::getTranslation('de', 'language', 'zh');
// これは、言語 'de' を中国語で表した文字列を返します

すべての言語についてこの情報を取得できます。しかし、 言語によってはすべての情報が提供されているわけではないものもあります。 これらの型のいくつかについては、その型に特化した関数を用意して簡単に使用できるようにしています。 詳細はこの一覧を参照ください。

単一の翻訳データがほしい場合は、getTranslation() を使用します。 この関数は常に文字列を返しますが、getTranslationList() メソッドよりも多くの型を使用できます。 また、値についても一点を除いて同じです。 取得したい値について、詳細を指定する必要があります。

詳細な情報は、次の表を参照ください。

以下の例は、さまざまな言語でのものの名前を取得する方法を示すものです。

// すべての国名をドイツ語で表示します
print_r(Zend_Locale::getTranslationList('country', 'de'));

次の例は、ある言語の名前を別の言語でどのようにいうのかを、 二文字の ISO 国コードを知らない場合に調べるものです。

$code2name = Zend_Locale::getLanguageTranslationList('en_US');
$name2code = array_flip($code2name);
$frenchCode = $name2code['French'];
echo Zend_Locale::getLanguageTranslation($frenchCode, 'de_AT');
// 出力は、「フランス語」を表すドイツ語の名前になります

Zend_Locale で使用できるすべての言語の一覧を、それぞれの言語での表記で取得するには、 以下の例をウェブページで使用してみましょう。 同様に getCountryTranslationList() および getCountryTranslation() を使用すると、 あなたのネイティブ言語での地域名と別の言語での地域名の対応表を作成できます。 try .. catch ブロックで、 存在しないロケールを使用した場合の例外を処理するようにしましょう。 すべての言語がすべてのロケールに対応しているわけではありません。 この例では、例外を無視することで、 スクリプトが途中で終わってしまうことを防いでいます。

$list = Zend_Locale::getLanguageTranslationList('auto');

foreach($list as $language => $content) {
    try {
        $output = Zend_Locale::getLanguageTranslation($language, $language);
        if (is_string($output)) {
            print "\n<br>[".$language."] ".$output;
        }
    } catch (Exception $e) {
        continue;
    }
}

プログラム上で、ユーザに "はい" あるいは "いいえ" で答えてもらうことがよくあります。 getQuestion() を使用すると、 ユーザに問い合わせるときに使用する単語あるいは正規表現文字列を含む配列を、 特定の $locale (デフォルトは、そのオブジェクトのロケール) にあわせて返します。 返される配列の中身は次のようになります。

これらのすべての情報は当然地域化されており、 設定されているロケールによって変化します。 以下の例で、どのような情報が取得できるのかを確認してみましょう。

$locale = new Zend_Locale();
// 設問の文字列
print_r($locale->getQuestion('de'));

- - - 出力 - - -

Array
(
    [yes] => ja
    [no] => nein
    [yesarray] => Array
        (
            [0] => ja
            [1] => j
        )

    [noarray] => Array
        (
            [0] => nein
            [1] => n
        )

    [yesexpr] => ^([jJ][aA]?)|([jJ]?)
    [noexpr] => ^([nN]([eE][iI][nN])?)|([nN]?)
)

すべての既知のロケールの一覧を取得したいこともあるでしょう。 たとえば、ロケール選択用の select 要素を作成する場合などに必要となるはずです。 このようなときには、静的メソッド getLocaleList() を使用します。 このメソッドは、すべての既知のロケールの一覧を返します。

$localelist = Zend_Locale::getLocaleList();

指定した入力がロケールかどうかを知りたい場合は、静的メソッド isLocale() を使用します。 このメソッドの最初のパラメータとして、調べたい文字列を指定します。

$input = 'to_RU';
if (Zend_Locale::isLocale($input)) {
    print "'{$input}' is a locale";
} else {
    print "Sorry... the given input is no locale";
}

ごらんのとおり、このメソッドの出力は常に boolean となります。 このメソッドをコールして唯一例外が発生するのは、 システム側でロケールを一切提供しておらず、Zend Framework がロケールを自動検出できなかった場合です。 通常、このような場合は、ご利用の OS 上で PHP の setlocale() がうまく動作しないでしょう。

指定したロケールに地域部が存在しない場合でも、 自動的に地域部をはずして検出してくれることにもお気づきでしょう。 先ほどの例では、言語 'to' は地域 'RU' 内に存在しません。しかし、返される結果は TRUE となります。 Zend_Locale は指定した入力を処理できるからです。

しかし、この自動変換機能がじゃまになることもあるでしょう。そんな場合には isLocale() の 2 番目のパラメータを使用します。 strict パラメータのデフォルトは FALSE で、自動変換を無効にするにはこれを TRUE とします。

$input = 'to_RU';
if (Zend_Locale::isLocale($input, true)) {
    print "'{$input}' is a locale";
} else {
    print "Sorry... the given input is no locale";
}

これで指定した文字列がロケールかどうかを判別できるようになったので、 自作のクラスでロケール対応の処理ができるようになりました。 しかし、すでにお気づきかもしれませんが、毎回のように次のような 15 行のコードを書かなければならないことになってしまいます。

if ($locale === null) {
    $locale = new Zend_Locale();
}

if (!Zend_Locale::isLocale($locale, true, false)) {
    if (!Zend_Locale::isLocale($locale, false, false)) {
        throw new Zend_Locale_Exception(
            "The locale '$locale' is no known locale");
    }

    $locale = new Zend_Locale($locale);
}

if ($locale instanceof Zend_Locale) {
    $locale = $locale->toString();
}

Zend Framework 1.8 で、静的メソッド findLocale() が追加されました。これは、現在使用中のロケール文字列を返します。 このメソッドは、次のような処理を行います。

次の例は、さきほどのコードをたったひとつのメソッドコールで置き換えるものです。

$locale = Zend_Locale::findLocale($inputstring);