Collator::getLocale

collator_get_locale

(No version information available, might be only in CVS)

Collator::getLocale -- collator_get_locale — collator のロケール名を取得する

説明

オブジェクト指向型

string Collator::getLocale ([ integer $type ] )

手続き型

string collator_get_locale ( Collator $coll , integer $type )

collector のロケール名を取得します。

パラメータ

coll: Collator オブジェクト。
type: 妥当なロケールか実際のロケール (それぞれ Locale::VALID_LOCALE および Locale::ACTUAL_LOCALE)。デフォルトは実際のロケールです。

返り値

照合データの実際のロケール名を返します。ルールベースの collator のインスタンスの場合やエラーが発生した場合は boolean FALSE を返します。

例

例1 collator_get_locale() の例


<?php
$coll    = collator_create( 'en_US_California' );
$res_val = collator_get_locale( $coll, Locale::VALID_LOCALE );
$res_act = collator_get_locale( $coll, Locale::ACTUAL_LOCALE );
printf( "Valid locale name: %s\nActual locale name: %s\n",
         $res_req, $res_val, $res_act );
?>

上の例の出力は以下となります。

Requested locale name: en_US_California
Valid locale name: en_US
Actual locale name: en

参考

collator_create()