Collator::getLocale
collator_get_locale
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Collator::getLocale -- collator_get_locale — Get the locale name of the collator
Description
Object oriented style
string
Collator::getLocale
([ int $type
] )
Procedural style
Get collector locale name.
Parameters
- coll
-
Collator object.
- type
-
You can choose between valid and actual locale ( Locale::VALID_LOCALE and Locale::ACTUAL_LOCALE, respectively). The default is the actual locale.
Return Values
Real locale name from which the collation data comes. If the collator was instantiated from rules or an error occurred, returns boolean FALSE.
Examples
Example #1 collator_get_locale() example
<?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 );
?>
The above example will output:
Requested locale name: en_US_California Valid locale name: en_US Actual locale name: en