Collator::getLocale

collator_get_locale

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)

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

説明

オブジェクト指向型

public Collator::getLocale(int $type): string|false

手続き型

collator_get_locale(Collator $object, int $type): string|false

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

パラメータ

object

Collator オブジェクト。

type

妥当なロケールか実際のロケール (それぞれ Locale::VALID_LOCALE および Locale::ACTUAL_LOCALE)。

戻り値

照合データの実際のロケール名を返します。ルールベースの collator のインスタンスの場合やエラーが発生した場合は 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_val, $res_act );
?>

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

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

参考

関連キーワード: 　collator, 取得, Collator, locale, type, getLocale, US, string, int, インスタンス