The Locale class
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)
Introduction
A "Locale" is an identifier used to get language, culture, or regionally-specific behavior from an API. PHP locales are organized and identified the same way that the CLDR locales used by ICU (and many vendors of Unix-like operating systems, the Mac, Java, and so forth) use. Locales are identified using RFC 4646 language tags (which use hyphen, not underscore) in addition to the more traditional underscore-using identifiers. Unless otherwise noted the functions in this class are tolerant of both formats.
Examples of identifiers include:
- en-US (English, United States)
- zh-Hant-TW (Chinese, Traditional Script, Taiwan)
- fr-CA, fr-FR (French for Canada and France respectively)
The Locale class (and related procedural functions) are used to interact with locale identifiers--to verify that an ID is well-formed, valid, etc. The extensions used by CLDR in UAX #35 (and inherited by ICU) are valid and used wherever they would be in ICU normally.
Locales cannot be instantiated as objects. All of the functions/methods provided are static. Use Locale::getDefault() and Locale::setDefault() to read and write the default locale used by ICU.
The null or empty string obtains the "root" locale. The "root" locale is equivalent to "en_US_POSIX" in CLDR. Language tags (and thus locale identifiers) are case insensitive. There exists a canonicalization function to make case match the specification.
Class synopsis
$languageTag, string $locale, bool $canonicalize = false): ?bool$locale, ?string $displayLocale = null): string|false$locale, ?string $displayLocale = null): string|false$locale, ?string $displayLocale = null): string|false$locale, ?string $displayLocale = null): string|falsePredefined Constants
Locale::DEFAULT_LOCALE
null
Used as locale parameter with the methods of the various locale affected classes, such as NumberFormatter. This constant would make the methods to use default locale.
These constants describe the choice of the locale for the getLocale method of different classes.
Locale::ACTUAL_LOCALE
int
This is locale the data actually comes from.
Locale::VALID_LOCALE
int
This is the most specific locale supported by ICU.
Locale Subtags
These constants define how the Locales are parsed or composed. They should be used as keys in the argument array to locale_compose() and are returned from locale_parse() as keys of the returned associative array.
Locale::LANG_TAG
string
Language subtag
Locale::EXTLANG_TAG
string
Extended language subtag
Locale::SCRIPT_TAG
string
Script subtag
Locale::REGION_TAG
string
Region subtag
Locale::VARIANT_TAG
string
Variant subtag
Locale::GRANDFATHERED_LANG_TAG
string
Grandfathered Language subtag
Locale::PRIVATE_TAG
string
Private subtag
See Also
Changelog
| Version | Description |
|---|---|
| 8.5.0 | Locale methods now throw a ValueError when a locale argument contains null bytes. |
| 8.4.0 | The class constants are now typed. |
Table of Contents
- Locale::acceptFromHttp — Tries to find out best available locale based on HTTP "Accept-Language" header
- Locale::addLikelySubtags — Add likely subtags to a locale
- Locale::canonicalize — Canonicalize the locale string
- Locale::composeLocale — Returns a correctly ordered and delimited locale ID
- Locale::filterMatches — Checks if a language tag filter matches with locale
- Locale::getAllVariants — Gets the variants for the input locale
- Locale::getDefault — Gets the default locale value from the INTL global 'default_locale'
- Locale::getDisplayLanguage — Returns an appropriately localized display name for language of the inputlocale
- Locale::getDisplayName — Returns an appropriately localized display name for the input locale
- Locale::getDisplayRegion — Returns an appropriately localized display name for region of the input locale
- Locale::getDisplayScript — Returns an appropriately localized display name for script of the input locale
- Locale::getDisplayVariant — Returns an appropriately localized display name for variants of the input locale
- Locale::getKeywords — Gets the keywords for the input locale
- Locale::getPrimaryLanguage — Gets the primary language for the input locale
- Locale::getRegion — Gets the region for the input locale
- Locale::getScript — Gets the script for the input locale
- Locale::isRightToLeft — Check whether a locale uses a right-to-left writing system
- Locale::lookup — Searches the language tag list for the best match to the language
- Locale::minimizeSubtags — Remove likely subtags from a locale
- Locale::parseLocale — Returns a key-value array of locale ID subtag elements
- Locale::setDefault — Sets the default runtime locale
来源:PHP Documentation Group · 作者与贡献记录 · CC BY 3.0。离线整理了版式、链接和媒体显示。
