Property | Type | Description | |
---|---|---|---|
$properties | array | A list of properties that are accessable/writable. |
Method | Description | |
---|---|---|
__construct ( $culture = 'en' ) : return |
Initializes a new instance of the CultureInfo class based on the
culture specified by name. E.g. new CultureInfo('en_AU');
The culture indentifier must be of the form
"language_(country/region/variant)". |
|
__get ( $name ) : mixed | Allow functions that begins with 'set' to be called directly as an attribute/property to retrieve the value. | |
__set ( $name, $value ) | Allow functions that begins with 'set' to be called directly as an attribute/property to set the value. | |
__toString ( ) : string | Display the culture name. | |
getCalendar ( ) : string | Gets the default calendar used by the culture, e.g. "gregorian". | |
getCountries ( ) : array | Get a list of countries in the language of the localized version. | |
getCultures ( $type = CultureInfo::ALL ) : array | Gets the list of supported cultures filtered by the specified culture type. This is an EXPENSIVE function, it needs to traverse a list of ICU files in the data directory. | |
getCurrencies ( ) : array | Get a list of currencies in the language of the localized version. | |
getDateTimeFormat ( ) : |
Gets the DateTimeFormatInfo that defines the culturally appropriate format of displaying dates and times. | |
getEnglishName ( ) : string | Gets the culture name in English. | |
getInstance ( $culture ) : |
Gets the CultureInfo that for this culture string | |
getInvariantCulture ( ) : |
Gets the CultureInfo that is culture-independent (invariant). | |
getIsNeutralCulture ( ) : boolean | Gets a value indicating whether the current CultureInfo represents a neutral culture. Returns true if the culture only contains two characters. | |
getLanguages ( ) : array | Get a list of languages in the language of the localized version. | |
getName ( ) : string |
Gets the culture name in the format
" |
|
getNativeName ( ) : array |
Gets the culture name in the language that the culture is set
to display. Returns array('Language','Country');
'Country' is omitted if the culture is neutral. |
|
getNumberFormat ( ) : |
Gets the NumberFormatInfo that defines the culturally appropriate format of displaying numbers, currency, and percentage. | |
getParent ( ) : |
Gets the CultureInfo that represents the parent culture of the current CultureInfo | |
getScripts ( ) : array | Get a list of scripts in the language of the localized version. | |
getTimeZones ( ) : array | Get a list of timezones in the language of the localized version. | |
setDateTimeFormat ( $dateTimeFormat ) | Set the date time format information. | |
setNumberFormat ( $numberFormat ) | Set the number format information. | |
validCulture ( $culture ) : boolean | Determine if a given culture is valid. Simply checks that the culture data exists. |
Method | Description | |
---|---|---|
dataDir ( ) : string | Get the default directory for the ICU data. | |
fileExt ( ) : string | Get the filename extension for ICU data. Default is ".dat". | |
findInfo ( $path = '/', $merge = false ) : mixed | Find the specific ICU data information from the data. | |
getData ( $filename ) : array | Get the data by unserializing the ICU data from disk. | |
loadCultureData ( $culture ) | Load the ICU culture data for the specific culture identifier. | |
setCulture ( $culture ) |
Set the culture for the current instance. The culture indentifier
must be of the form " |
Method | Description | |
---|---|---|
searchArray ( $info, $path = '/' ) : mixed | Search the array for a specific value using a path separated using slash "/" separated path. e.g to find $info['hello']['world'], the path "hello/world" will return the corresponding value. | |
simplify ( $array ) : array | Simplify a single element array into its own value. |
new CultureInfo('en_AU');
The culture indentifier must be of the form
"language_(country/region/variant)".
public __construct ( $culture = 'en' ) : return
return
return
new CultureInfo.
Allow functions that begins with 'set' to be called directly
as an attribute/property to retrieve the value.
Allow functions that begins with 'set' to be called directly
as an attribute/property to set the value.
public __set ( $name, $value )
Display the culture name.
public __toString ( ) : string
return
string
the culture name.
The default is the "data" directory for this class.
Get the filename extension for ICU data. Default is ".dat".
The path to the specific ICU data is separated with a slash "/".
E.g. To find the default calendar used by the culture, the path
"calendar/default" will return the corresponding default calendar.
Use merge=true to return the ICU including the parent culture.
E.g. The currency data for a variant, say "en_AU" contains one
entry, the currency for AUD, the other currency data are stored
in the "en" data file. Thus to retrieve all the data regarding
currency for "en_AU", you need to use findInfo("Currencies,true);.
Gets the default calendar used by the culture, e.g. "gregorian".
public getCalendar ( ) : string
return
string
the default calendar.
Get a list of countries in the language of the localized version.
public getCountries ( ) : array
return
array
a list of localized country names.
This function can be called statically.
static public getCultures ( $type = CultureInfo::ALL ) : array
return
array
list of culture information available.
Get a list of currencies in the language of the localized version.
public getCurrencies ( ) : array
return
array
a list of localized currencies.
The data files are cached in a static variable inside
this function.
Gets the DateTimeFormatInfo that defines the culturally appropriate
format of displaying dates and times.
public getDateTimeFormat ( ) : DateTimeFormatInfo
return
DateTimeFormatInfo
date time format information for the culture.
Returns array('Language','Country');
'Country' is omitted if the culture is neutral.
public getEnglishName ( ) : string
return
string
language (country), it may locale code string if english name does not exist.
Gets the CultureInfo that for this culture string
public static getInstance ( $culture ) : CultureInfo
return
CultureInfo
invariant culture info is "en".
Any changes to the invariant culture affects all other
instances of the invariant culture.
The invariant culture is assumed to be "en";
static public getInvariantCulture ( ) : CultureInfo
return
CultureInfo
invariant culture info is "en".
Gets a value indicating whether the current CultureInfo
represents a neutral culture. Returns true if the culture
only contains two characters.
public getIsNeutralCulture ( ) : boolean
return
boolean
true if culture is neutral, false otherwise.
Get a list of languages in the language of the localized version.
public getLanguages ( ) : array
return
array
list of localized language names.
Gets the culture name in the format
"_(country/regioncode2)".
Gets the culture name in the language that the culture is set
to display. Returns array('Language','Country');
'Country' is omitted if the culture is neutral.
public getNativeName ( ) : array
return
array
array with language and country as elements, localized.
Gets the NumberFormatInfo that defines the culturally appropriate
format of displaying numbers, currency, and percentage.
public getNumberFormat ( ) : NumberFormatInfo
return
NumberFormatInfo
the number format info for current culture.
Gets the CultureInfo that represents the parent culture of the
current CultureInfo
public getParent ( ) : CultureInfo
return
CultureInfo
parent culture information.
Get a list of scripts in the language of the localized version.
public getScripts ( ) : array
return
array
list of localized script names.
Get a list of timezones in the language of the localized version.
public getTimeZones ( ) : array
return
array
list of localized timezones.
Load the ICU culture data for the specific culture identifier.
protected loadCultureData ( $culture )
Set the culture for the current instance. The culture indentifier
must be of the form "_(country/region)".
protected setCulture ( $culture )
Set the date time format information.
public setDateTimeFormat ( $dateTimeFormat )
Set the number format information.
public setNumberFormat ( $numberFormat )
Determine if a given culture is valid. Simply checks that the
culture data exists.
public static validCulture ( $culture ) : boolean
return
boolean
true if valid, false otherwise.
Property Details
A list of properties that are accessable/writable.
protected array $properties
return
array