COLLATOR_GET_LOCALE(3) 1 COLLATOR_GET_LOCALE(3)
Collator::getLocale - Get the locale name of the collator
Object oriented style
SYNOPSIS
public string Collator::getLocale (int $type)
DESCRIPTION
Procedural style
string collator_get_locale (Collator $coll, int $type)
Get collector locale name.
PARAMETERS
o $coll
-Collator object.
o $type
- You can choose between valid and actual locale ( Locale::VALID_LOCALE and Locale::ACTUAL_LOCALE, respectively).
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(3) 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
Actual locale name: %s
",
$res_val, $res_act );
?>
The above example will output:
Requested locale name: en_US_California
Valid locale name: en_US
Actual locale name: en
SEE ALSO
collator_create(3).
PHP Documentation Group COLLATOR_GET_LOCALE(3)
