diff options
Diffstat (limited to 'ext/intl/doc/locale_api.php')
| -rw-r--r-- | ext/intl/doc/locale_api.php | 142 |
1 files changed, 71 insertions, 71 deletions
diff --git a/ext/intl/doc/locale_api.php b/ext/intl/doc/locale_api.php index c6c41ede0a..4633ac1227 100644 --- a/ext/intl/doc/locale_api.php +++ b/ext/intl/doc/locale_api.php @@ -1,29 +1,29 @@ <?php /** - * A "Locale" is an identifier used to get language, culture, or regionally-specific + * 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 + * 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. + * 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) + * * 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 + * 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 + * Locales cannot be instantiated as objects. All of the functions/methods * provided are static. * - * * The null or empty string obtains the "root" locale. + * * 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. @@ -56,7 +56,7 @@ class Locale { const ACTUAL_LOCALE = 'ULOC_ACTUAL_LOCALE'; const VALID_LOCALE = 'ULOC_VALID_LOCALE'; - /** + /** * Valid locale tag and subtag values */ const LANG_TAG = "language"; @@ -66,7 +66,7 @@ class Locale { const VARIANT_TAG = "variant"; const GRANDFATHERED_LANG_TAG = "grandfathered"; const PRIVATE_TAG = "private"; - + ############################################################################# # Object-oriented API @@ -74,12 +74,12 @@ class Locale { /** * Gets the default locale value from the INTL global 'default_locale' - * At the PHP initilaization (MINIT) this value is set to - * 'intl.default_locale' value from php.ini if that value exists - * or from ICU's function uloc_getDefault() + * At the PHP initilaization (MINIT) this value is set to + * 'intl.default_locale' value from php.ini if that value exists + * or from ICU's function uloc_getDefault() * Then onwards picks up changes from setDefault() calls also * - * @return string the current runtime locale + * @return string the current runtime locale */ public static function getDefault() {} @@ -87,7 +87,7 @@ class Locale { * sets the default runtime locale to $locale * This changes the value of INTL global 'default_locale' * - * @param string $locale is a BCP 47 compliant language tag containing the + * @param string $locale is a BCP 47 compliant language tag containing the * locale identifier. UAX #35 extensions are accepted. * @return boolean 'true' if okay, 'false' if an error */ @@ -98,8 +98,8 @@ class Locale { * Gets the primary language for the input locale * * @param string $locale the locale to extract the primary language code from - * @return string the language code associated with the language - * or null in case of error. + * @return string the language code associated with the language + * or null in case of error. */ public static function getPrimaryLanguage($locale) {} @@ -126,7 +126,7 @@ class Locale { * Gets the variants for the input locale * * @param string $locale the locale to extract the variants from - * @return array the array containing the list of all variants + * @return array the array containing the list of all variants * subtag for the locale or null if not present */ public static function getAllVariants($locale) {} @@ -136,7 +136,7 @@ class Locale { * Gets the keywords for the input locale * * @param string $locale the locale to extract the keywords from - * @return array associative array containing the keyword-value pairs for this locale + * @return array associative array containing the keyword-value pairs for this locale */ public static function getKeywords($locale) {} @@ -146,9 +146,9 @@ class Locale { * * @param string $locale the locale to return a displayname for * @param [string] $in_locale optional format locale - * If is 'null' then the default locale is used. + * If is 'null' then the default locale is used. * @return string display name of the locale in the format - * appropriate for $in_locale. + * appropriate for $in_locale. */ public static function getDisplayName($locale, $in_locale = null) {} @@ -158,9 +158,9 @@ class Locale { * * @param string $locale the locale to return a display language for * @param [string] $in_locale optional format locale to use to display the language name - * If is 'null' then the default locale is used. + * If is 'null' then the default locale is used. * @return string display name of the language for the $locale in the format - * appropriate for $in_locale. + * appropriate for $in_locale. */ public static function getDisplayLanguage($lang, $in_locale = null) {} @@ -169,9 +169,9 @@ class Locale { * * @param string $locale the locale to return a display script for * @param [string] $in_locale optional format locale to use to display the script name - * If is 'null' then the default locale is used. + * If is 'null' then the default locale is used. * @return string display name of the script for the $locale in the format - * appropriate for $in_locale. + * appropriate for $in_locale. */ public static function getDisplayScript($script, $in_locale = null) {} @@ -181,9 +181,9 @@ class Locale { * * @param string $locale the locale to return a display region for * @param [string] $in_locale optional format locale to use to display the region name - * If is 'null' then the default locale is used. + * If is 'null' then the default locale is used. * @return string display name of the region for the $locale in the format - * appropriate for $in_locale. + * appropriate for $in_locale. */ public static function getDisplayRegion($region, $in_locale = null) {} @@ -193,15 +193,15 @@ class Locale { * * @param string $locale the locale to return a display variant for * @param [string] $in_locale optional format locale to use to display the variant name - * If is 'null' then the default locale is used. + * If is 'null' then the default locale is used. * @return string display name of the variant for the $locale in the format - * appropriate for $in_locale. + * appropriate for $in_locale. */ public static function getDisplayVariant($variant, $in_locale = null) {} /** - * Checks if a $langtag filter matches with $locale according to + * Checks if a $langtag filter matches with $locale according to * RFC 4647's basic filtering algorithm * * @param string $langtag the language tag to check @@ -213,24 +213,24 @@ class Locale { /** * Searchs the items in $langtag for the best match to the language - * range specified in $locale according to RFC 4647's lookup algorithm. + * range specified in $locale according to RFC 4647's lookup algorithm. * * @param array $langtag an array containing a list of language tags to compare * to $locale * @param string $locale the locale to use as the language range when matching * @param string $default the locale to use if no match is found - * @return string closest matching language tag, $default, + * @return string closest matching language tag, $default, * or empty string */ public static function lookup(array $langtag, $locale, $default = null) {} /** - * Returns a correctly ordered and delimited locale ID + * Returns a correctly ordered and delimited locale ID * - * @param array $subtags an array containing a list of key-value pairs, where - * the keys identify the particular locale ID subtags, - * and the values are the associated subtag values. + * @param array $subtags an array containing a list of key-value pairs, where + * the keys identify the particular locale ID subtags, + * and the values are the associated subtag values. * * @return string the corresponding locale identifier. */ @@ -240,11 +240,11 @@ class Locale { /** * Returns a key-value array of locale ID subtag elements. * - * @param string $locale the locale to extract the subtag array from + * @param string $locale the locale to extract the subtag array from * - * @return array $subtags an array containing a list of key-value pairs, where - * the keys identify the particular locale ID subtags, - * and the values are the associated subtag values. + * @return array $subtags an array containing a list of key-value pairs, where + * the keys identify the particular locale ID subtags, + * and the values are the associated subtag values. */ public static function parseLocale($locale) {} @@ -257,12 +257,12 @@ class Locale { /** * Gets the default locale value from the INTL global 'default_locale' - * At the PHP initilaization (MINIT) this value is set to - * 'intl.default_locale' value from php.ini if that value exists - * or from ICU's function uloc_getDefault() + * At the PHP initilaization (MINIT) this value is set to + * 'intl.default_locale' value from php.ini if that value exists + * or from ICU's function uloc_getDefault() * Then onwards picks up changes from setDefault() calls also * - * @return string the current runtime locale + * @return string the current runtime locale */ function locale_get_default() {} @@ -270,7 +270,7 @@ class Locale { * sets the default runtime locale to $locale * This changes the value of INTL global 'default_locale' * - * @param string $locale is a BCP 47 compliant language tag containing the + * @param string $locale is a BCP 47 compliant language tag containing the * locale identifier. UAX #35 extensions are accepted. * @return boolean 'true' if okay, 'false' if an error */ @@ -281,8 +281,8 @@ class Locale { * Gets the primary language for the input locale * * @param string $locale the locale to extract the primary language code from - * @return string the language code associated with the language - * or null in case of error. + * @return string the language code associated with the language + * or null in case of error. */ function locale_get_primary_language($locale) {} @@ -309,7 +309,7 @@ class Locale { * Gets the variants for the input locale * * @param string $locale the locale to extract the variants from - * @return array the array containing the list of all variants + * @return array the array containing the list of all variants * subtag for the locale or null if not present */ function locale_get_all_variants($locale) {} @@ -319,7 +319,7 @@ class Locale { * Gets the keywords for the input locale * * @param string $locale the locale to extract the keywords from - * @return array associative array containing the keyword-value pairs for this locale + * @return array associative array containing the keyword-value pairs for this locale */ function locale_get_keywords($locale) {} @@ -329,9 +329,9 @@ class Locale { * * @param string $locale the locale to return a displayname for * @param [string] $in_locale optional format locale - * If is 'null' then the default locale is used. + * If is 'null' then the default locale is used. * @return string display name of the locale in the format - * appropriate for $in_locale. + * appropriate for $in_locale. */ function locale_get_display_name($locale, $in_locale = null) {} @@ -341,9 +341,9 @@ class Locale { * * @param string $locale the locale to return a display language for * @param [string] $in_locale optional format locale to use to display the language name - * If is 'null' then the default locale is used. + * If is 'null' then the default locale is used. * @return string display name of the language for the $locale in the format - * appropriate for $in_locale. + * appropriate for $in_locale. */ function locale_get_display_language($lang, $in_locale = null) {} @@ -352,9 +352,9 @@ class Locale { * * @param string $locale the locale to return a display script for * @param [string] $in_locale optional format locale to use to display the script name - * If is 'null' then the default locale is used. + * If is 'null' then the default locale is used. * @return string display name of the script for the $locale in the format - * appropriate for $in_locale. + * appropriate for $in_locale. */ function locale_get_display_script($script, $in_locale = null) {} @@ -364,9 +364,9 @@ class Locale { * * @param string $locale the locale to return a display region for * @param [string] $in_locale optional format locale to use to display the region name - * If is 'null' then the default locale is used. + * If is 'null' then the default locale is used. * @return string display name of the region for the $locale in the format - * appropriate for $in_locale. + * appropriate for $in_locale. */ function locale_get_display_region($region, $in_locale = null) {} @@ -376,15 +376,15 @@ class Locale { * * @param string $locale the locale to return a display variant for * @param [string] $in_locale optional format locale to use to display the variant name - * If is 'null' then the default locale is used. + * If is 'null' then the default locale is used. * @return string display name of the variant for the $locale in the format - * appropriate for $in_locale. + * appropriate for $in_locale. */ function locale_get_display_variant($variant, $in_locale = null) {} /** - * Checks if a $langtag filter matches with $locale according to + * Checks if a $langtag filter matches with $locale according to * RFC 4647's basic filtering algorithm * * @param string $langtag the language tag to check @@ -396,24 +396,24 @@ class Locale { /** * Searchs the items in $langtag for the best match to the language - * range specified in $locale according to RFC 4647's lookup algorithm. + * range specified in $locale according to RFC 4647's lookup algorithm. * * @param array $langtag an array containing a list of language tags to compare * to $locale * @param string $locale the locale to use as the language range when matching * @param string $default the locale to use if no match is found - * @return string closest matching language tag, $default, + * @return string closest matching language tag, $default, * or empty string */ function locale_lookup(array $langtag, $locale, $default = null) {} /** - * Returns a correctly ordered and delimited locale ID + * Returns a correctly ordered and delimited locale ID * - * @param array $subtags an array containing a list of key-value pairs, where - * the keys identify the particular locale ID subtags, - * and the values are the associated subtag values. + * @param array $subtags an array containing a list of key-value pairs, where + * the keys identify the particular locale ID subtags, + * and the values are the associated subtag values. * * @return string the corresponding locale identifier. */ @@ -423,11 +423,11 @@ class Locale { /** * Returns a key-value array of locale ID subtag elements. * - * @param string $locale the locale to extract the subtag array from + * @param string $locale the locale to extract the subtag array from * - * @return array $subtags an array containing a list of key-value pairs, where - * the keys identify the particular locale ID subtags, - * and the values are the associated subtag values. + * @return array $subtags an array containing a list of key-value pairs, where + * the keys identify the particular locale ID subtags, + * and the values are the associated subtag values. */ function locale_parse_locale($locale) {} |