Book/intl-Phpdoc专题

Internationalization Functions

目录

• 简介
• 安装／配置
  • 需求
  • 安装
  • 运行时配置
  • 资源类型
• 预定义常量
• 范例
  • Basic usage of this extension
• Collator — The Collator class
  • Collator::asort — Sort array maintaining index association
  • Collator::compare — Compare two Unicode strings
  • Collator::__construct — Create a collator
  • Collator::create — Create a collator
  • Collator::getAttribute — Get collation attribute value
  • Collator::getErrorCode — Get collator's last error code
  • Collator::getErrorMessage — Get text for collator's last error code
  • Collator::getLocale — Get the locale name of the collator
  • Collator::getSortKey — Get sorting key for a string
  • Collator::getStrength — Get current collation strength
  • Collator::setAttribute — Set collation attribute
  • Collator::setStrength — Set collation strength
  • Collator::sortWithSortKeys — Sort array using specified collator and sort keys
  • Collator::sort — Sort array using specified collator
• NumberFormatter — The NumberFormatter class
  • NumberFormatter::create — Create a number formatter
  • NumberFormatter::formatCurrency — Format a currency value
  • NumberFormatter::format — Format a number
  • NumberFormatter::getAttribute — Get an attribute
  • NumberFormatter::getErrorCode — Get formatter's last error code
  • NumberFormatter::getErrorMessage — Get formatter's last error message
  • NumberFormatter::getLocale — Get formatter locale
  • NumberFormatter::getPattern — Get formatter pattern
  • NumberFormatter::getSymbol — Get a symbol value
  • NumberFormatter::getTextAttribute — Get a text attribute
  • NumberFormatter::parseCurrency — Parse a currency number
  • NumberFormatter::parse — Parse a number
  • NumberFormatter::setAttribute — Set an attribute
  • NumberFormatter::setPattern — Set formatter pattern
  • NumberFormatter::setSymbol — Set a symbol value
  • NumberFormatter::setTextAttribute — Set a text attribute
• Locale — The Locale class
  • Locale::acceptFromHttp — Tries to find out best available locale based on HTTP "Accept-Language" header
  • 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::lookup — Searches the language tag list for the best match to the language
  • Locale::parseLocale — Returns a key-value array of locale ID subtag elements
  • Locale::setDefault — Sets the default runtime locale
• Normalizer — The Normalizer class
  • Normalizer::getRawDecomposition — Gets the Decomposition_Mapping property for the given UTF-8 encoded code point
  • Normalizer::isNormalized — Checks if the provided string is already in the specified normalization form
  • Normalizer::normalize — Normalizes the input provided and returns the normalized string
• MessageFormatter — The MessageFormatter class
  • MessageFormatter::create — Constructs a new Message Formatter
  • MessageFormatter::formatMessage — Quick format message
  • MessageFormatter::format — Format the message
  • MessageFormatter::getErrorCode — Get the error code from last operation
  • MessageFormatter::getErrorMessage — Get the error text from the last operation
  • MessageFormatter::getLocale — Get the locale for which the formatter was created
  • MessageFormatter::getPattern — Get the pattern used by the formatter
  • MessageFormatter::parseMessage — Quick parse input string
  • MessageFormatter::parse — Parse input string according to pattern
  • MessageFormatter::setPattern — Set the pattern used by the formatter
• IntlCalendar — The IntlCalendar class
  • IntlCalendar::add — Add a (signed) amount of time to a field
  • IntlCalendar::after — Whether this objectʼs time is after that of the passed object
  • IntlCalendar::before — Whether this objectʼs time is before that of the passed object
  • IntlCalendar::clear — Clear a field or all fields
  • IntlCalendar::__construct — Private constructor for disallowing instantiation
  • IntlCalendar::createInstance — Create a new IntlCalendar
  • IntlCalendar::equals — Compare time of two IntlCalendar objects for equality
  • IntlCalendar::fieldDifference — Calculate difference between given time and this objectʼs time
  • IntlCalendar::fromDateTime — Create an IntlCalendar from a DateTime object or string
  • IntlCalendar::get — Get the value for a field
  • IntlCalendar::getActualMaximum — The maximum value for a field, considering the objectʼs current time
  • IntlCalendar::getActualMinimum — The minimum value for a field, considering the objectʼs current time
  • IntlCalendar::getAvailableLocales — Get array of locales for which there is data
  • IntlCalendar::getDayOfWeekType — Tell whether a day is a weekday, weekend or a day that has a transition between the two
  • IntlCalendar::getErrorCode — Get last error code on the object
  • IntlCalendar::getErrorMessage — Get last error message on the object
  • IntlCalendar::getFirstDayOfWeek — Get the first day of the week for the calendarʼs locale
  • IntlCalendar::getGreatestMinimum — Get the largest local minimum value for a field
  • IntlCalendar::getKeywordValuesForLocale — Get set of locale keyword values
  • IntlCalendar::getLeastMaximum — Get the smallest local maximum for a field
  • IntlCalendar::getLocale — Get the locale associated with the object
  • IntlCalendar::getMaximum — Get the global maximum value for a field
  • IntlCalendar::getMinimalDaysInFirstWeek — Get minimal number of days the first week in a year or month can have
  • IntlCalendar::getMinimum — Get the global minimum value for a field
  • IntlCalendar::getNow — Get number representing the current time
  • IntlCalendar::getRepeatedWallTimeOption — Get behavior for handling repeating wall time
  • IntlCalendar::getSkippedWallTimeOption — Get behavior for handling skipped wall time
  • IntlCalendar::getTime — Get time currently represented by the object
  • IntlCalendar::getTimeZone — Get the objectʼs timezone
  • IntlCalendar::getType — Get the calendar type
  • IntlCalendar::getWeekendTransition — Get time of the day at which weekend begins or ends
  • IntlCalendar::inDaylightTime — Whether the objectʼs time is in Daylight Savings Time
  • IntlCalendar::isEquivalentTo — Whether another calendar is equal but for a different time
  • IntlCalendar::isLenient — Whether date/time interpretation is in lenient mode
  • IntlCalendar::isSet — Whether a field is set
  • IntlCalendar::isWeekend — Whether a certain date/time is in the weekend
  • IntlCalendar::roll — Add value to field without carrying into more significant fields
  • IntlCalendar::set — Set a time field or several common fields at once
  • IntlCalendar::setFirstDayOfWeek — Set the day on which the week is deemed to start
  • IntlCalendar::setLenient — Set whether date/time interpretation is to be lenient
  • IntlCalendar::setMinimalDaysInFirstWeek — Set minimal number of days the first week in a year or month can have
  • IntlCalendar::setRepeatedWallTimeOption — Set behavior for handling repeating wall times at negative timezone offset transitions
  • IntlCalendar::setSkippedWallTimeOption — Set behavior for handling skipped wall times at positive timezone offset transitions
  • IntlCalendar::setTime — Set the calendar time in milliseconds since the epoch
  • IntlCalendar::setTimeZone — Set the timezone used by this calendar
  • IntlCalendar::toDateTime — Convert an IntlCalendar into a DateTime object
• IntlGregorianCalendar — The IntlGregorianCalendar class
  • IntlGregorianCalendar::__construct — Create the Gregorian Calendar class
  • IntlGregorianCalendar::getGregorianChange — Get the Gregorian Calendar change date
  • IntlGregorianCalendar::isLeapYear — Determine if the given year is a leap year
  • IntlGregorianCalendar::setGregorianChange — Set the Gregorian Calendar the change date
• IntlTimeZone — The IntlTimeZone class
  • IntlTimeZone::countEquivalentIDs — Get the number of IDs in the equivalency group that includes the given ID
  • IntlTimeZone::createDefault — Create a new copy of the default timezone for this host
  • IntlTimeZone::createEnumeration — Get an enumeration over time zone IDs associated with the given country or offset
  • IntlTimeZone::createTimeZone — Create a timezone object for the given ID
  • IntlTimeZone::createTimeZoneIDEnumeration — Get an enumeration over system time zone IDs with the given filter conditions
  • IntlTimeZone::fromDateTimeZone — Create a timezone object from DateTimeZone
  • IntlTimeZone::getCanonicalID — Get the canonical system timezone ID or the normalized custom time zone ID for the given time zone ID
  • IntlTimeZone::getDisplayName — Get a name of this time zone suitable for presentation to the user
  • IntlTimeZone::getDSTSavings — Get the amount of time to be added to local standard time to get local wall clock time
  • IntlTimeZone::getEquivalentID — Get an ID in the equivalency group that includes the given ID
  • IntlTimeZone::getErrorCode — Get last error code on the object
  • IntlTimeZone::getErrorMessage — Get last error message on the object
  • IntlTimeZone::getGMT — Create GMT (UTC) timezone
  • IntlTimeZone::getID — Get timezone ID
  • IntlTimeZone::getIDForWindowsID — Translate a Windows timezone into a system timezone
  • IntlTimeZone::getOffset — Get the time zone raw and GMT offset for the given moment in time
  • IntlTimeZone::getRawOffset — Get the raw GMT offset (before taking daylight savings time into account
  • IntlTimeZone::getRegion — Get the region code associated with the given system time zone ID
  • IntlTimeZone::getTZDataVersion — Get the timezone data version currently used by ICU
  • IntlTimeZone::getUnknown — Get the "unknown" time zone
  • IntlTimeZone::getWindowsID — Translate a system timezone into a Windows timezone
  • IntlTimeZone::hasSameRules — Check if this zone has the same rules and offset as another zone
  • IntlTimeZone::toDateTimeZone — Convert to DateTimeZone object
  • IntlTimeZone::useDaylightTime — Check if this time zone uses daylight savings time
• IntlDateFormatter — The IntlDateFormatter class
  • IntlDateFormatter::create — Create a date formatter
  • IntlDateFormatter::format — Format the date/time value as a string
  • IntlDateFormatter::formatObject — Formats an object
  • IntlDateFormatter::getCalendar — Get the calendar type used for the IntlDateFormatter
  • IntlDateFormatter::getDateType — Get the datetype used for the IntlDateFormatter
  • IntlDateFormatter::getErrorCode — Get the error code from last operation
  • IntlDateFormatter::getErrorMessage — Get the error text from the last operation
  • IntlDateFormatter::getLocale — Get the locale used by formatter
  • IntlDateFormatter::getPattern — Get the pattern used for the IntlDateFormatter
  • IntlDateFormatter::getTimeType — Get the timetype used for the IntlDateFormatter
  • IntlDateFormatter::getTimeZoneId — Get the timezone-id used for the IntlDateFormatter
  • IntlDateFormatter::getCalendarObject — Get copy of formatterʼs calendar object
  • IntlDateFormatter::getTimeZone — Get formatterʼs timezone
  • IntlDateFormatter::isLenient — Get the lenient used for the IntlDateFormatter
  • IntlDateFormatter::localtime — Parse string to a field-based time value
  • IntlDateFormatter::parse — Parse string to a timestamp value
  • IntlDateFormatter::setCalendar — Sets the calendar type used by the formatter
  • IntlDateFormatter::setLenient — Set the leniency of the parser
  • IntlDateFormatter::setPattern — Set the pattern used for the IntlDateFormatter
  • IntlDateFormatter::setTimeZoneId — Sets the time zone to use
  • IntlDateFormatter::setTimeZone — Sets formatterʼs timezone
• ResourceBundle — The ResourceBundle class
  • ResourceBundle::count — Get number of elements in the bundle
  • ResourceBundle::create — Create a resource bundle
  • ResourceBundle::getErrorCode — Get bundle's last error code
  • ResourceBundle::getErrorMessage — Get bundle's last error message
  • ResourceBundle::get — Get data from the bundle
  • ResourceBundle::getLocales — Get supported locales
• Spoofchecker — The Spoofchecker class
  • Spoofchecker::areConfusable — Checks if given strings can be confused
  • Spoofchecker::__construct — Constructor
  • Spoofchecker::isSuspicious — Checks if a given text contains any suspicious characters
  • Spoofchecker::setAllowedLocales — Locales to use when running checks
  • Spoofchecker::setChecks — Set the checks to run
• Transliterator — The Transliterator class
  • Transliterator::__construct — Private constructor to deny instantiation
  • Transliterator::create — Create a transliterator
  • Transliterator::createFromRules — Create transliterator from rules
  • Transliterator::createInverse — Create an inverse transliterator
  • Transliterator::getErrorCode — Get last error code
  • Transliterator::getErrorMessage — Get last error message
  • Transliterator::listIDs — Get transliterator IDs
  • Transliterator::transliterate — Transliterate a string
• IntlBreakIterator — The IntlBreakIterator class
  • IntlBreakIterator::__construct — Private constructor for disallowing instantiation
  • IntlBreakIterator::createCharacterInstance — Create break iterator for boundaries of combining character sequences
  • IntlBreakIterator::createCodePointInstance — Create break iterator for boundaries of code points
  • IntlBreakIterator::createLineInstance — Create break iterator for logically possible line breaks
  • IntlBreakIterator::createSentenceInstance — Create break iterator for sentence breaks
  • IntlBreakIterator::createTitleInstance — Create break iterator for title-casing breaks
  • IntlBreakIterator::createWordInstance — Create break iterator for word breaks
  • IntlBreakIterator::current — Get index of current position
  • IntlBreakIterator::first — Set position to the first character in the text
  • IntlBreakIterator::following — Advance the iterator to the first boundary following specified offset
  • IntlBreakIterator::getErrorCode — Get last error code on the object
  • IntlBreakIterator::getErrorMessage — Get last error message on the object
  • IntlBreakIterator::getLocale — Get the locale associated with the object
  • IntlBreakIterator::getPartsIterator — Create iterator for navigating fragments between boundaries
  • IntlBreakIterator::getText — Get the text being scanned
  • IntlBreakIterator::isBoundary — Tell whether an offset is a boundaryʼs offset
  • IntlBreakIterator::last — Set the iterator position to index beyond the last character
  • IntlBreakIterator::next — Advance the iterator the next boundary
  • IntlBreakIterator::preceding — Set the iterator position to the first boundary before an offset
  • IntlBreakIterator::previous — Set the iterator position to the boundary immediately before the current
  • IntlBreakIterator::setText — Set the text being scanned
• IntlRuleBasedBreakIterator — The IntlRuleBasedBreakIterator class
  • IntlRuleBasedBreakIterator::__construct — Create iterator from ruleset
  • IntlRuleBasedBreakIterator::getBinaryRules — Get the binary form of compiled rules
  • IntlRuleBasedBreakIterator::getRules — Get the rule set used to create this object
  • IntlRuleBasedBreakIterator::getRuleStatus — Get the largest status value from the break rules that determined the current break position
  • IntlRuleBasedBreakIterator::getRuleStatusVec — Get the status values from the break rules that determined the current break position
• IntlCodePointBreakIterator — The IntlCodePointBreakIterator class
  • IntlCodePointBreakIterator::getLastCodePoint — Get last code point passed over after advancing or receding the iterator
• IntlPartsIterator — The IntlPartsIterator class
  • IntlPartsIterator::getBreakIterator — Get IntlBreakIterator backing this parts iterator
• UConverter — The UConverter class
  • UConverter::__construct — Create UConverter object
  • UConverter::convert — Convert string from one charset to another
  • UConverter::fromUCallback — Default "from" callback function
  • UConverter::getAliases — Get the aliases of the given name
  • UConverter::getAvailable — Get the available canonical converter names
  • UConverter::getDestinationEncoding — Get the destination encoding
  • UConverter::getDestinationType — Get the destination converter type
  • UConverter::getErrorCode — Get last error code on the object
  • UConverter::getErrorMessage — Get last error message on the object
  • UConverter::getSourceEncoding — Get the source encoding
  • UConverter::getSourceType — Get the source converter type
  • UConverter::getStandards — Get standards associated to converter names
  • UConverter::getSubstChars — Get substitution chars
  • UConverter::reasonText — Get string representation of the callback reason
  • UConverter::setDestinationEncoding — Set the destination encoding
  • UConverter::setSourceEncoding — Set the source encoding
  • UConverter::setSubstChars — Set the substitution chars
  • UConverter::toUCallback — Default "to" callback function
  • UConverter::transcode — Convert string from one charset to another
• Grapheme 函数
  • grapheme_extract — Function to extract a sequence of default grapheme clusters from a text buffer, which must be encoded in UTF-8
  • grapheme_stripos — Find position (in grapheme units) of first occurrence of a case-insensitive string
  • grapheme_stristr — Returns part of haystack string from the first occurrence of case-insensitive needle to the end of haystack
  • grapheme_strlen — Get string length in grapheme units
  • grapheme_strpos — Find position (in grapheme units) of first occurrence of a string
  • grapheme_strripos — Find position (in grapheme units) of last occurrence of a case-insensitive string
  • grapheme_strrpos — Find position (in grapheme units) of last occurrence of a string
  • grapheme_strstr — Returns part of haystack string from the first occurrence of needle to the end of haystack
  • grapheme_substr — Return part of a string
• IDN 函数
  • idn_to_ascii — Convert domain name to IDNA ASCII form
  • idn_to_utf8 — Convert domain name from IDNA ASCII to Unicode
• IntlChar — IntlChar
  • IntlChar::charAge — Get the "age" of the code point
  • IntlChar::charDigitValue — Get the decimal digit value of a decimal digit character
  • IntlChar::charDirection — Get bidirectional category value for a code point
  • IntlChar::charFromName — Find Unicode character by name and return its code point value
  • IntlChar::charMirror — Get the "mirror-image" character for a code point
  • IntlChar::charName — Retrieve the name of a Unicode character
  • IntlChar::charType — Get the general category value for a code point
  • IntlChar::chr — Return Unicode character by code point value
  • IntlChar::digit — Get the decimal digit value of a code point for a given radix
  • IntlChar::enumCharNames — Enumerate all assigned Unicode characters within a range
  • IntlChar::enumCharTypes — Enumerate all code points with their Unicode general categories
  • IntlChar::foldCase — Perform case folding on a code point
  • IntlChar::forDigit — Get character representation for a given digit and radix
  • IntlChar::getBidiPairedBracket — Get the paired bracket character for a code point
  • IntlChar::getBlockCode — Get the Unicode allocation block containing a code point
  • IntlChar::getCombiningClass — Get the combining class of a code point
  • IntlChar::getFC_NFKC_Closure — Get the FC_NFKC_Closure property for a code point
  • IntlChar::getIntPropertyMaxValue — Get the max value for a Unicode property
  • IntlChar::getIntPropertyMinValue — Get the min value for a Unicode property
  • IntlChar::getIntPropertyValue — Get the value for a Unicode property for a code point
  • IntlChar::getNumericValue — Get the numeric value for a Unicode code point
  • IntlChar::getPropertyEnum — Get the property constant value for a given property name
  • IntlChar::getPropertyName — Get the Unicode name for a property
  • IntlChar::getPropertyValueEnum — Get the property value for a given value name
  • IntlChar::getPropertyValueName — Get the Unicode name for a property value
  • IntlChar::getUnicodeVersion — Get the Unicode version
  • IntlChar::hasBinaryProperty — Check a binary Unicode property for a code point
  • IntlChar::isalnum — Check if code point is an alphanumeric character
  • IntlChar::isalpha — Check if code point is a letter character
  • IntlChar::isbase — Check if code point is a base character
  • IntlChar::isblank — Check if code point is a "blank" or "horizontal space" character
  • IntlChar::iscntrl — Check if code point is a control character
  • IntlChar::isdefined — Check whether the code point is defined
  • IntlChar::isdigit — Check if code point is a digit character
  • IntlChar::isgraph — Check if code point is a graphic character
  • IntlChar::isIDIgnorable — Check if code point is an ignorable character
  • IntlChar::isIDPart — Check if code point is permissible in an identifier
  • IntlChar::isIDStart — Check if code point is permissible as the first character in an identifier
  • IntlChar::isISOControl — Check if code point is an ISO control code
  • IntlChar::isJavaIDPart — Check if code point is permissible in a Java identifier
  • IntlChar::isJavaIDStart — Check if code point is permissible as the first character in a Java identifier
  • IntlChar::isJavaSpaceChar — Check if code point is a space character according to Java
  • IntlChar::islower — Check if code point is a lowercase letter
  • IntlChar::isMirrored — Check if code point has the Bidi_Mirrored property
  • IntlChar::isprint — Check if code point is a printable character
  • IntlChar::ispunct — Check if code point is punctuation character
  • IntlChar::isspace — Check if code point is a space character
  • IntlChar::istitle — Check if code point is a titlecase letter
  • IntlChar::isUAlphabetic — Check if code point has the Alphabetic Unicode property
  • IntlChar::isULowercase — Check if code point has the Lowercase Unicode property
  • IntlChar::isupper — Check if code point has the general category "Lu" (uppercase letter)
  • IntlChar::isUUppercase — Check if code point has the Uppercase Unicode property
  • IntlChar::isUWhiteSpace — Check if code point has the White_Space Unicode property
  • IntlChar::isWhitespace — Check if code point is a whitespace character according to ICU
  • IntlChar::isxdigit — Check if code point is a hexadecimal digit
  • IntlChar::ord — Return Unicode code point value of character
  • IntlChar::tolower — Make Unicode character lowercase
  • IntlChar::totitle — Make Unicode character titlecase
  • IntlChar::toupper — Make Unicode character uppercase
• IntlException — Exception class for intl errors
• IntlIterator — The IntlIterator class
  • IntlIterator::current — Get the current element
  • IntlIterator::key — Get the current key
  • IntlIterator::next — Move forward to the next element
  • IntlIterator::rewind — Rewind the iterator to the first element
  • IntlIterator::valid — Check if current position is valid
• intl 函数
  • intl_error_name — Get symbolic name for a given error code
  • intl_get_error_code — Get the last error code
  • intl_get_error_message — Get description of the last error
  • intl_is_failure — Check whether the given error code indicates failure

简介

Provides string comparison capability with support for appropriate locale-sensitive sort orderings.

类摘要

Collator

class Collator {

/* 方法 */

public <span class="methodname">__construct ( <span class="methodparam">string $locale )

public bool asort ( <span class="type">array &$arr [, <span class="methodparam">int $sort_flag ] )

public int <span class="methodname">compare ( <span class="type">string $str1 , <span class="methodparam">string $str2 )

public <span class="modifier">static Collator <span class="methodname">create ( <span class="type">string $locale )

public int <span class="methodname">getAttribute ( <span class="type">int $attr )

public int <span class="methodname">getErrorCode ( <span class="methodparam">void )

public string getErrorMessage ( <span class="methodparam">void )

public string getLocale ( <span class="methodparam">int $type )

public <span class="type">stringfalse <span class="methodname">getSortKey ( <span class="type">string $str )

public int <span class="methodname">getStrength ( <span class="methodparam">void )

public bool setAttribute ( <span class="methodparam">int $attr , <span class="methodparam">int $val )

public bool setStrength ( <span class="methodparam">int $strength )

public bool sortWithSortKeys ( <span class="methodparam">array &$arr )

public bool sort ( <span class="type">array &$arr [, <span class="methodparam">int $sort_flag ] )

}

预定义常量

Collator::FRENCH_COLLATION (int)
Sort strings with different accents from the back of the string. This attribute is automatically set to On for the French locales and a few others. Users normally would not need to explicitly set this attribute. There is a string comparison performance cost when it is set On, but sort key length is unaffected. Possible values are:

• Collator::ON
• Collator::OFF(default)
• Collator::DEFAULT_VALUE

示例 #1 FRENCH_COLLATION rules

• F=OFF cote \< coté \< côte \< côté
• F=ON cote \< côte \< coté \< côté

Collator::ALTERNATE_HANDLING (int)
The Alternate attribute is used to control the handling of the so called variable characters in the UCA: whitespace, punctuation and symbols. If Alternate is set to NonIgnorable (N), then differences among these characters are of the same importance as differences among letters. If Alternate is set to Shifted (S), then these characters are of only minor importance. The Shifted value is often used in combination with Strength set to Quaternary. In such a case, whitespace, punctuation, and symbols are considered when comparing strings, but only if all other aspects of the strings (base letters, accents, and case) are identical. If Alternate is not set to Shifted, then there is no difference between a Strength of 3 and a Strength of 4. For more information and examples, see Variable_Weighting in the » UCA. The reason the Alternate values are not simply On and Off is that additional Alternate values may be added in the future. The UCA option Blanked is expressed with Strength set to 3, and Alternate set to Shifted. The default for most locales is NonIgnorable. If Shifted is selected, it may be slower if there are many strings that are the same except for punctuation; sort key length will not be affected unless the strength level is also increased.

Possible values are:

• Collator::NON_IGNORABLE(default)
• Collator::SHIFTED
• Collator::DEFAULT_VALUE

示例 #2 ALTERNATE_HANDLING rules

• S=3, A=N di Silva \< Di Silva \< diSilva \< U.S.A. \< USA
• S=3, A=S di Silva = diSilva \< Di Silva \< U.S.A. = USA
• S=4, A=S di Silva \< diSilva \< Di Silva \< U.S.A. \< USA

Collator::CASE_FIRST (int)
The Case_First attribute is used to control whether uppercase letters come before lowercase letters or vice versa, in the absence of other differences in the strings. The possible values are Uppercase_First (U) and Lowercase_First (L), plus the standard Default and Off. There is almost no difference between the Off and Lowercase_First options in terms of results, so typically users will not use Lowercase_First: only Off or Uppercase_First. (People interested in the detailed differences between X and L should consult the Collation Customization). Specifying either L or U won't affect string comparison performance, but will affect the sort key length.

Possible values are:

• Collator::OFF(default)
• Collator::LOWER_FIRST
• Collator::UPPER_FIRST
• Collator:DEFAULT

示例 #3 CASE_FIRST rules

• C=X or C=L "china" \< "China" \< "denmark" \< "Denmark"
• C=U "China" \< "china" \< "Denmark" \< "denmark"

Collator::CASE_LEVEL (int)
The Case_Level attribute is used when ignoring accents but not case. In such a situation, set Strength to be Primary, and Case_Level to be On. In most locales, this setting is Off by default. There is a small string comparison performance and sort key impact if this attribute is set to be On.

Possible values are:

• Collator::OFF(default)
• Collator::ON
• Collator::DEFAULT_VALUE

示例 #4 CASE_LEVEL rules

• S=1, E=X role = Role = rôle
• S=1, E=O role = rôle \< Role

Collator::NORMALIZATION_MODE (int)
The Normalization setting determines whether text is thoroughly normalized or not in comparison. Even if the setting is off (which is the default for many locales), text as represented in common usage will compare correctly (for details, see UTN #5). Only if the accent marks are in noncanonical order will there be a problem. If the setting is On, then the best results are guaranteed for all possible text input. There is a medium string comparison performance cost if this attribute is On, depending on the frequency of sequences that require normalization. There is no significant effect on sort key length. If the input text is known to be in NFD or NFKD normalization forms, there is no need to enable this Normalization option.

Possible values are:

• Collator::OFF(default)
• Collator::ON
• Collator::DEFAULT_VALUE

Collator::STRENGTH (int)
The ICU Collation Service supports many levels of comparison (named "Levels", but also known as "Strengths"). Having these categories enables ICU to sort strings precisely according to local conventions. However, by allowing the levels to be selectively employed, searching for a string in text can be performed with various matching conditions. For more detailed information, see <span class="function">collator_set_strength chapter.

Possible values are:

• Collator::PRIMARY
• Collator::SECONDARY
• Collator::TERTIARY(default)
• Collator::QUATERNARY
• Collator::IDENTICAL
• Collator::DEFAULT_VALUE

Collator::HIRAGANA_QUATERNARY_MODE (int)
Compatibility with JIS x 4061 requires the introduction of an additional level to distinguish Hiragana and Katakana characters. If compatibility with that standard is required, then this attribute should be set On, and the strength set to Quaternary. This will affect sort key length and string comparison string comparison performance.

Possible values are:

• Collator::OFF(default)
• Collator::ON
• Collator::DEFAULT_VALUE

Collator::NUMERIC_COLLATION (int)
When turned on, this attribute generates a collation key for the numeric value of substrings of digits. This is a way to get '100' to sort AFTER '2'.

Possible values are:

• Collator::OFF(default)
• Collator::ON
• Collator::DEFAULT_VALUE

Collator::DEFAULT_VALUE (int)

Collator::PRIMARY (int)

Collator::SECONDARY (int)

Collator::TERTIARY (int)

Collator::DEFAULT_STRENGTH (int)

Collator::QUATERNARY (int)

Collator::IDENTICAL (int)

Collator::OFF (int)

Collator::ON (int)

Collator::SHIFTED (int)

Collator::NON_IGNORABLE (int)

Collator::LOWER_FIRST (int)

Collator::UPPER_FIRST (int)

Collator::asort

collator_asort

Sort array maintaining index association

说明

面向对象风格

public bool Collator::asort ( <span class="methodparam">array &$arr [, int $sort_flag ] )

过程化风格

bool <span class="methodname">collator_asort ( <span class="methodparam">Collator $coll , array &$arr [, int $sort_flag ] )

This function sorts an array such that array indices maintain their correlation with the array elements they are associated with. This is used mainly when sorting associative arrays where the actual element order is significant. Array elements will have sort order according to current locale rules.

Equivalent to standard PHP asort.

参数

coll
Collator object.

arr
Array of strings to sort.

sort_flag
Optional sorting type, one of the following:

• Collator::SORT_REGULAR - compare items normally (don't change types)

• Collator::SORT_NUMERIC - compare items numerically

• Collator::SORT_STRING - compare items as strings

Default $sort_flag value is Collator::SORT_REGULAR. It is also used if an invalid $sort_flag value has been specified.

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 collator_asortexample

<?php
$coll = collator_create( 'en_US' );
$arr = array(
     'a' => '100',
     'b' => '50',
     'c' => '7'
);
collator_asort( $coll, $arr, Collator::SORT_NUMERIC );
var_export( $arr );

collator_asort( $coll, $arr, Collator::SORT_STRING );
var_export( $arr );
?>

以上例程会输出：

array (
  'c' => '7',
  'b' => '50',
  'a' => '100',
)array (
  'a' => '100',
  'b' => '50',
  'c' => '7',
)

参见

• Collator constants
• collator_sort
• collator_sort_with_sort_keys

Collator::compare

collator_compare

Compare two Unicode strings

说明

面向对象风格

public int <span class="methodname">Collator::compare ( <span class="methodparam">string $str1 , string $str2 )

过程化风格

int <span class="methodname">collator_compare ( <span class="methodparam">Collator $coll , string $str1 , <span class="type">string $str2 )

Compare two Unicode strings according to collation rules.

参数

coll
Collator object.

str1
The first string to compare.

str2
The second string to compare.

返回值

Return comparison result:

• 1 if str1 is greater than str2 ;

• 0 if str1 is equal to str2;

• -1 if str1 is less than str2 .

On error bool false is returned.

Warning

此函数可能返回布尔值 false，但也可能返回等同于 false 的非布尔值。请阅读 布尔类型章节以获取更多信息。应使用 === 运算符来测试此函数的返回值。

范例

示例 #1 collator_compareexample

<?php
$s1 = 'Hello';
$s2 = 'hello';

$coll = collator_create( 'en_US' );
$res  = collator_compare( $coll, $s1, $s2 );

if ($res === false) {
    echo collator_get_error_message( $coll );
} else if( $res > 0 ) {
    echo "s1 is greater than s2\n";
} else if( $res < 0 ) {
    echo "s1 is less than s2\n";
} else {
    echo "s1 is equal to s2\n";
}
?>

以上例程会输出：

s1 is greater than s2

参见

• collator_sort

Collator::__construct

Create a collator

说明

public <span class="methodname">Collator::__construct ( <span class="methodparam">string $locale )

Creates a new instance of Collator.

参数

locale
The locale whose collation rules should be used. Special values for locales can be passed in - if null is passed for the locale, the default locale's collation rules will be used. If "root" is passed, UCA rules will be used.

The Locale attribute is typically the most important attribute for correct sorting and matching, according to the user expectations in different countries and regions. The default » UCA ordering will only sort a few languages such as Dutch and Portuguese correctly ("correctly" meaning according to the normal expectations for users of the languages). Otherwise, you need to supply the locale to UCA in order to properly collate text for a given language. Thus a locale needs to be supplied so as to choose a collator that is correctly tailored for that locale. The choice of a locale will automatically preset the values for all of the attributes to something that is reasonable for that locale. Thus most of the time the other attributes do not need to be explicitly set. In some cases, the choice of locale will make a difference in string comparison performance and/or sort key length.

返回值

Returns Collator instance.

错误／异常

Returns an "empty" object on error. You can use <span class="function">intl_get_error_code and/or <span class="function">intl_get_error_message to know what happened.

范例

示例 #1 Collator::__construct example

<?php
$coll = new Collator( 'en_CA' );
?>

参见

• Collator::create
• collator_create

Collator::create

collator_create

Create a collator

说明

面向对象风格

public <span class="modifier">static Collator <span class="methodname">Collator::create ( <span class="methodparam">string $locale )

过程化风格

Collator <span class="methodname">collator_create ( <span class="methodparam">string $locale )

The strings will be compared using the options already specified.

参数

locale
The locale containing the required collation rules. Special values for locales can be passed in - if null is passed for the locale, the default locale collation rules will be used. If empty string ("") or "root" are passed, » UCA rules will be used.

返回值

Return new instance of Collator object, or null on error.

范例

示例 #1 collator_create example

<?php
$coll = collator_create( 'en_US' );

if( !isset( $coll ) ) {
    printf( "Collator creation failed: %s\n", intl_get_error_message() );
    exit( 1 );
}
?>

参见

• Collator::__construct

Collator::getAttribute

collator_get_attribute

Get collation attribute value

说明

面向对象风格

public int <span class="methodname">Collator::getAttribute ( <span class="methodparam">int $attr )

过程化风格

int <span class="methodname">collator_get_attribute ( <span class="methodparam">Collator $coll , int $attr )

Get a value of an integer collator attribute.

参数

coll
Collator object.

attr
Attribute to get value for.

返回值

Attribute value, or bool false on error.

范例

示例 #1 collator_get_attribute example

<?php
$coll = collator_create( 'en_CA' );
$val = collator_get_attribute( $coll, Collator::NUMERIC_COLLATION );
if( $val === false )
{
    // Handle error.
}
?>

参见

• Collator constants
• collator_set_attribute
• collator_get_strength

Collator::getErrorCode

collator_get_error_code

Get collator's last error code

说明

面向对象风格

public int <span class="methodname">Collator::getErrorCode ( <span class="methodparam">void )

过程化风格

int <span class="methodname">collator_get_error_code ( <span class="methodparam">Collator $coll )

参数

coll
Collator object.

返回值

Error code returned by the last Collator API function call.

范例

示例 #1 collator_get_error_code example

<?php
$coll = collator_create( 'en_US' );
if( collator_get_attribute( $coll, Collator::FRENCH_COLLATION ) === false )
        handle_error( collator_get_error_code() );
?>

参见

• collator_get_error_message

Collator::getErrorMessage

collator_get_error_message

Get text for collator's last error code

说明

面向对象风格

public string Collator::getErrorMessage ( <span class="methodparam">void )

过程化风格

string <span class="methodname">collator_get_error_message ( <span class="methodparam">Collator $coll )

Retrieves the message for the last error.

参数

coll
Collator object.

返回值

Description of an error occurred in the last Collator API function call.

范例

示例 #1 collator_get_error_message example

<?php
$coll = collator_create( 'lt' );
if( collator_compare( $coll, 'y', 'k' ) === false ) {
    echo collator_get_error_message( $coll );
}
?>

参见

• collator_get_error_code

Collator::getLocale

collator_get_locale

Get the locale name of the collator

说明

面向对象风格

public string Collator::getLocale ( <span class="methodparam">int $type )

过程化风格

string <span class="methodname">collator_get_locale ( <span class="methodparam">Collator $coll , int $type )

Get collector locale name.

参数

coll
Collator object.

type
You can choose between valid and actual locale ( Locale::VALID_LOCALE and Locale::ACTUAL_LOCALE, respectively).

返回值

Real locale name from which the collation data comes. If the collator was instantiated from rules or an error occurred, returns <span class="type">bool false.

范例

示例 #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_val, $res_act );
?>

以上例程会输出：

Requested locale name: en_US_California
Valid locale name: en_US
Actual locale name: en

参见

• collator_create

Collator::getSortKey

collator_get_sort_key

Get sorting key for a string

说明

面向对象风格

public <span class="type">stringfalse <span class="methodname">Collator::getSortKey ( <span class="methodparam">string $str )

过程化风格

string<span class="type">false <span class="methodname">collator_get_sort_key ( <span class="methodparam">Collator $coll , string $str )

Return collation key for a string. Collation keys can be compared directly instead of strings, though are implementation specific and may change between ICU library versions. Sort keys are generally only useful in databases or other circumstances where function calls are extremely expensive.

参数

coll
Collator object.

str
The string to produce the key from.

返回值

Returns the collation key for the string, 或者在失败时返回 false.

Warning

此函数可能返回布尔值 false，但也可能返回等同于 false 的非布尔值。请阅读 布尔类型章节以获取更多信息。应使用 === 运算符来测试此函数的返回值。

更新日志

范例

示例 #1 <span class="function">collator_get_sort_keyexample

<?php
$s1 = 'Hello';

$coll = collator_create('en_US');
$res  = collator_get_sort_key($coll, $s1);

echo bin2hex($res);
?>

以上例程的输出类似于：

3832404046010901dc08

参见

• collator_sort
• collator_sort_with_sort_keys

Collator::getStrength

collator_get_strength

Get current collation strength

说明

面向对象风格

public int <span class="methodname">Collator::getStrength ( <span class="methodparam">void )

过程化风格

int <span class="methodname">collator_get_strength ( <span class="methodparam">Collator $coll )

参数

coll
Collator object.

返回值

Returns current collation strength, or bool false on error.

范例

示例 #1 collator_get_strength example

<?php
$coll     = collator_create( 'en_US' );
$strength = collator_get_strength( $coll );
?>

参见

• Collator constants
• collator_set_strength
• collator_get_attribute

Collator::setAttribute

collator_set_attribute

Set collation attribute

说明

面向对象风格

public bool Collator::setAttribute ( <span class="methodparam">int $attr , <span class="methodparam">int $val )

过程化风格

bool <span class="methodname">collator_set_attribute ( <span class="methodparam">Collator $coll , int $attr , int $val )

参数

coll
Collator <span class="type">object.

attr
Attribute.

val
Attribute value.

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 collator_set_attribute example

<?php
$coll = collator_create( 'en_CA' );
$val  = collator_get_attribute( $coll, Collator::NUMERIC_COLLATION );
if ($val === false) {
    // Handle error.
} elseif ($val === Collator::ON) {
    // Do something useful.
}
?>

参见

• Collator constants
• collator_get_attribute
• collator_set_strength

Collator::setStrength

collator_set_strength

Set collation strength

说明

面向对象风格

public bool Collator::setStrength ( <span class="methodparam">int $strength )

过程化风格

bool <span class="methodname">collator_set_strength ( <span class="methodparam">Collator $coll , int $strength )

The » ICU Collation Service supports many levels of comparison (named "Levels", but also known as "Strengths"). Having these categories enables ICU to sort strings precisely according to local conventions. However, by allowing the levels to be selectively employed, searching for a string in text can be performed with various matching conditions.

1. Primary Level: Typically, this is used to denote differences between base characters (for example, "a" \< "b"). It is the strongest difference. For example, dictionaries are divided into different sections by base character. This is also called the level1 strength.

2. Secondary Level: Accents in the characters are considered secondary differences (for example, "as" \< "às" \< "at"). Other differences between letters can also be considered secondary differences, depending on the language. A secondary difference is ignored when there is a primary difference anywhere in the strings. This is also called the level2 strength.

   Note:

   Note: In some languages (such as Danish), certain accented letters are considered to be separate base characters. In most languages, however, an accented letter only has a secondary difference from the unaccented version of that letter.

3. Tertiary Level: Upper and lower case differences in characters are distinguished at the tertiary level (for example, "ao" \< "Ao" \< "aò"). In addition, a variant of a letter differs from the base form on the tertiary level (such as "A" and " "). Another example is the difference between large and small Kana. A tertiary difference is ignored when there is a primary or secondary difference anywhere in the strings. This is also called the level3 strength.

4. Quaternary Level: When punctuation is ignored (see Ignoring Punctuations ) at level 13, an additional level can be used to distinguish words with and without punctuation (for example, "ab" \< "a-b" \< "aB"). This difference is ignored when there is a primary, secondary or tertiary difference. This is also known as the level4 strength. The quaternary level should only be used if ignoring punctuation is required or when processing Japanese text (see Hiragana processing).

5. Identical Level: When all other levels are equal, the identical level is used as a tiebreaker. The Unicode code point values of the NFD form of each string are compared at this level, just in case there is no difference at levels 14. For example, Hebrew cantillation marks are only distinguished at this level. This level should be used sparingly, as only code point values differences between two strings is an extremely rare occurrence. Using this level substantially decreases the performance for both incremental comparison and sort key generation (as well as increasing the sort key length). It is also known as level 5 strength.

For example, people may choose to ignore accents or ignore accents and case when searching for text. Almost all characters are distinguished by the first three levels, and in most locales the default value is thus Tertiary. However, if Alternate is set to be Shifted, then the Quaternary strength can be used to break ties among whitespace, punctuation, and symbols that would otherwise be ignored. If very fine distinctions among characters are required, then the Identical strength can be used (for example, Identical Strength distinguishes between the Mathematical Bold Small A and the Mathematical Italic Small A.). However, using levels higher than Tertiary the Identical strength result in significantly longer sort keys, and slower string comparison performance for equal strings.

参数

coll
Collator object.

strength
Strength to set.

Possible values are:

• Collator::PRIMARY

• Collator::SECONDARY

• Collator::TERTIARY

• Collator::QUATERNARY

• Collator::IDENTICAL

• Collator::DEFAULT_STRENGTH

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 collator_set_strength example

<?php
$arr  = array( 'aò', 'Ao', 'ao' );
$coll = collator_create( 'en_US' );

// Sort array using default strength.
collator_sort( $coll, $arr ); 
var_export( $arr );

// Sort array using primary strength.
collator_set_strength( $coll, Collator::PRIMARY );
collator_sort( $coll, $arr );
var_export( $arr );
?>

以上例程会输出：

array (
  0 => 'ao',
  1 => 'Ao',
  2 => 'aò',
)
array (
  0 => 'aò',
  1 => 'Ao',
  2 => 'ao',
)

参见

• Collator constants
• collator_get_strength

Collator::sortWithSortKeys

collator_sort_with_sort_keys

Sort array using specified collator and sort keys

说明

面向对象风格

public bool Collator::sortWithSortKeys ( <span class="methodparam">array &$arr )

过程化风格

bool <span class="methodname">collator_sort_with_sort_keys ( <span class="methodparam">Collator $coll , array &$arr )

Similar to collator_sort but uses ICU sorting keys produced by ucol_getSortKey() to gain more speed on large arrays.

参数

coll
Collator object.

arr
Array of strings to sort

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 <span class="function">collator_sort_with_sort_keys example

<?php
$arr  = array( 'Köpfe', 'Kypper', 'Kopfe' );
$coll = collator_create( 'sv' );

collator_sort_with_sort_keys( $coll, $arr );
var_export( $arr );
?>

以上例程会输出：

array (
  0 => 'Kopfe',
  1 => 'Kypper',
  2 => 'Köpfe',
)

参见

• Collator constants
• collator_sort
• collator_asort

Collator::sort

collator_sort

Sort array using specified collator

说明

面向对象风格

public bool Collator::sort ( <span class="methodparam">array &$arr [, int $sort_flag ] )

过程化风格

bool <span class="methodname">collator_sort ( <span class="methodparam">Collator $coll , array &$arr [, int $sort_flag ] )

This function sorts an array according to current locale rules.

Equivalent to standard PHP sort .

参数

coll
Collator object.

arr
Array of strings to sort.

sort_flag
Optional sorting type, one of the following:

• Collator::SORT_REGULAR - compare items normally (don't change types)

• Collator::SORT_NUMERIC - compare items numerically

• Collator::SORT_STRING - compare items as strings

Default sorting type is Collator::SORT_REGULAR. It is also used if an invalid sort_flag value has been specified.

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 collator_sort example

<?php
$coll = collator_create( 'en_US' );
$arr  = array( 'at', 'às', 'as' );

var_export( $arr );
collator_sort( $coll, $arr );
var_export( $arr );
?>

以上例程会输出：

array (
  0 => 'at',
  1 => 'às',
  2 => 'as',
)array (
  0 => 'as',
  1 => 'às',
  2 => 'at',
)

参见

• Collator constants
• collator_asort
• collator_sort_with_sort_keys

简介

Programs store and operate on numbers using a locale-independent binary representation. When displaying or printing a number it is converted to a locale-specific string. For example, the number 12345.67 is "12,345.67" in the US, "12 345,67" in France and "12.345,67" in Germany.

By invoking the methods provided by the NumberFormatter class, you can format numbers, currencies, and percentages according to the specified or default locale. NumberFormatter is locale-sensitive so you need to create a new NumberFormatter for each locale. NumberFormatter methods format primitive-type numbers, such as double and output the number as a locale-specific string.

For currencies you can use currency format type to create a formatter that returns a string with the formatted number and the appropriate currency sign. Of course, the NumberFormatter class is unaware of exchange rates so, the number output is the same regardless of the specified currency. This means that the same number has different monetary values depending on the currency locale. If the number is 9988776.65 the results will be:

• 9 988 776,65 € in France
• 9.988.776,65 € in Germany
• $9,988,776.65 in the United States

In order to format percentages, create a locale-specific formatter with percentage format type. With this formatter, a decimal fraction such as 0.75 is displayed as 75%.

For more complex formatting, like spelled-out numbers, the rule-based number formatters are used.

类摘要

NumberFormatter

class NumberFormatter {

/* 方法 */

public <span class="methodname">__construct ( <span class="methodparam">string $locale , int $style [, string $pattern ] )

public <span class="modifier">static NumberFormatter create ( <span class="type">string $locale , <span class="methodparam">int $style [, string $pattern ] )

public <span class="type">stringfalse <span class="methodname">formatCurrency ( <span class="methodparam">float $value , string $currency )

public string format ( <span class="type">int<span class="type">float $value [, <span class="methodparam">int $type ] )

public int <span class="methodname">getAttribute ( <span class="type">int $attr )

public int <span class="methodname">getErrorCode ( <span class="methodparam">void )

public string getErrorMessage ( <span class="methodparam">void )

public string getLocale ([ <span class="methodparam">int $type ] )

public string getPattern ( <span class="methodparam">void )

public string getSymbol ( <span class="methodparam">int $attr )

public string getTextAttribute ( <span class="methodparam">int $attr )

public float parseCurrency ( <span class="methodparam">string $value , string &$currency [, <span class="type">int &$position ] )

public mixed parse ( <span class="type">string $value [, <span class="methodparam">int $type [, int &$position ]] )

public bool setAttribute ( <span class="methodparam">int $attr , <span class="methodparam">int $value )

public bool setPattern ( <span class="methodparam">string $pattern )

public bool setSymbol ( <span class="methodparam">int $attr , <span class="methodparam">string $value )

public bool setTextAttribute ( <span class="methodparam">int $attr , <span class="methodparam">string $value )

}

预定义常量

These styles are used by the <span class="function">numfmt_create to define the type of the formatter.

NumberFormatter::PATTERN_DECIMAL (int)
Decimal format defined by pattern

NumberFormatter::DECIMAL (int)
Decimal format

NumberFormatter::CURRENCY (int)
Currency format

NumberFormatter::PERCENT (int)
Percent format

NumberFormatter::SCIENTIFIC (int)
Scientific format

NumberFormatter::SPELLOUT (int)
Spellout rule-based format

NumberFormatter::ORDINAL (int)
Ordinal rule-based format

NumberFormatter::DURATION (int)
Duration rule-based format

NumberFormatter::PATTERN_RULEBASED (int)
Rule-based format defined by pattern

NumberFormatter::CURRENCY_ACCOUNTING (int)
Currency format for accounting, e.g., ($3.00) for negative currency amount instead of -$3.00. Available as of PHP 7.4.1 and ICU 53.

NumberFormatter::DEFAULT_STYLE (int)
Default format for the locale

NumberFormatter::IGNORE (int)
Alias for PATTERN_DECIMAL

These constants define how the numbers are parsed or formatted. They should be used as arguments to <span class="function">numfmt_format and <span class="function">numfmt_parse.

NumberFormatter::TYPE_DEFAULT (int)
Derive the type from variable type

NumberFormatter::TYPE_INT32 (int)
Format/parse as 32-bit integer

NumberFormatter::TYPE_INT64 (int)
Format/parse as 64-bit integer

NumberFormatter::TYPE_DOUBLE (int)
Format/parse as floating point value

NumberFormatter::TYPE_CURRENCY (int)
Format/parse as currency value

Number format attribute used by <span class="function">numfmt_get_attribute and <span class="function">numfmt_set_attribute.

NumberFormatter::PARSE_INT_ONLY (int)
Parse integers only.

NumberFormatter::GROUPING_USED (int)
Use grouping separator.

NumberFormatter::DECIMAL_ALWAYS_SHOWN (int)
Always show decimal point.

NumberFormatter::MAX_INTEGER_DIGITS (int)
Maximum integer digits.

NumberFormatter::MIN_INTEGER_DIGITS (int)
Minimum integer digits.

NumberFormatter::INTEGER_DIGITS (int)
Integer digits.

NumberFormatter::MAX_FRACTION_DIGITS (int)
Maximum fraction digits.

NumberFormatter::MIN_FRACTION_DIGITS (int)
Minimum fraction digits.

NumberFormatter::FRACTION_DIGITS (int)
Fraction digits.

NumberFormatter::MULTIPLIER (int)
Multiplier.

NumberFormatter::GROUPING_SIZE (int)
Grouping size.

NumberFormatter::ROUNDING_MODE (int)
Rounding Mode.

NumberFormatter::ROUNDING_INCREMENT (int)
Rounding increment.

NumberFormatter::FORMAT_WIDTH (int)
The width to which the output of format() is padded.

NumberFormatter::PADDING_POSITION (int)
The position at which padding will take place. See pad position constants for possible argument values.

NumberFormatter::SECONDARY_GROUPING_SIZE (int)
Secondary grouping size.

NumberFormatter::SIGNIFICANT_DIGITS_USED (int)
Use significant digits.

NumberFormatter::MIN_SIGNIFICANT_DIGITS (int)
Minimum significant digits.

NumberFormatter::MAX_SIGNIFICANT_DIGITS (int)
Maximum significant digits.

NumberFormatter::LENIENT_PARSE (int)
Lenient parse mode used by rule-based formats.

Number format text attribute used by <span class="function">numfmt_get_text_attribute and <span class="function">numfmt_set_text_attribute.

NumberFormatter::POSITIVE_PREFIX (int)
Positive prefix.

NumberFormatter::POSITIVE_SUFFIX (int)
Positive suffix.

NumberFormatter::NEGATIVE_PREFIX (int)
Negative prefix.

NumberFormatter::NEGATIVE_SUFFIX (int)
Negative suffix.

NumberFormatter::PADDING_CHARACTER (int)
The character used to pad to the format width.

NumberFormatter::CURRENCY_CODE (int)
The ISO currency code.

NumberFormatter::DEFAULT_RULESET (int)
The default rule set. This is only available with rule-based formatters.

NumberFormatter::PUBLIC_RULESETS (int)
The public rule sets. This is only available with rule-based formatters. This is a read-only attribute. The public rulesets are returned as a single string, with each ruleset name delimited by ';' (semicolon).

Number format symbols used by <span class="function">numfmt_get_symbol and <span class="function">numfmt_set_symbol.

NumberFormatter::DECIMAL_SEPARATOR_SYMBOL (int)
The decimal separator.

NumberFormatter::GROUPING_SEPARATOR_SYMBOL (int)
The grouping separator.

NumberFormatter::PATTERN_SEPARATOR_SYMBOL (int)
The pattern separator.

NumberFormatter::PERCENT_SYMBOL (int)
The percent sign.

NumberFormatter::ZERO_DIGIT_SYMBOL (int)
Zero.

NumberFormatter::DIGIT_SYMBOL (int)
Character representing a digit in the pattern.

NumberFormatter::MINUS_SIGN_SYMBOL (int)
The minus sign.

NumberFormatter::PLUS_SIGN_SYMBOL (int)
The plus sign.

NumberFormatter::CURRENCY_SYMBOL (int)
The currency symbol.

NumberFormatter::INTL_CURRENCY_SYMBOL (int)
The international currency symbol.

NumberFormatter::MONETARY_SEPARATOR_SYMBOL (int)
The monetary separator.

NumberFormatter::EXPONENTIAL_SYMBOL (int)
The exponential symbol.

NumberFormatter::PERMILL_SYMBOL (int)
Per mill symbol.

NumberFormatter::PAD_ESCAPE_SYMBOL (int)
Escape padding character.

NumberFormatter::INFINITY_SYMBOL (int)
Infinity symbol.

NumberFormatter::NAN_SYMBOL (int)
Not-a-number symbol.

NumberFormatter::SIGNIFICANT_DIGIT_SYMBOL (int)
Significant digit symbol.

NumberFormatter::MONETARY_GROUPING_SEPARATOR_SYMBOL (int)
The monetary grouping separator.

Rounding mode values used by <span class="function">numfmt_get_attribute and <span class="function">numfmt_set_attribute with NumberFormatter::ROUNDING_MODE attribute.

NumberFormatter::ROUND_CEILING (int)
Rounding mode to round towards positive infinity.

NumberFormatter::ROUND_DOWN (int)
Rounding mode to round towards zero.

NumberFormatter::ROUND_FLOOR (int)
Rounding mode to round towards negative infinity.

NumberFormatter::ROUND_HALFDOWN (int)
Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down.

NumberFormatter::ROUND_HALFEVEN (int)
Rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, round towards the even neighbor.

NumberFormatter::ROUND_HALFUP (int)
Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up.

NumberFormatter::ROUND_UP (int)
Rounding mode to round away from zero.

Pad position values used by <span class="function">numfmt_get_attribute and <span class="function">numfmt_set_attribute with NumberFormatter::PADDING_POSITION attribute.

NumberFormatter::PAD_AFTER_PREFIX (int)
Pad characters inserted after the prefix.

NumberFormatter::PAD_AFTER_SUFFIX (int)
Pad characters inserted after the suffix.

NumberFormatter::PAD_BEFORE_PREFIX (int)
Pad characters inserted before the prefix.

NumberFormatter::PAD_BEFORE_SUFFIX (int)
Pad characters inserted before the suffix.

参见

• »  ICU formatting documentation
• » ICU number formatters
• » ICU decimal formatters
• »  ICU rule-based number formatters

NumberFormatter::create

numfmt_create

NumberFormatter::__construct

Create a number formatter

说明

面向对象风格 (method)

public <span class="modifier">static NumberFormatter NumberFormatter::create ( <span class="methodparam">string $locale , int $style [, string $pattern ] )

过程化风格

NumberFormatter <span class="methodname">numfmt_create ( <span class="methodparam">string $locale , int $style [, string $pattern ] )

面向对象风格 (constructor):

public <span class="methodname">NumberFormatter::__construct ( <span class="methodparam">string $locale , int $style [, string $pattern ] )

Creates a number formatter.

参数

locale
Locale in which the number would be formatted (locale name, e.g. en_CA).

style
Style of the formatting, one of the format style constants. If NumberFormatter::PATTERN_DECIMAL or NumberFormatter::PATTERN_RULEBASED is passed then the number format is opened using the given pattern, which must conform to the syntax described in » ICU DecimalFormat documentation or » ICU RuleBasedNumberFormat documentation, respectively.

pattern
Pattern string if the chosen style requires a pattern.

返回值

Returns NumberFormatter object or false on error.

范例

示例 #1 numfmt_create example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
$fmt = numfmt_create( 'it', NumberFormatter::SPELLOUT );
echo numfmt_format($fmt, 1142)."\n";
?>

示例 #2 NumberFormatter::create example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo $fmt->format(1234567.891234567890000)."\n";
$fmt = new NumberFormatter( 'it', NumberFormatter::SPELLOUT );
echo $fmt->format(1142)."\n";
?>

以上例程会输出：

1.234.567,891
millicentoquarantadue

参见

• numfmt_format
• numfmt_parse

NumberFormatter::formatCurrency

numfmt_format_currency

Format a currency value

说明

面向对象风格

public <span class="type">stringfalse <span class="methodname">NumberFormatter::formatCurrency ( <span class="methodparam">float $value , string $currency )

过程化风格

string<span class="type">false <span class="methodname">numfmt_format_currency ( <span class="methodparam">NumberFormatter $fmt , <span class="type">float $value , <span class="methodparam">string $currency )

Format the currency value according to the formatter rules.

参数

fmt
NumberFormatter object.

value
The numeric currency value.

currency
The 3-letter ISO 4217 currency code indicating the currency to use.

返回值

String representing the formatted currency value, 或者在失败时返回 false.

范例

示例 #1 numfmt_format_currency example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::CURRENCY );
echo numfmt_format_currency($fmt, 1234567.891234567890000, "EUR")."\n";
echo numfmt_format_currency($fmt, 1234567.891234567890000, "RUR")."\n";
$fmt = numfmt_create( 'ru_RU', NumberFormatter::CURRENCY );
echo numfmt_format_currency($fmt, 1234567.891234567890000, "EUR")."\n";
echo numfmt_format_currency($fmt, 1234567.891234567890000, "RUR")."\n";
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::CURRENCY );
echo $fmt->formatCurrency(1234567.891234567890000, "EUR")."\n";
echo $fmt->formatCurrency(1234567.891234567890000, "RUR")."\n";
$fmt = new NumberFormatter( 'ru_RU', NumberFormatter::CURRENCY );
echo $fmt->formatCurrency(1234567.891234567890000, "EUR")."\n";
echo $fmt->formatCurrency(1234567.891234567890000, "RUR")."\n";
?>

以上例程会输出：

1.234.567,89 €
1.234.567,89 RUR
1 234 567,89€
1 234 567,89р.

参见

• numfmt_get_error_code
• numfmt_format
• numfmt_parse_currency

NumberFormatter::format

numfmt_format

Format a number

说明

面向对象风格

public string NumberFormatter::format ( <span class="methodparam"><span class="type">intfloat $value [, <span class="type">int $type ] )

过程化风格

string <span class="methodname">numfmt_format ( <span class="methodparam">NumberFormatter $fmt , <span class="type">intfloat $value [, <span class="type">int $type ] )

Format a numeric value according to the formatter rules.

参数

fmt
NumberFormatter object.

value
The value to format. Can be int or <span class="type">float, other values will be converted to a numeric value.

type
The formatting type to use.

返回值

Returns the string containing formatted value, or false on error.

范例

示例 #1 numfmt_format example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
$data = numfmt_format($fmt, 1234567.891234567890000);
if(intl_is_failure(numfmt_format($fmt))) {
    report_error("Formatter error");
}
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
$fmt->format(1234567.891234567890000);
if(intl_is_failure($fmt->getErrorCode())) {
    report_error("Formatter error");
}
?>

以上例程会输出：

1.234.567,891

参见

• numfmt_get_error_code
• numfmt_format_currency
• numfmt_parse

NumberFormatter::getAttribute

numfmt_get_attribute

Get an attribute

说明

面向对象风格

public int <span class="methodname">NumberFormatter::getAttribute ( <span class="methodparam">int $attr )

过程化风格

int <span class="methodname">numfmt_get_attribute ( <span class="methodparam">NumberFormatter $fmt , int $attr )

Get a numeric attribute associated with the formatter. An example of a numeric attribute is the number of integer digits the formatter will produce.

参数

fmt
NumberFormatter object.

attr
Attribute specifier - one of the numeric attribute constants.

返回值

Return attribute value on success, or false on error.

范例

示例 #1 numfmt_get_attribute example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo "Digits: ".numfmt_get_attribute($fmt, NumberFormatter::MAX_FRACTION_DIGITS)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
numfmt_set_attribute($fmt, NumberFormatter::MAX_FRACTION_DIGITS, 2);
echo "Digits: ".numfmt_get_attribute($fmt, NumberFormatter::MAX_FRACTION_DIGITS)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo "Digits: ".$fmt->getAttribute(NumberFormatter::MAX_FRACTION_DIGITS)."\n";
echo $fmt->format(1234567.891234567890000)."\n";
$fmt->setAttribute(NumberFormatter::MAX_FRACTION_DIGITS, 2);
echo "Digits: ".$fmt->getAttribute(NumberFormatter::MAX_FRACTION_DIGITS)."\n";
echo $fmt->format(1234567.891234567890000)."\n";
?>

以上例程会输出：

Digits: 3
1.234.567,891
Digits: 2
1.234.567,89

参见

• numfmt_get_error_code
• numfmt_get_text_attribute
• numfmt_set_attribute

NumberFormatter::getErrorCode

numfmt_get_error_code

Get formatter's last error code

说明

面向对象风格

public int <span class="methodname">NumberFormatter::getErrorCode ( <span class="methodparam">void )

过程化风格

int <span class="methodname">numfmt_get_error_code ( <span class="methodparam">NumberFormatter $fmt )

Get error code from the last function performed by the formatter.

参数

fmt
NumberFormatter object.

返回值

Returns error code from last formatter call.

范例

示例 #1 numfmt_get_error_code example

<?php
$fmt  = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
$data = numfmt_format($fmt, 1234567.891234567890000);
if(intl_is_failure(numfmt_get_error_code($fmt))) {
    report_error("Formatter error");
}
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
$fmt->format(1234567.891234567890000);
if(intl_is_failure($fmt->getErrorCode())) {
    report_error("Formatter error");
}
?>

参见

• numfmt_get_error_message
• intl_get_error_code
• intl_is_failure

NumberFormatter::getErrorMessage

numfmt_get_error_message

Get formatter's last error message

说明

面向对象风格

public string NumberFormatter::getErrorMessage ( <span class="methodparam">void )

过程化风格

string <span class="methodname">numfmt_get_error_message ( <span class="methodparam">NumberFormatter $fmt )

Get error message from the last function performed by the formatter.

参数

fmt
NumberFormatter object.

返回值

Returns error message from last formatter call.

范例

示例 #1 numfmt_get_error_message example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
$data = numfmt_format($fmt, 1234567.891234567890000);
var_dump(numfmt_get_error_message($fmt));
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
$fmt->format(1234567.891234567890000);
var_dump(numfmt_get_error_message($fmt));
?>

参见

• numfmt_get_error_code
• intl_get_error_code
• intl_is_failure

NumberFormatter::getLocale

numfmt_get_locale

Get formatter locale

说明

面向对象风格

public string NumberFormatter::getLocale ([ <span class="methodparam">int $type ] )

过程化风格

string <span class="methodname">numfmt_get_locale ( <span class="methodparam">NumberFormatter $fmt [, <span class="type">int $type ] )

Get formatter locale name.

参数

fmt
NumberFormatter object.

type
You can choose between valid and actual locale ( Locale::VALID_LOCALE, Locale::ACTUAL_LOCALE, respectively). The default is the actual locale.

返回值

The locale name used to create the formatter.

范例

示例 #1 numfmt_get_locale example

<?php
$req     = 'fr_FR_PARIS';
$fmt     = numfmt_create( $req,  NumberFormatter::DECIMAL);
$res_val = numfmt_get_locale( $fmt, Locale::VALID_LOCALE );
$res_act = numfmt_get_locale( $fmt, Locale::ACTUAL_LOCALE );
printf( "Requested locale name: %s\nValid locale name: %s\nActual locale name: %s\n",
         $req, $res_val, $res_act );
?>

以上例程会输出：

Requested locale name: fr_FR_PARIS
Valid locale name: fr_FR
Actual locale name: fr

参见

• numfmt_create
• numfmt_get_error_code

NumberFormatter::getPattern

numfmt_get_pattern

Get formatter pattern

说明

面向对象风格

public string NumberFormatter::getPattern ( <span class="methodparam">void )

过程化风格

string <span class="methodname">numfmt_get_pattern ( <span class="methodparam">NumberFormatter $fmt )

Extract pattern used by the formatter.

参数

fmt
NumberFormatter object.

返回值

Pattern string that is used by the formatter, or false if an error happens.

范例

示例 #1 numfmt_get_pattern example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo "Pattern: ".numfmt_get_pattern($fmt)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
numfmt_set_pattern($fmt, "#0.# kg");
echo "Pattern: ".numfmt_get_pattern($fmt)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo "Pattern: ".$fmt->getPattern()."\n";
echo $fmt->format(1234567.891234567890000)."\n";
$fmt->setPattern("#0.# kg");
echo "Pattern: ".$fmt->getPattern()."\n";
echo $fmt->format(1234567.891234567890000)."\n";
?>

以上例程会输出：

Pattern: #,##0.###
1.234.567,891
Pattern: #0.# kg
1234567,9 kg

参见

• numfmt_get_error_code
• numfmt_set_pattern
• numfmt_create

NumberFormatter::getSymbol

numfmt_get_symbol

Get a symbol value

说明

面向对象风格

public string NumberFormatter::getSymbol ( <span class="methodparam">int $attr )

过程化风格

string <span class="methodname">numfmt_get_symbol ( <span class="methodparam">NumberFormatter $fmt , int $attr )

Get a symbol associated with the formatter. The formatter uses symbols to represent the special locale-dependent characters in a number, for example the percent sign. This API is not supported for rule-based formatters.

参数

fmt
NumberFormatter object.

attr
Symbol specifier, one of the format symbol constants.

返回值

The symbol string or false on error.

范例

示例 #1 numfmt_get_symbol example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo "Sep: ".numfmt_get_symbol($fmt, NumberFormatter::GROUPING_SEPARATOR_SYMBOL)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
numfmt_set_symbol($fmt, NumberFormatter::GROUPING_SEPARATOR_SYMBOL, "*");
echo "Sep: ".numfmt_get_symbol($fmt, NumberFormatter::GROUPING_SEPARATOR_SYMBOL)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo "Sep: ".$fmt->getSymbol(NumberFormatter::GROUPING_SEPARATOR_SYMBOL)."\n";
echo $fmt->format(1234567.891234567890000)."\n";
$fmt->setSymbol(NumberFormatter::GROUPING_SEPARATOR_SYMBOL, "*");
echo "Sep: ".$fmt->getSymbol(NumberFormatter::GROUPING_SEPARATOR_SYMBOL)."\n";
echo $fmt->format(1234567.891234567890000)."\n";
?>

以上例程会输出：

Sep: .
1.234.567,891
Sep: *
1*234*567,891

参见

• numfmt_get_error_code
• numfmt_set_symbol

NumberFormatter::getTextAttribute

numfmt_get_text_attribute

Get a text attribute

说明

面向对象风格

public string NumberFormatter::getTextAttribute ( int $attr )

过程化风格

string <span class="methodname">numfmt_get_text_attribute ( <span class="methodparam">NumberFormatter $fmt , int $attr )

Get a text attribute associated with the formatter. An example of a text attribute is the suffix for positive numbers. If the formatter does not understand the attribute, U_UNSUPPORTED_ERROR error is produced. Rule-based formatters only understand NumberFormatter::DEFAULT_RULESET and NumberFormatter::PUBLIC_RULESETS.

参数

fmt
NumberFormatter object.

attr
Attribute specifier - one of the text attribute constants.

返回值

Return attribute value on success, or false on error.

范例

示例 #1 numfmt_get_text_attribute example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo "Prefix: ".numfmt_get_text_attribute($fmt, NumberFormatter::NEGATIVE_PREFIX)."\n";
echo numfmt_format($fmt, -1234567.891234567890000)."\n";
numfmt_set_text_attribute($fmt, NumberFormatter::NEGATIVE_PREFIX, "MINUS");
echo "Prefix: ".numfmt_get_text_attribute($fmt, NumberFormatter::NEGATIVE_PREFIX)."\n";
echo numfmt_format($fmt, -1234567.891234567890000)."\n";
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo "Prefix: ".$fmt->getTextAttribute(NumberFormatter::NEGATIVE_PREFIX)."\n";
echo $fmt->format(-1234567.891234567890000)."\n";
$fmt->setTextAttribute(NumberFormatter::NEGATIVE_PREFIX, "MINUS");
echo "Prefix: ".$fmt->getTextAttribute(NumberFormatter::NEGATIVE_PREFIX)."\n";
echo $fmt->format(-1234567.891234567890000)."\n";
?>

以上例程会输出：

Prefix: -
-1.234.567,891
Prefix: MINUS
MINUS1.234.567,891

参见

• numfmt_get_error_code
• numfmt_get_attribute
• numfmt_set_text_attribute

NumberFormatter::parseCurrency

numfmt_parse_currency

Parse a currency number

说明

面向对象风格

public float NumberFormatter::parseCurrency ( <span class="methodparam">string $value , string &$currency [, <span class="type">int &$position ] )

过程化风格

float <span class="methodname">numfmt_parse_currency ( <span class="methodparam">NumberFormatter $fmt , <span class="type">string $value , <span class="methodparam">string &$currency [, int &$position ] )

Parse a string into a double and a currency using the current formatter.

参数

fmt
NumberFormatter object.

currency
Parameter to receive the currency name (3-letter ISO 4217 currency code).

position
Offset in the string at which to begin parsing. On return, this value will hold the offset at which parsing ended.

返回值

The parsed numeric value or false on error.

范例

示例 #1 numfmt_parse_currency example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::CURRENCY );
$num = "1.234.567,89\xc2\xa0$";
echo "We have ".numfmt_parse_currency($fmt, $num, $curr)." in $curr\n";
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::CURRENCY );
$num = "1.234.567,89\xc2\xa0$";
echo "We have ".$fmt->parseCurrency($num, $curr)." in $curr\n";
?>

以上例程会输出：

We have 1234567.89 in USD

参见

• numfmt_get_error_code
• numfmt_parse
• numfmt_format_currency

NumberFormatter::parse

numfmt_parse

Parse a number

说明

面向对象风格

public mixed NumberFormatter::parse ( <span class="methodparam">string $value [, int $type [, int &$position ]] )

过程化风格

mixed <span class="methodname">numfmt_parse ( <span class="methodparam">NumberFormatter $fmt , <span class="type">string $value [, <span class="methodparam">int $type [, int &$position ]] )

Parse a string into a number using the current formatter rules.

参数

fmt
NumberFormatter object.

type
The formatting type to use. By default, NumberFormatter::TYPE_DOUBLE is used.

position
Offset in the string at which to begin parsing. On return, this value will hold the offset at which parsing ended.

返回值

The value of the parsed number or false on error.

范例

示例 #1 numfmt_parse example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
$num = "1.234.567,891";
echo numfmt_parse($fmt, $num)."\n";
echo numfmt_parse($fmt, $num, NumberFormatter::TYPE_INT32)."\n";
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
$num = "1.234.567,891";
echo $fmt->parse($num)."\n";
echo $fmt->parse($num, NumberFormatter::TYPE_INT32)."\n";
?>

以上例程会输出：

1234567.891
1234567

参见

• numfmt_get_error_code
• numfmt_format
• numfmt_parse_currency

NumberFormatter::setAttribute

numfmt_set_attribute

Set an attribute

说明

面向对象风格

public bool NumberFormatter::setAttribute ( <span class="methodparam">int $attr , <span class="methodparam">int $value )

过程化风格

bool <span class="methodname">numfmt_set_attribute ( <span class="methodparam">NumberFormatter $fmt , int $attr , int $value )

Set a numeric attribute associated with the formatter. An example of a numeric attribute is the number of integer digits the formatter will produce.

参数

fmt
NumberFormatter object.

attr
Attribute specifier - one of the numeric attribute constants.

value
The attribute value.

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 numfmt_set_attribute example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo "Digits: ".numfmt_get_attribute($fmt, NumberFormatter::MAX_FRACTION_DIGITS)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
numfmt_set_attribute($fmt, NumberFormatter::MAX_FRACTION_DIGITS, 2);
echo "Digits: ".numfmt_get_attribute($fmt, NumberFormatter::MAX_FRACTION_DIGITS)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo "Digits: ".$fmt->getAttribute(NumberFormatter::MAX_FRACTION_DIGITS)."\n";
echo $fmt->format(1234567.891234567890000)."\n";
$fmt->setAttribute(NumberFormatter::MAX_FRACTION_DIGITS, 2);
echo "Digits: ".$fmt->getAttribute(NumberFormatter::MAX_FRACTION_DIGITS)."\n";
echo $fmt->format(1234567.891234567890000)."\n";
?>

以上例程会输出：

Digits: 3
1.234.567,891
Digits: 2
1.234.567,89

参见

• numfmt_get_error_code
• numfmt_get_attribute
• numfmt_set_text_attribute

NumberFormatter::setPattern

numfmt_set_pattern

Set formatter pattern

说明

面向对象风格

public bool NumberFormatter::setPattern ( <span class="methodparam">string $pattern )

过程化风格

bool <span class="methodname">numfmt_set_pattern ( <span class="methodparam">NumberFormatter $fmt , <span class="type">string $pattern )

Set the pattern used by the formatter. Can not be used on a rule-based formatter.

参数

fmt
NumberFormatter object.

pattern
Pattern in syntax described in » ICU DecimalFormat documentation.

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 numfmt_set_pattern example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo "Pattern: ".numfmt_get_pattern($fmt)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
numfmt_set_pattern($fmt, "#0.# kg");
echo "Pattern: ".numfmt_get_pattern($fmt)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo "Pattern: ".$fmt->getPattern()."\n";
echo $fmt->format(1234567.891234567890000)."\n";
$fmt->setPattern("#0.# kg");
echo "Pattern: ".$fmt->getPattern()."\n";
echo $fmt->format(1234567.891234567890000)."\n";
?>

以上例程会输出：

Pattern: #,##0.###
1.234.567,891
Pattern: #0.# kg
1234567,9 kg

参见

• numfmt_get_error_code
• numfmt_create
• numfmt_get_pattern

NumberFormatter::setSymbol

numfmt_set_symbol

Set a symbol value

说明

面向对象风格

public bool NumberFormatter::setSymbol ( <span class="methodparam">int $attr , <span class="methodparam">string $value )

过程化风格

bool <span class="methodname">numfmt_set_symbol ( <span class="methodparam">NumberFormatter $fmt , int $attr , <span class="type">string $value )

Set a symbol associated with the formatter. The formatter uses symbols to represent the special locale-dependent characters in a number, for example the percent sign. This API is not supported for rule-based formatters.

参数

fmt
NumberFormatter object.

attr
Symbol specifier, one of the format symbol constants.

value
Text for the symbol.

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 numfmt_set_symbol example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo "Sep: ".numfmt_get_symbol($fmt, NumberFormatter::GROUPING_SEPARATOR_SYMBOL)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
numfmt_set_symbol($fmt, NumberFormatter::GROUPING_SEPARATOR_SYMBOL, "*");
echo "Sep: ".numfmt_get_symbol($fmt, NumberFormatter::GROUPING_SEPARATOR_SYMBOL)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo "Sep: ".$fmt->getSymbol(NumberFormatter::GROUPING_SEPARATOR_SYMBOL)."\n";
echo $fmt->format(1234567.891234567890000)."\n";
$fmt->setSymbol(NumberFormatter::GROUPING_SEPARATOR_SYMBOL, "*");
echo "Sep: ".$fmt->getSymbol(NumberFormatter::GROUPING_SEPARATOR_SYMBOL)."\n";
echo $fmt->format(1234567.891234567890000)."\n";
?>

以上例程会输出：

Sep: .
1.234.567,891
Sep: *
1*234*567,891

参见

• numfmt_get_error_code
• numfmt_get_symbol

NumberFormatter::setTextAttribute

numfmt_set_text_attribute

Set a text attribute

说明

面向对象风格

public bool NumberFormatter::setTextAttribute ( int $attr , string $value )

过程化风格

bool <span class="methodname">numfmt_set_text_attribute ( <span class="methodparam">NumberFormatter $fmt , int $attr , <span class="type">string $value )

Set a text attribute associated with the formatter. An example of a text attribute is the suffix for positive numbers. If the formatter does not understand the attribute, U_UNSUPPORTED_ERROR error is produced. Rule-based formatters only understand NumberFormatter::DEFAULT_RULESET and NumberFormatter::PUBLIC_RULESETS.

参数

fmt
NumberFormatter object.

attr
Attribute specifier - one of the text attribute constants.

value
Text for the attribute value.

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 numfmt_set_text_attribute example

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo "Prefix: ".numfmt_get_text_attribute($fmt, NumberFormatter::NEGATIVE_PREFIX)."\n";
echo numfmt_format($fmt, -1234567.891234567890000)."\n";
numfmt_set_text_attribute($fmt, NumberFormatter::NEGATIVE_PREFIX, "MINUS");
echo "Prefix: ".numfmt_get_text_attribute($fmt, NumberFormatter::NEGATIVE_PREFIX)."\n";
echo numfmt_format($fmt, -1234567.891234567890000)."\n";
?>

示例 #2 OO example

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo "Prefix: ".$fmt->getTextAttribute(NumberFormatter::NEGATIVE_PREFIX)."\n";
echo $fmt->format(-1234567.891234567890000)."\n";
$fmt->setTextAttribute(NumberFormatter::NEGATIVE_PREFIX, "MINUS");
echo "Prefix: ".$fmt->getTextAttribute(NumberFormatter::NEGATIVE_PREFIX)."\n";
echo $fmt->format(-1234567.891234567890000)."\n";
?>

以上例程会输出：

Prefix: -
-1.234.567,891
Prefix: MINUS
MINUS1.234.567,891

参见

• numfmt_get_error_code
• numfmt_get_text_attribute
• numfmt_set_attribute

简介

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.

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.

类摘要

Locale

class Locale {

/* 方法 */

public <span class="modifier">static string <span class="methodname">acceptFromHttp ( <span class="methodparam">string $header )

public <span class="modifier">static string <span class="methodname">canonicalize ( <span class="type">string $locale )

public <span class="modifier">static string <span class="methodname">composeLocale ( <span class="methodparam">array $subtags )

public <span class="modifier">static bool <span class="methodname">filterMatches ( <span class="methodparam">string $langtag , string $locale [, <span class="type">bool $canonicalize = false ] )

public <span class="modifier">static array <span class="methodname">getAllVariants ( <span class="methodparam">string $locale )

public <span class="modifier">static string <span class="methodname">getDefault ( <span class="methodparam">void )

public <span class="modifier">static string <span class="methodname">getDisplayLanguage ( <span class="methodparam">string $locale [, string $in_locale ] )

public <span class="modifier">static string <span class="methodname">getDisplayName ( <span class="methodparam">string $locale [, string $in_locale ] )

public <span class="modifier">static string <span class="methodname">getDisplayRegion ( <span class="methodparam">string $locale [, string $in_locale ] )

public <span class="modifier">static string <span class="methodname">getDisplayScript ( <span class="methodparam">string $locale [, string $in_locale ] )

public <span class="modifier">static string <span class="methodname">getDisplayVariant ( <span class="methodparam">string $locale [, string $in_locale ] )

public <span class="modifier">static array <span class="methodname">getKeywords ( <span class="type">string $locale )

public <span class="modifier">static string <span class="methodname">getPrimaryLanguage ( <span class="methodparam">string $locale )

public <span class="modifier">static string <span class="methodname">getRegion ( <span class="type">string $locale )

public <span class="modifier">static string <span class="methodname">getScript ( <span class="type">string $locale )

public <span class="modifier">static string <span class="methodname">lookup ( <span class="type">array $langtag , <span class="methodparam">string $locale [, bool $canonicalize = false [, string $default ]] )

public <span class="modifier">static array <span class="methodname">parseLocale ( <span class="type">string $locale )

public <span class="modifier">static bool <span class="methodname">setDefault ( <span class="type">string $locale )

}

预定义常量

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 (string)
This is locale the data actually comes from.

Locale::VALID_LOCALE (string)
This is the most specific locale supported by ICU.

These constants define how the Locales are parsed or composed. They should be used as keys in the argument array to <span class="function">locale_compose and are returned from <span class="function">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

参见

• » RFC 4646 - Tags for Identifying Languages
• » RFC 4647 - Matching of Language Tags
• » Unicode CLDR Project:Common Locale Data Repository
• » IANA Language Subtags Registry
• » ICU User Guide - Locale
• » ICU Locale api

Locale::acceptFromHttp

locale_accept_from_http

Tries to find out best available locale based on HTTP "Accept-Language" header

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::acceptFromHttp ( <span class="methodparam">string $header )

过程化风格

string <span class="methodname">locale_accept_from_http ( <span class="methodparam">string $header )

Tries to find locale that can satisfy the language list that is requested by the HTTP "Accept-Language" header.

参数

header
The string containing the "Accept-Language" header according to format in RFC 2616.

返回值

The corresponding locale identifier.

范例

示例 #1 locale_accept_from_http example

<?php
$locale = locale_accept_from_http($_SERVER['HTTP_ACCEPT_LANGUAGE']);
echo $locale;
?>

示例 #2 OO example

<?php
$locale = Locale::acceptFromHttp($_SERVER['HTTP_ACCEPT_LANGUAGE']);
echo $locale;
?>

以上例程会输出：

en_US

参见

• locale_lookup

Locale::canonicalize

locale_canonicalize

Canonicalize the locale string

说明

public <span class="modifier">static string <span class="methodname">Locale::canonicalize ( <span class="methodparam">string $locale )

Warning

本函数还未编写文档，仅有参数列表。

参数

locale

返回值

Locale::composeLocale

locale_compose

Returns a correctly ordered and delimited locale ID

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::composeLocale ( <span class="methodparam">array $subtags )

过程化风格

string <span class="methodname">locale_compose ( <span class="methodparam">array $subtags )

Returns a correctly ordered and delimited locale ID the keys identify the particular locale ID subtags, and the values are the associated subtag values.

参数

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.

Note:

The 'variant' and 'private' subtags can take maximum 15 values whereas 'extlang' can take maximum 3 values.e.g. Variants are allowed with the suffix ranging from 0-14. Hence the keys for the input array can be variant0, variant1, ...,variant14. In the returned locale id, the subtag is ordered by suffix resulting in variant0 followed by variant1 followed by variant2 and so on.

The 'variant', 'private' and 'extlang' multiple values can be specified both as array under specific key (e.g. 'variant') and as multiple numbered keys (e.g. 'variant0', 'variant1', etc.).

返回值

The corresponding locale identifier.

范例

示例 #1 locale_compose example

<?php
$arr = array(
    'language'=>'en' ,
    'script'  =>'Hans' ,
    'region'  =>'CN',
    'variant2'=>'rozaj' ,
    'variant1'=>'nedis' ,
    'private1'=>'prv1' ,
    'private2'=>'prv2'
);
echo locale_compose( $arr );
?>

示例 #2 OO example

<?php
$arr = array(
    'language'=>'en' ,
    'script'  =>'Hans' ,
    'region'  =>'CN',
    'variant2'=>'rozaj' ,
    'variant1'=>'nedis' ,
    'private1'=>'prv1' ,
    'private2'=>'prv2'
);
echo Locale::composeLocale( $arr );
?>

以上例程会输出：

Locale: en_Hans_CN_nedis_rozaj_x_prv1_prv2

参见

• locale_parse

Locale::filterMatches

locale_filter_matches

Checks if a language tag filter matches with locale

说明

面向对象风格

public <span class="modifier">static bool <span class="methodname">Locale::filterMatches ( <span class="methodparam">string $langtag , string $locale [, <span class="type">bool $canonicalize = false ] )

过程化风格

bool <span class="methodname">locale_filter_matches ( <span class="methodparam">string $langtag , string $locale [, <span class="type">bool $canonicalize = false ] )

Checks if a $langtag filter matches with $locale according to RFC 4647's basic filtering algorithm

参数

langtag
The language tag to check

locale
The language range to check against

canonicalize
If true, the arguments will be converted to canonical form before matching.

返回值

true if $locale matches $langtag false otherwise.

范例

示例 #1 locale_filter_matches example

<?php
echo (locale_filter_matches('de-DEVA','de-DE', false)) ? "Matches" : "Does not match"; 
echo '; ';
echo (locale_filter_matches('de-DE_1996','de-DE', false)) ? "Matches" : "Does not match"; 
?>

示例 #2 OO example

<?php
echo (Locale::filterMatches('de-DEVA','de-DE', false)) ? "Matches" : "Does not match"; 
echo '; ';
echo (Locale::filterMatches('de-DE-1996','de-DE', false)) ? "Matches" : "Does not match"; 
?>

以上例程会输出：

Does not match; Matches

参见

• locale_lookup

Locale::getAllVariants

locale_get_all_variants

Gets the variants for the input locale

说明

面向对象风格

public <span class="modifier">static array <span class="methodname">Locale::getAllVariants ( <span class="methodparam">string $locale )

过程化风格

array <span class="methodname">locale_get_all_variants ( <span class="methodparam">string $locale )

Gets the variants for the input locale

参数

locale
The locale to extract the variants from

返回值

The array containing the list of all variants subtag for the locale or null if not present

范例

示例 #1 locale_get_all_variants example

<?php
$arr = locale_get_all_variants('sl_IT_NEDIS_ROJAZ_1901');
var_export( $arr );
?>

示例 #2 OO example

<?php
 $arr = Locale::getAllVariants('sl_IT_NEDIS_ROJAZ_1901');
 var_export( $arr );
?>

以上例程会输出：

array (
    0 => 'NEDIS',
    1 => 'ROJAZ',
    2 => '1901',
)

参见

• locale_get_primary_language
• locale_get_script
• locale_get_region

Locale::getDefault

locale_get_default

Gets the default locale value from the INTL global 'default_locale'

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::getDefault ( <span class="methodparam">void )

过程化风格

string <span class="methodname">locale_get_default ( <span class="methodparam">void )

Gets the default locale value. At the PHP initialization this value is set to 'intl.default_locale' value from php.ini if that value exists or from ICU's function uloc_getDefault().

参数

返回值

The current runtime locale

范例

示例 #1 locale_get_default example

<?php
ini_set('intl.default_locale', 'de-DE');
echo locale_get_default();
echo '; ';
locale_set_default('fr');
echo locale_get_default();
?>

示例 #2 OO example

<?php
ini_set('intl.default_locale', 'de-DE');
echo Locale::getDefault();
echo '; ';
Locale::setDefault('fr');
echo Locale::getDefault();
?>

以上例程会输出：

de-DE; fr

参见

• locale_set_default

Locale::getDisplayLanguage

locale_get_display_language

Returns an appropriately localized display name for language of the inputlocale

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::getDisplayLanguage ( <span class="methodparam">string $locale [, string $in_locale ] )

过程化风格

string <span class="methodname">locale_get_display_language ( <span class="methodparam">string $locale [, string $in_locale ] )

Returns an appropriately localized display name for language of the input locale. If is null then the default locale is used.

参数

locale
The locale to return a display language for

in_locale
Optional format locale to use to display the language name

返回值

display name of the language for the $locale in the format appropriate for $in_locale.

范例

示例 #1 locale_get_display_language example

<?php
echo locale_get_display_language('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo locale_get_display_language('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo locale_get_display_language('sl-Latn-IT-nedis', 'de');
?>

示例 #2 OO example

<?php
echo Locale::getDisplayLanguage('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo Locale::getDisplayLanguage('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo Locale::getDisplayLanguage('sl-Latn-IT-nedis', 'de');
?>

以上例程会输出：

Slovenian;
slov\xc3\xa8ne;
Slowenisch

参见

• locale_get_display_name
• locale_get_display_script
• locale_get_display_region
• locale_get_display_variant

Locale::getDisplayName

locale_get_display_name

Returns an appropriately localized display name for the input locale

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::getDisplayName ( <span class="methodparam">string $locale [, string $in_locale ] )

过程化风格

string <span class="methodname">locale_get_display_name ( <span class="methodparam">string $locale [, string $in_locale ] )

Returns an appropriately localized display name for the input locale. If $locale is null then the default locale is used.

参数

locale
The locale to return a display name for.

in_locale
optional format locale

返回值

Display name of the locale in the format appropriate for $in_locale.

范例

示例 #1 locale_get_display_name example

<?php
echo locale_get_display_name('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo locale_get_display_name('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo locale_get_display_name('sl-Latn-IT-nedis', 'de');
?>

示例 #2 OO example

<?php
echo Locale::getDisplayName('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo Locale::getDisplayName('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo Locale::getDisplayName('sl-Latn-IT-nedis', 'de');
?>

以上例程会输出：

Slovenian (Latin, Italy, Natisone dialect);
slov\xc3\xa8ne (latin, Italie, dialecte de Natisone;
Slowenisch (Lateinisch, Italien, NEDIS)

参见

• locale_get_display_language
• locale_get_display_script
• locale_get_display_region
• locale_get_display_variant

Locale::getDisplayRegion

locale_get_display_region

Returns an appropriately localized display name for region of the input locale

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::getDisplayRegion ( <span class="methodparam">string $locale [, string $in_locale ] )

过程化风格

string <span class="methodname">locale_get_display_region ( <span class="methodparam">string $locale [, string $in_locale ] )

Returns an appropriately localized display name for region of the input locale. If is null then the default locale is used.

参数

locale
The locale to return a display region for.

in_locale
Optional format locale to use to display the region name

返回值

display name of the region for the $locale in the format appropriate for $in_locale.

范例

示例 #1 locale_get_display_region example

<?php
echo locale_get_display_region('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo locale_get_display_region('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo locale_get_display_region('sl-Latn-IT-nedis', 'de');
?>

示例 #2 OO example

<?php
echo Locale::getDisplayRegion('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo Locale::getDisplayRegion('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo Locale::getDisplayRegion('sl-Latn-IT-nedis', 'de');
?>

以上例程会输出：

Italy;
Italie;
Italien

参见

• locale_get_display_name
• locale_get_display_language
• locale_get_display_script
• locale_get_display_variant

Locale::getDisplayScript

locale_get_display_script

Returns an appropriately localized display name for script of the input locale

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::getDisplayScript ( <span class="methodparam">string $locale [, string $in_locale ] )

过程化风格

string <span class="methodname">locale_get_display_script ( <span class="methodparam">string $locale [, string $in_locale ] )

Returns an appropriately localized display name for script of the input locale. If is null then the default locale is used.

参数

locale
The locale to return a display script for

in_locale
Optional format locale to use to display the script name

返回值

Display name of the script for the $locale in the format appropriate for $in_locale.

范例

示例 #1 locale_get_display_script example

<?php
echo locale_get_display_script('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo locale_get_display_script('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo locale_get_display_script('sl-Latn-IT-nedis', 'de');
?>

示例 #2 OO example

<?php
echo Locale::getDisplayScript('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo Locale::getDisplayScript('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo Locale::getDisplayScript('sl-Latn-IT-nedis', 'de');
?>

以上例程会输出：

Latin;
latin;
Lateinisch

参见

• locale_get_display_name
• locale_get_display_language
• locale_get_display_region
• locale_get_display_variant

Locale::getDisplayVariant

locale_get_display_variant

Returns an appropriately localized display name for variants of the input locale

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::getDisplayVariant ( <span class="methodparam">string $locale [, string $in_locale ] )

过程化风格

string <span class="methodname">locale_get_display_variant ( <span class="methodparam">string $locale [, string $in_locale ] )

Returns an appropriately localized display name for variants of the input locale. If is null then the default locale is used.

参数

locale
The locale to return a display variant for

in_locale
Optional format locale to use to display the variant name

返回值

Display name of the variant for the $locale in the format appropriate for $in_locale.

范例

示例 #1 locale_get_display_variant example

<?php
echo locale_get_display_variant('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo locale_get_display_variant('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo locale_get_display_variant('sl-Latn-IT-nedis', 'de');
?>

示例 #2 OO example

<?php
echo Locale::getDisplayVariant('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo Locale::getDisplayVariant('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo Locale::getDisplayVariant('sl-Latn-IT-nedis', 'de');
?>

以上例程会输出：

Natisone dialect;
dialecte de Natisone;
NEDIS

参见

• locale_get_display_name
• locale_get_display_language
• locale_get_display_script
• locale_get_display_region

Locale::getKeywords

locale_get_keywords

Gets the keywords for the input locale

说明

面向对象风格

public <span class="modifier">static array <span class="methodname">Locale::getKeywords ( <span class="methodparam">string $locale )

过程化风格

array <span class="methodname">locale_get_keywords ( <span class="methodparam">string $locale )

Gets the keywords for the input locale.

参数

locale
The locale to extract the keywords from

返回值

Associative array containing the keyword-value pairs for this locale

范例

示例 #1 locale_get_keywords example

<?php
$keywords_arr = locale_get_keywords('de_DE@currency=EUR;collation=PHONEBOOK');
if ($keywords_arr) {
    foreach ($keywords_arr as $key => $value) {
        echo "$key = $value\n"; 
    }
}
?>

示例 #2 OO example

<?php
$keywords_arr = Locale::getKeywords('de_DE@currency=EUR;collation=PHONEBOOK');
if ($keywords_arr) {
    foreach ($keywords_arr as $key => $value) {
        echo "$key = $value\n"; 
    }
}
?>

以上例程会输出：

collation = PHONEBOOK
currency = EUR

参见

• locale_get_all_variants

Locale::getPrimaryLanguage

locale_get_primary_language

Gets the primary language for the input locale

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::getPrimaryLanguage ( <span class="methodparam">string $locale )

过程化风格

string <span class="methodname">locale_get_primary_language ( <span class="methodparam">string $locale )

Gets the primary language for the input locale

参数

locale
The locale to extract the primary language code from

返回值

The language code associated with the language or null in case of error.

范例

示例 #1 locale_get_primary_language example

<?php
echo locale_get_primary_language('zh-Hant');
?>

示例 #2 OO example

<?php
echo Locale::getPrimaryLanguage('zh-Hant');
?>

以上例程会输出：

zh

参见

• locale_get_script
• locale_get_region
• locale_get_all_variants

Locale::getRegion

locale_get_region

Gets the region for the input locale

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::getRegion ( <span class="methodparam">string $locale )

过程化风格

string <span class="methodname">locale_get_region ( <span class="methodparam">string $locale )

Gets the region for the input locale.

参数

locale
The locale to extract the region code from

返回值

The region subtag for the locale or null if not present

范例

示例 #1 locale_get_region example

<?php
echo locale_get_region('de-CH-1901');
?>

示例 #2 OO example

<?php
echo Locale::getRegion('de-CH-1901');
?>

以上例程会输出：

CH

参见

• locale_get_primary_language
• locale_get_script
• locale_get_all_variants

Locale::getScript

locale_get_script

Gets the script for the input locale

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::getScript ( <span class="methodparam">string $locale )

过程化风格

string <span class="methodname">locale_get_script ( <span class="methodparam">string $locale )

Gets the script for the input locale.

参数

locale
The locale to extract the script code from

返回值

The script subtag for the locale or null if not present

范例

示例 #1 locale_get_script example

<?php
echo locale_get_script('sr-Cyrl');
?>

示例 #2 OO example

<?php
echo Locale::getScript('sr-Cyrl');
?>

以上例程会输出：

Cyrl

参见

• locale_get_primary_language
• locale_get_region
• locale_get_all_variants

Locale::lookup

locale_lookup

Searches the language tag list for the best match to the language

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Locale::lookup ( <span class="methodparam">array $langtag , string $locale [, <span class="type">bool $canonicalize = false [, <span class="type">string $default ]] )

过程化风格

string <span class="methodname">locale_lookup ( <span class="methodparam">array $langtag , string $locale [, <span class="type">bool $canonicalize = false [, <span class="type">string $default ]] )

Searches the items in langtag for the best match to the language range specified in locale according to RFC 4647's lookup algorithm.

参数

langtag
An array containing a list of language tags to compare to locale. Maximum 100 items allowed.

locale
The locale to use as the language range when matching.

canonicalize
If true, the arguments will be converted to canonical form before matching.

default
The locale to use if no match is found.

返回值

The closest matching language tag or default value.

范例

示例 #1 locale_lookup example

<?php
$arr = array(
    'de-DEVA',
    'de-DE-1996',
    'de',
    'de-De'
);
echo locale_lookup($arr, 'de-DE-1996-x-prv1-prv2', true, 'en_US');
?>

示例 #2 OO example

<?php
$arr = array(
    'de-DEVA',
    'de-DE-1996',
    'de',
    'de-De'
);
echo Locale::lookup($arr, 'de-DE-1996-x-prv1-prv2', true, 'en_US');
?>

以上例程会输出：

de_de_1996

参见

• locale_filter_matches

Locale::parseLocale

locale_parse

Returns a key-value array of locale ID subtag elements

说明

面向对象风格

public <span class="modifier">static array <span class="methodname">Locale::parseLocale ( <span class="methodparam">string $locale )

过程化风格

array <span class="methodname">locale_parse ( <span class="methodparam">string $locale )

Returns a key-value array of locale ID subtag elements.

参数

locale
The locale to extract the subtag array from. Note: The 'variant' and 'private' subtags can take maximum 15 values whereas 'extlang' can take maximum 3 values.

返回值

Returns 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. The array will be ordered as the locale id subtags e.g. in the locale id if variants are '-varX-varY-varZ' then the returned array will have variant0=>varX , variant1=>varY , variant2=>varZ

Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.

范例

示例 #1 locale_parse example

<?php
$arr = locale_parse('sl-Latn-IT-nedis');
if ($arr) {
    foreach ($arr as $key => $value) {
        echo "$key : $value , ";
    }
}
?>

示例 #2 OO example

<?php
$arr = Locale::parseLocale('sl-Latn-IT-nedis');
if ($arr) {
    foreach ($arr as $key => $value) {
        echo "$key : $value , ";
    }
}
?>

以上例程会输出：

language : sl , script : Latn , region : IT , variant0 : NEDIS ,

参见

• locale_compose

Locale::setDefault

locale_set_default

Sets the default runtime locale

说明

面向对象风格

public <span class="modifier">static bool <span class="methodname">Locale::setDefault ( <span class="methodparam">string $locale )

过程化风格

bool <span class="methodname">locale_set_default ( <span class="methodparam">string $locale )

Sets the default runtime locale to $locale. This changes the value of INTL global 'default_locale' locale identifier. UAX #35 extensions are accepted.

参数

locale
Is a BCP 47 compliant language tag.

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 locale_set_default example

<?php
locale_set_default('de-DE');
echo locale_get_default();
?>

示例 #2 OO example

<?php
Locale::setDefault('de-DE');
echo Locale::getDefault();
?>

以上例程会输出：

de-DE

参见

• locale_get_default

简介

Normalization is a process that involves transforming characters and sequences of characters into a formally-defined underlying representation. This process is most important when text needs to be compared for sorting and searching, but it is also used when storing text to ensure that the text is stored in a consistent representation.

The Unicode Consortium has defined a number of normalization forms reflecting the various needs of applications:

• Normalization Form D (NFD) - Canonical Decomposition
• Normalization Form C (NFC) - Canonical Decomposition followed by Canonical Composition
• Normalization Form KD (NFKD) - Compatibility Decomposition
• Normalization Form KC (NFKC) - Compatibility Decomposition followed by Canonical Composition

The different forms are defined in terms of a set of transformations on the text, transformations that are expressed by both an algorithm and a set of data files.

类摘要

Normalizer

class Normalizer {

/* 方法 */

public <span class="modifier">static string <span class="methodname">getRawDecomposition ( <span class="methodparam">string $input )

public <span class="modifier">static bool <span class="methodname">isNormalized ( <span class="type">string $input [, <span class="methodparam">int $form<span class="initializer"> = Normalizer::FORM_C ] )

public <span class="modifier">static string <span class="methodname">normalize ( <span class="type">string $input [, <span class="methodparam">int $form<span class="initializer"> = Normalizer::FORM_C ] )

}

预定义常量

The following constants define the normalization form used by the normalizer:

Normalizer::FORM_C (int)
Normalization Form C (NFC) - Canonical Decomposition followed by Canonical Composition

Normalizer::FORM_D (int)
Normalization Form D (NFD) - Canonical Decomposition

Normalizer::FORM_KC (int)
Normalization Form KC (NFKC) - Compatibility Decomposition, followed by Canonical Composition

Normalizer::FORM_KD (int)
Normalization Form KD (NFKD) - Compatibility Decomposition

Normalizer::NONE (int)
No decomposition/composition

Normalizer::OPTION_DEFAULT (int)
Default normalization options

参见

• »  Unicode Normalization
• »  Unicode Normalization FAQ
• »  ICU User Guide - Normalization
• »  ICU API Reference - Normalization

Normalizer::getRawDecomposition

normalizer_get_raw_decomposition

Gets the Decomposition_Mapping property for the given UTF-8 encoded code point

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Normalizer::getRawDecomposition ( <span class="methodparam">string $input )

过程化风格

string <span class="methodname">normalizer_get_raw_decomposition ( <span class="methodparam">string $input )

Gets the Decomposition_Mapping property, as specified in the Unicode Character Database (UCD), for the given UTF-8 encoded code point.

参数

input
The input string, which should be a single, UTF-8 encoded, code point.

返回值

Returns a string containing the Decomposition_Mapping property, if present in the UCD.

Returns null if there is no Decomposition_Mapping property for the character.

范例

示例 #1 <span class="methodname">Normalizer::getRawDecomposition example

<?php

$result = "";
$strings = [
    "a",
    "\u{FFDA}",
    "\u{FDFA}",
    "",
    "aa",
    "\xF5",
];

foreach ($strings as $string) {
    $decomposition = Normalizer::getRawDecomposition($string);
    // $decomposition = normalizer_get_raw_decomposition($string); Procedural way

    $error_code = intl_get_error_code();
    $error_message = intl_get_error_message();

    $string_hex = bin2hex($string);
    $result .= "---------------------\n";

    if ($decomposition === null) {
        $result .= "'$string_hex' has no decomposition mapping\n" ;
    } else {
        $result .= "'$string_hex' has the decomposition mapping '" . bin2hex($decomposition) . "'\n" ;
    }

    $result .= "error info: '$error_message' ($error_code)\n";
}

echo $result;
?>

以上例程会输出：

---------------------
'61' has no decomposition mapping
error info: 'U_ZERO_ERROR' (0)
---------------------
'efbf9a' has the decomposition mapping 'e385a1'
error info: 'U_ZERO_ERROR' (0)
---------------------
'efb7ba' has the decomposition mapping 'd8b5d984d98920d8a7d984d984d98720d8b9d984d98ad98720d988d8b3d984d985'
error info: 'U_ZERO_ERROR' (0)
---------------------
'' has no decomposition mapping
error info: 'Input string must be exactly one UTF-8 encoded code point long.: U_ILLEGAL_ARGUMENT_ERROR' (1)
---------------------
'6161' has no decomposition mapping
error info: 'Input string must be exactly one UTF-8 encoded code point long.: U_ILLEGAL_ARGUMENT_ERROR' (1)
---------------------
'f5' has no decomposition mapping
error info: 'Code point out of range: U_ILLEGAL_ARGUMENT_ERROR' (1)

参见

• Normalizer::normalize
• Normalizer::isNormalized

Normalizer::isNormalized

normalizer_is_normalized

Checks if the provided string is already in the specified normalization form

说明

面向对象风格

public <span class="modifier">static bool <span class="methodname">Normalizer::isNormalized ( <span class="methodparam">string $input [, int $form<span class="initializer"> = Normalizer::FORM_C ] )

过程化风格

bool <span class="methodname">normalizer_is_normalized ( <span class="methodparam">string $input [, int $form<span class="initializer"> = Normalizer::FORM_C ] )

Checks if the provided string is already in the specified normalization form.

参数

input
The input string to normalize

form
One of the normalization forms.

返回值

true if normalized, false otherwise or if there an error

范例

示例 #1 normalizer_is_normalized example

<?php
$char_A_ring = "\xC3\x85"; // 'LATIN CAPITAL LETTER A WITH RING ABOVE' (U+00C5)
$char_combining_ring_above = "\xCC\x8A";  // 'COMBINING RING ABOVE' (U+030A)

$char_orig = 'A' . $char_combining_ring_above;
$char_norm = normalizer_normalize( 'A' . $char_combining_ring_above, Normalizer::FORM_C );

echo ( normalizer_is_normalized($char_orig, Normalizer::FORM_C) ) ? "normalized" : "not normalized";
echo '; ';
echo ( normalizer_is_normalized($char_norm, Normalizer::FORM_C) ) ? "normalized" : "not normalized";
?>

示例 #2 OO example

<?php
$char_A_ring = "\xC3\x85"; // 'LATIN CAPITAL LETTER A WITH RING ABOVE' (U+00C5)
$char_combining_ring_above = "\xCC\x8A";  // 'COMBINING RING ABOVE' (U+030A)

$char_orig = 'A' . $char_combining_ring_above;
$char_norm = Normalizer::normalize( 'A' . $char_combining_ring_above, Normalizer::FORM_C );

echo ( Normalizer::isNormalized($char_orig, Normalizer::FORM_C) ) ? "normalized" : "not normalized";
echo '; ';
echo ( Normalizer::isNormalized($char_norm, Normalizer::FORM_C) ) ? "normalized" : "not normalized";
?>

以上例程会输出：

not normalized; normalized

参见

• normalizer_normalize

Normalizer::normalize

normalizer_normalize

Normalizes the input provided and returns the normalized string

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">Normalizer::normalize ( <span class="methodparam">string $input [, int $form<span class="initializer"> = Normalizer::FORM_C ] )

过程化风格

string <span class="methodname">normalizer_normalize ( <span class="methodparam">string $input [, int $form<span class="initializer"> = Normalizer::FORM_C ] )

Normalizes the input provided and returns the normalized string

参数

input
The input string to normalize

form
One of the normalization forms.

返回值

The normalized string or false if an error occurred.

范例

示例 #1 normalizer_normalize example

<?php
$char_A_ring = "\xC3\x85"; // 'LATIN CAPITAL LETTER A WITH RING ABOVE' (U+00C5)
$char_combining_ring_above = "\xCC\x8A";  // 'COMBINING RING ABOVE' (U+030A)

$char_1 = normalizer_normalize( $char_A_ring, Normalizer::FORM_C );
$char_2 = normalizer_normalize( 'A' . $char_combining_ring_above, Normalizer::FORM_C );

echo urlencode($char_1);
echo ' ';
echo urlencode($char_2);
?>

示例 #2 OO example

<?php
$char_A_ring = "\xC3\x85"; // 'LATIN CAPITAL LETTER A WITH RING ABOVE' (U+00C5)
$char_combining_ring_above = "\xCC\x8A";  // 'COMBINING RING ABOVE' (U+030A)

$char_1 = Normalizer::normalize( $char_A_ring, Normalizer::FORM_C );
$char_2 = Normalizer::normalize( 'A' . $char_combining_ring_above, Normalizer::FORM_C );

echo urlencode($char_1);
echo ' ';
echo urlencode($char_2);
?>

以上例程会输出：

%C3%85 %C3%85

参见

• normalizer_is_normalized

简介

MessageFormatter is a concrete class that enables users to produce concatenated, language-neutral messages. The methods supplied in this class are used to build all the messages that are seen by end users.

The MessageFormatter class assembles messages from various fragments (such as text fragments, numbers, and dates) supplied by the program. Because of the MessageFormatter class, the program does not need to know the order of the fragments. The class uses the formatting specifications for the fragments to assemble them into a message that is contained in a single string within a resource bundle. For example, MessageFormatter enables you to print the phrase "Finished printing x out of y files..." in a manner that still allows for flexibility in translation.

Previously, an end user message was created as a sentence and handled as a string. This procedure created problems for localizers because the sentence structure, word order, number format and so on are very different from language to language. The language-neutral way to create messages keeps each part of the message separate and provides keys to the data. Using these keys, the MessageFormatter class can concatenate the parts of the message, localize them, and display a well-formed string to the end user.

MessageFormatter takes a set of objects, formats them, and then inserts the formatted strings into the pattern at the appropriate places. Choice formats can be used in conjunction with MessageFormatter to handle plurals, match numbers, and select from an array of items. Typically, the message format will come from resources and the arguments will be dynamically set at runtime.

类摘要

MessageFormatter

class MessageFormatter {

/* 方法 */

public <span class="methodname">__construct ( <span class="methodparam">string $locale , string $pattern )

public <span class="modifier">static <span class="type">MessageFormatter <span class="methodname">create ( <span class="type">string $locale , <span class="methodparam">string $pattern )

public <span class="modifier">static string <span class="methodname">formatMessage ( <span class="methodparam">string $locale , string $pattern , <span class="type">array $args )

public string format ( <span class="type">array $args )

public int <span class="methodname">getErrorCode ( <span class="methodparam">void )

public string getErrorMessage ( <span class="methodparam">void )

public string getLocale ( <span class="methodparam">void )

public string getPattern ( <span class="methodparam">void )

public <span class="modifier">static array <span class="methodname">parseMessage ( <span class="type">string $locale , <span class="methodparam">string $pattern , string $source )

public array parse ( <span class="type">string $value )

public bool setPattern ( <span class="methodparam">string $pattern )

}

参见

• »  ICU formatting documentation
• »  ICU message formatting description
• » ICU message formatters
• » ICU choice formatters

MessageFormatter::create

MessageFormatter::__construct

msgfmt_create

Constructs a new Message Formatter

说明

面向对象风格 (method)

public <span class="modifier">static <span class="type">MessageFormatter <span class="methodname">MessageFormatter::create ( <span class="methodparam">string $locale , string $pattern )

面向对象风格 (constructor):

public <span class="methodname">MessageFormatter::__construct ( <span class="methodparam">string $locale , string $pattern )

过程化风格

MessageFormatter <span class="methodname">msgfmt_create ( <span class="methodparam">string $locale , string $pattern )

Constructs a new Message Formatter

参数

locale
The locale to use when formatting arguments

pattern
The pattern string to stick arguments into. The pattern uses an 'apostrophe-friendly' syntax; it is run through » umsg_autoQuoteApostrophe before being interpreted.

返回值

The formatter object

错误／异常

When invoked as constructor, on failure an <span class="classname">IntlException is thrown.

范例

示例 #1 msgfmt_create example

<?php
$fmt = msgfmt_create("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree");
echo msgfmt_format($fmt, array(4560, 123, 4560/123));
$fmt = msgfmt_create("de", "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum");
echo msgfmt_format($fmt, array(4560, 123, 4560/123));
?>

示例 #2 OO example

<?php
$fmt = new MessageFormatter("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree");
echo $fmt->format(array(4560, 123, 4560/123));
$fmt = new MessageFormatter("de", "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum");
echo $fmt->format(array(4560, 123, 4560/123));
?>

以上例程会输出：

4,560 monkeys on 123 trees make 37.073 monkeys per tree
4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum

参见

• msgfmt_format
• msgfmt_parse
• msgfmt_get_error_code
• msgfmt_get_error_message

MessageFormatter::formatMessage

msgfmt_format_message

Quick format message

说明

面向对象风格

public <span class="modifier">static string <span class="methodname">MessageFormatter::formatMessage ( <span class="methodparam">string $locale , string $pattern , <span class="type">array $args )

过程化风格

string <span class="methodname">msgfmt_format_message ( <span class="methodparam">string $locale , string $pattern , <span class="type">array $args )

Quick formatting function that formats the string without having to explicitly create the formatter object. Use this function when the format operation is done only once and does not need and parameters or state to be kept.

参数

locale
The locale to use for formatting locale-dependent parts

pattern
The pattern string to insert things into. The pattern uses an 'apostrophe-friendly' syntax; it is run through » umsg_autoQuoteApostrophe before being interpreted.

args
The array of values to insert into the format string

返回值

The formatted pattern string or false if an error occurred

范例

示例 #1 msgfmt_format_message example

<?php
echo msgfmt_format_message("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree\n", array(4560, 123, 4560/123));
echo msgfmt_format_message("de", "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum\n", array(4560, 123, 4560/123));
?>

示例 #2 OO example

<?php
echo MessageFormatter::formatMessage("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree\n", array(4560, 123, 4560/123));
echo MessageFormatter::formatMessage("de", "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum\n", array(4560, 123, 4560/123));
?>

以上例程会输出：

4,560 monkeys on 123 trees make 37.073 monkeys per tree
4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum

参见

• msgfmt_create
• msgfmt_parse
• msgfmt_get_error_code
• msgfmt_get_error_message

MessageFormatter::format

msgfmt_format

Format the message

说明

面向对象风格

public string MessageFormatter::format ( <span class="methodparam">array $args )

过程化风格

string <span class="methodname">msgfmt_format ( <span class="methodparam">MessageFormatter $fmt , <span class="type">array $args )

Format the message by substituting the data into the format string according to the locale rules

参数

fmt
The message formatter

args
Arguments to insert into the format string

返回值

The formatted string, or false if an error occurred

范例

示例 #1 msgfmt_format example

<?php
$fmt = msgfmt_create("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree");
echo msgfmt_format($fmt, array(4560, 123, 4560/123));
$fmt = msgfmt_create("de", "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum");
echo msgfmt_format($fmt, array(4560, 123, 4560/123));
?>

示例 #2 OO example

<?php
$fmt = new MessageFormatter("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree");
echo $fmt->format(array(4560, 123, 4560/123));
$fmt = new MessageFormatter("de", "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum");
echo $fmt->format(array(4560, 123, 4560/123));
?>

以上例程会输出：

4,560 monkeys on 123 trees make 37.073 monkeys per tree
4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum

参见

• msgfmt_create
• msgfmt_parse
• msgfmt_format_message
• msgfmt_get_error_code
• msgfmt_get_error_message

MessageFormatter::getErrorCode

msgfmt_get_error_code

Get the error code from last operation

说明

面向对象风格

public int <span class="methodname">MessageFormatter::getErrorCode ( <span class="methodparam">void )

过程化风格

int <span class="methodname">msgfmt_get_error_code ( <span class="methodparam">MessageFormatter $fmt )

Get the error code from last operation.

参数

fmt
The message formatter

返回值

The error code, one of UErrorCode values. Initial value is U_ZERO_ERROR.

参见

• msgfmt_get_error_message
• intl_get_error_code
• intl_is_failure

MessageFormatter::getErrorMessage

msgfmt_get_error_message

Get the error text from the last operation

说明

面向对象风格

public string MessageFormatter::getErrorMessage ( void )

过程化风格

string <span class="methodname">msgfmt_get_error_message ( <span class="methodparam">MessageFormatter $fmt )

Get the error text from the last operation.

参数

fmt
The message formatter

返回值

Description of the last error.

范例

示例 #1 msgfmt_get_error_message example

<?php
$fmt = msgfmt_create("en_US", "{0, number} monkeys on {1, number} trees");
$str = msgfmt_format($fmt, array());
if(!$str) {
    echo "ERROR: ".msgfmt_get_error_message($fmt) . " (" . msgfmt_get_error_code($fmt) . ")\n";
}
?>

示例 #2 OO example

<?php
$fmt = new MessageFormatter("en_US", "{0, number} monkeys on {1, number} trees");
$str = $fmt->format(array());
if(!$str) {
    echo "ERROR: ".$fmt->getErrorMessage() . " (" . $fmt->getErrorCode() . ")\n";
}
?>

以上例程会输出：

ERROR: msgfmt_format: not enough parameters: U_ILLEGAL_ARGUMENT_ERROR (1)

参见

• msgfmt_get_error_code
• intl_get_error_code
• intl_is_failure

MessageFormatter::getLocale

msgfmt_get_locale

Get the locale for which the formatter was created

说明

面向对象风格

public string MessageFormatter::getLocale ( <span class="methodparam">void )

过程化风格

string <span class="methodname">msgfmt_get_locale ( <span class="methodparam">NumberFormatter $formatter )

Get the locale for which the formatter was created.

参数

formatter
The formatter resource

返回值

The locale name

范例

示例 #1 msgfmt_get_locale example

<?php
$fmt = msgfmt_create('en_US', "Number {0,number}");
echo msgfmt_get_locale($fmt);
?>

示例 #2 OO example

<?php
$fmt = new MessageFormatter('en_US', "Number {0,number}");
echo $fmt->getLocale();
?>

以上例程会输出：

en_US

参见

• msgfmt_create

MessageFormatter::getPattern

msgfmt_get_pattern

Get the pattern used by the formatter

说明

面向对象风格

public string MessageFormatter::getPattern ( <span class="methodparam">void )

过程化风格

string <span class="methodname">msgfmt_get_pattern ( <span class="methodparam">MessageFormatter $fmt )

Get the pattern used by the formatter

参数

fmt
The message formatter

返回值

The pattern string for this message formatter

范例

示例 #1 msgfmt_get_pattern example

<?php
$fmt = msgfmt_create( "en_US", "{0, number} monkeys on {1, number} trees" );
echo "Default pattern: '" . msgfmt_get_pattern( $fmt ) . "'\n";
echo "Formatting result: " . msgfmt_format( $fmt, array(123, 456) ) . "\n";

msgfmt_set_pattern( $fmt, "{0, number} trees hosting {1, number} monkeys" );
echo "New pattern: '" . msgfmt_get_pattern( $fmt ) . "'\n";
echo "Formatted number: " . msgfmt_format( $fmt, array(123, 456) ) . "\n";
?>

示例 #2 OO example

<?php
$fmt = new MessageFormatter( "en_US", "{0, number} monkeys on {1, number} trees" );
echo "Default pattern: '" . $fmt->getPattern() . "'\n";
echo "Formatting result: " . $fmt->format(array(123, 456)) . "\n";

$fmt->setPattern("{0, number} trees hosting {1, number} monkeys" );
echo "New pattern: '" . $fmt->getPattern() . "'\n";
echo "Formatted number: " . $fmt->format(array(123, 456)) . "\n";
?>

以上例程会输出：

Default pattern: '{0,number} monkeys on {1,number} trees'
Formatting result: 123 monkeys on 456 trees
New pattern: '{0,number} trees hosting {1,number} monkeys'
Formatted number: 123 trees hosting 456 monkeys

参见

• msgfmt_create
• msgfmt_set_pattern

MessageFormatter::parseMessage

msgfmt_parse_message

Quick parse input string

说明

面向对象风格

public <span class="modifier">static array <span class="methodname">MessageFormatter::parseMessage ( <span class="methodparam">string $locale , string $pattern , <span class="type">string $source )

过程化风格

array <span class="methodname">msgfmt_parse_message ( <span class="methodparam">string $locale , string $pattern , <span class="type">string $value )

Parses input string without explicitly creating the formatter object. Use this function when the format operation is done only once and does not need and parameters or state to be kept.

参数

locale
The locale to use for parsing locale-dependent parts

pattern
The pattern with which to parse the value.

source
The string to parse, conforming to the pattern.

返回值

An array containing items extracted, or false on error

范例

示例 #1 msgfmt_parse_message example

<?php
$fmt = msgfmt_parse_message('en_US', "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree",
                            "4,560 monkeys on 123 trees make 37.073 monkeys per tree");
var_export($fmt);

$fmt = msgfmt_parse_message('de', "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum", 
                            "4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum");
var_export($fmt);
?>

示例 #2 OO example

<?php
$fmt = MessageFormatter::parseMessage('en_US', "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree",
                            "4,560 monkeys on 123 trees make 37.073 monkeys per tree");
var_export($fmt);

$fmt = MessageFormatter::parseMessage('de', "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum", 
                            "4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum");
var_export($fmt);
?>

以上例程会输出：

array (
  0 => 4560,
  1 => 123,
  2 => 37.073,
)
array (
  0 => 4560,
  1 => 123,
  2 => 37.073,
)

参见

• msgfmt_create
• msgfmt_format_message
• msgfmt_parse

MessageFormatter::parse

msgfmt_parse

Parse input string according to pattern

说明

面向对象风格

public array MessageFormatter::parse ( <span class="methodparam">string $value )

过程化风格

array <span class="methodname">msgfmt_parse ( <span class="methodparam">MessageFormatter $fmt , <span class="type">string $value )

Parses input string and return any extracted items as an array.

参数

fmt
The message formatter

value
The string to parse

返回值

An array containing the items extracted, or false on error

范例

示例 #1 msgfmt_parse example

<?php
$fmt = msgfmt_create('en_US', "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree");
$res = msgfmt_parse($fmt, "4,560 monkeys on 123 trees make 37.073 monkeys per tree");
var_export($res);

$fmt = msgfmt_create('de', "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum");
$res = msgfmt_parse($fmt, "4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum");
var_export($res);
?>

示例 #2 OO example

<?php
$fmt = new MessageFormatter('en_US', "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree");
$res = $fmt->parse("4,560 monkeys on 123 trees make 37.073 monkeys per tree");
var_export($res);

$fmt = new MessageFormatter('de', "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum");
$res = $fmt->parse("4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum");
var_export($res);
?>

以上例程会输出：

array (
  0 => 4560,
  1 => 123,
  2 => 37.073,
)
array (
  0 => 4560,
  1 => 123,
  2 => 37.073,
)

参见

• msgfmt_create
• msgfmt_format
• msgfmt_parse_message

MessageFormatter::setPattern

msgfmt_set_pattern

Set the pattern used by the formatter

说明

面向对象风格

public bool MessageFormatter::setPattern ( <span class="methodparam">string $pattern )

过程化风格

bool <span class="methodname">msgfmt_set_pattern ( <span class="methodparam">MessageFormatter $fmt , <span class="type">string $pattern )

Set the pattern used by the formatter

参数

fmt
The message formatter

pattern
The pattern string to use in this message formatter. The pattern uses an 'apostrophe-friendly' syntax; it is run through » umsg_autoQuoteApostrophe before being interpreted.

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 msgfmt_set_pattern example

<?php
$fmt = msgfmt_create( "en_US", "{0, number} monkeys on {1, number} trees" );
echo "Default pattern: '" . msgfmt_get_pattern( $fmt ) . "'\n";
echo "Formatting result: " . msgfmt_format( $fmt, array(123, 456) ) . "\n";

msgfmt_set_pattern( $fmt, "{0, number} trees hosting {1, number} monkeys" );
echo "New pattern: '" . msgfmt_get_pattern( $fmt ) . "'\n";
echo "Formatted number: " . msgfmt_format( $fmt, array(123, 456) ) . "\n";
?>

示例 #2 OO example

<?php
$fmt = new MessageFormatter( "en_US", "{0, number} monkeys on {1, number} trees" );
echo "Default pattern: '" . $fmt->getPattern() . "'\n";
echo "Formatting result: " . $fmt->format(array(123, 456)) . "\n";

$fmt->setPattern("{0, number} trees hosting {1, number} monkeys" );
echo "New pattern: '" . $fmt->getPattern() . "'\n";
echo "Formatted number: " . $fmt->format(array(123, 456)) . "\n";
?>

以上例程会输出：

Default pattern: '{0,number} monkeys on {1,number} trees'
Formatting result: 123 monkeys on 456 trees
New pattern: '{0,number} trees hosting {1,number} monkeys'
Formatted number: 123 trees hosting 456 monkeys

参见

• msgfmt_create
• msgfmt_get_pattern

简介

类摘要

IntlCalendar

class IntlCalendar {

/* 常量 */

const int IntlCalendar::FIELD_ERA = 0 ;

const int IntlCalendar::FIELD_YEAR = 1 ;

const int IntlCalendar::FIELD_MONTH = 2 ;

const int IntlCalendar::FIELD_WEEK_OF_YEAR = 3 ;

const int IntlCalendar::FIELD_WEEK_OF_MONTH = 4 ;

const int IntlCalendar::FIELD_DATE = 5 ;

const int IntlCalendar::FIELD_DAY_OF_YEAR = 6 ;

const int IntlCalendar::FIELD_DAY_OF_WEEK = 7 ;

const int IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH = 8 ;

const int IntlCalendar::FIELD_AM_PM = 9 ;

const int IntlCalendar::FIELD_HOUR = 10 ;

const int IntlCalendar::FIELD_HOUR_OF_DAY = 11 ;

const int IntlCalendar::FIELD_MINUTE = 12 ;

const int IntlCalendar::FIELD_SECOND = 13 ;

const int IntlCalendar::FIELD_MILLISECOND = 14 ;

const int IntlCalendar::FIELD_ZONE_OFFSET = 15 ;

const int IntlCalendar::FIELD_DST_OFFSET = 16 ;

const int IntlCalendar::FIELD_YEAR_WOY = 17 ;

const int IntlCalendar::FIELD_DOW_LOCAL = 18 ;

const int IntlCalendar::FIELD_EXTENDED_YEAR = 19 ;

const int IntlCalendar::FIELD_JULIAN_DAY = 20 ;

const int IntlCalendar::FIELD_MILLISECONDS_IN_DAY = 21 ;

const int IntlCalendar::FIELD_IS_LEAP_MONTH = 22 ;

const int IntlCalendar::FIELD_FIELD_COUNT = 23 ;

const int IntlCalendar::FIELD_DAY_OF_MONTH = 5 ;

const int IntlCalendar::DOW_SUNDAY = 1 ;

const int IntlCalendar::DOW_MONDAY = 2 ;

const int IntlCalendar::DOW_TUESDAY = 3 ;

const int IntlCalendar::DOW_WEDNESDAY = 4 ;

const int IntlCalendar::DOW_THURSDAY = 5 ;

const int IntlCalendar::DOW_FRIDAY = 6 ;

const int IntlCalendar::DOW_SATURDAY = 7 ;

const int IntlCalendar::DOW_TYPE_WEEKDAY = 0 ;

const int IntlCalendar::DOW_TYPE_WEEKEND = 1 ;

const int IntlCalendar::DOW_TYPE_WEEKEND_OFFSET = 2 ;

const int IntlCalendar::DOW_TYPE_WEEKEND_CEASE = 3 ;

const int IntlCalendar::WALLTIME_FIRST = 1 ;

const int IntlCalendar::WALLTIME_LAST = 0 ;

const int IntlCalendar::WALLTIME_NEXT_VALID = 2 ;

/* 方法 */

public bool add ( <span class="type">int $field , <span class="methodparam">int $amount )

bool <span class="methodname">intlcal_add ( <span class="type">IntlCalendar $cal , <span class="methodparam">int $field , int $amount )

public bool after ( <span class="type">IntlCalendar $other )

bool <span class="methodname">intlcal_after ( <span class="methodparam">IntlCalendar $cal , IntlCalendar $other )

public bool before ( <span class="type">IntlCalendar $other )

bool <span class="methodname">intlcal_before ( <span class="methodparam">IntlCalendar $cal , IntlCalendar $other )

public bool clear ([ <span class="methodparam">int $field<span class="initializer"> = NULL ] )

bool <span class="methodname">intlcal_clear ( <span class="methodparam">IntlCalendar $cal [, int $field = NULL ] )

private <span class="methodname">__construct ( <span class="methodparam">void )

public <span class="modifier">static IntlCalendar createInstance ([ <span class="methodparam">mixed $timeZone<span class="initializer"> = NULL [, <span class="methodparam">string $locale<span class="initializer"> = "" ]] )

IntlCalendar <span class="methodname">intlcal_create_instance ([ <span class="methodparam">mixed $timeZone<span class="initializer"> = NULL [, <span class="methodparam">string $locale<span class="initializer"> = "" ]] )

public bool equals ( <span class="type">IntlCalendar $other )

bool <span class="methodname">intlcal_equals ( <span class="methodparam">IntlCalendar $cal , IntlCalendar $other )

public <span class="type">intfalse <span class="methodname">fieldDifference ( <span class="methodparam">float $when , int $field )

int<span class="type">false <span class="methodname">intlcal_field_difference ( <span class="methodparam">IntlCalendar $cal , float $when , int $field )

public <span class="modifier">static IntlCalendar fromDateTime ( <span class="methodparam">mixed $dateTime )

IntlCalendar <span class="methodname">intlcal_from_date_time ( <span class="methodparam">mixed $dateTime )

public int <span class="methodname">get ( <span class="type">int $field )

int <span class="methodname">intlcal_get ( <span class="type">IntlCalendar $cal , <span class="methodparam">int $field )

public <span class="type">intfalse <span class="methodname">getActualMaximum ( <span class="methodparam">int $field )

int<span class="type">false <span class="methodname">intlcal_get_actual_maximum ( <span class="methodparam">IntlCalendar $cal , int $field )

public <span class="type">intfalse <span class="methodname">getActualMinimum ( <span class="methodparam">int $field )

int<span class="type">false <span class="methodname">intlcal_get_actual_minimum ( <span class="methodparam">IntlCalendar $cal , int $field )

public <span class="modifier">static array <span class="methodname">getAvailableLocales ( <span class="methodparam">void )

array <span class="methodname">intlcal_get_available_locales ( <span class="methodparam">void )

public <span class="type">intfalse <span class="methodname">getDayOfWeekType ( <span class="methodparam">int $dayOfWeek )

int<span class="type">false <span class="methodname">intlcal_get_day_of_week_type ( <span class="methodparam">IntlCalendar $cal , int $dayOfWeek )

public int <span class="methodname">getErrorCode ( <span class="methodparam">void )

public string getErrorMessage ( <span class="methodparam">void )

public <span class="type">intfalse <span class="methodname">getFirstDayOfWeek ( <span class="methodparam">void )

int<span class="type">false <span class="methodname">intlcal_get_first_day_of_week ( <span class="methodparam">IntlCalendar $cal )

public <span class="type">intfalse <span class="methodname">getGreatestMinimum ( <span class="methodparam">int $field )

int<span class="type">false <span class="methodname">intlcal_get_greatest_minimum ( <span class="methodparam">IntlCalendar $cal , int $field )

public <span class="modifier">static <span class="type">Iteratorfalse <span class="methodname">getKeywordValuesForLocale ( <span class="methodparam">string $key , string $locale , <span class="type">bool $commonlyUsed )

static <span class="type">Iteratorfalse <span class="methodname">intlcal_get_keyword_values_for_locale ( string $key , string $locale , <span class="type">bool $commonlyUsed )

public <span class="type">intfalse <span class="methodname">getLeastMaximum ( <span class="methodparam">int $field )

int<span class="type">false <span class="methodname">intlcal_get_least_maximum ( <span class="methodparam">IntlCalendar $cal , int $field )

public <span class="type">stringfalse <span class="methodname">getLocale ( <span class="type">int $localeType )

string<span class="type">false <span class="methodname">intlcal_get_locale ( <span class="methodparam">IntlCalendar $cal , int $localeType )

public <span class="type">intfalse <span class="methodname">getMaximum ( <span class="type">int $field )

int<span class="type">false <span class="methodname">intlcal_get_maximum ( <span class="methodparam">IntlCalendar $cal , int $field )

public <span class="type">intfalse <span class="methodname">getMinimalDaysInFirstWeek ( <span class="methodparam">void )

int<span class="type">false <span class="methodname">intlcal_get_minimal_days_in_first_week ( IntlCalendar $cal )

public <span class="type">intfalse <span class="methodname">getMinimum ( <span class="type">int $field )

int<span class="type">false <span class="methodname">intlcal_get_minimum ( <span class="methodparam">IntlCalendar $cal , int $field )

public <span class="modifier">static float <span class="methodname">getNow ( void )

float <span class="methodname">intlcal_get_now ( <span class="methodparam">void )

public int <span class="methodname">getRepeatedWallTimeOption ( <span class="methodparam">void )

int <span class="methodname">intlcal_get_repeated_wall_time_option ( IntlCalendar $cal )

public int <span class="methodname">getSkippedWallTimeOption ( <span class="methodparam">void )

int <span class="methodname">intlcal_get_skipped_wall_time_option ( IntlCalendar $cal )

public float getTime ( <span class="methodparam">void )

float <span class="methodname">intlcal_get_time ( <span class="methodparam">IntlCalendar $cal )

public <span class="type">IntlTimeZone <span class="methodname">getTimeZone ( <span class="methodparam">void )

IntlTimeZone <span class="methodname">intlcal_get_time_zone ( <span class="methodparam">IntlCalendar $cal )

public string getType ( <span class="methodparam">void )

string <span class="methodname">intlcal_get_type ( <span class="methodparam">IntlCalendar $cal )

public <span class="type">intfalse <span class="methodname">getWeekendTransition ( <span class="methodparam">string $dayOfWeek )

int<span class="type">false <span class="methodname">intlcal_get_weekend_transition ( <span class="methodparam">IntlCalendar $cal , string $dayOfWeek )

public bool inDaylightTime ( <span class="methodparam">void )

bool <span class="methodname">intlcal_in_daylight_time ( <span class="methodparam">IntlCalendar $cal )

public bool isEquivalentTo ( <span class="methodparam">IntlCalendar $other )

bool <span class="methodname">intlcal_is_equivalent_to ( <span class="methodparam">IntlCalendar $cal , IntlCalendar $other )

public bool isLenient ( <span class="methodparam">void )

bool <span class="methodname">intlcal_is_lenient ( <span class="methodparam">IntlCalendar $cal )

public bool isSet ( <span class="type">int $field )

bool <span class="methodname">intlcal_is_set ( <span class="methodparam">IntlCalendar $cal , int $field )

public bool isWeekend ([ <span class="methodparam">float $date<span class="initializer"> = NULL ] )

bool <span class="methodname">intlcal_is_weekend ( <span class="methodparam">IntlCalendar $cal [, float $date = NULL ] )

public bool roll ( <span class="type">int $field , <span class="methodparam">mixed $amountOrUpOrDown )

bool <span class="methodname">intlcal_roll ( <span class="methodparam">IntlCalendar $cal , int $field , <span class="type">mixed $amountOrUpOrDown )

public bool set ( <span class="type">int $field , <span class="methodparam">int $value )

public bool set ( <span class="type">int $year , <span class="type">int $month [, <span class="methodparam">int $dayOfMonth<span class="initializer"> = NULL [, <span class="methodparam">int $hour<span class="initializer"> = NULL [, <span class="methodparam">int $minute<span class="initializer"> = NULL [, <span class="methodparam">int $second<span class="initializer"> = NULL ]]]] )

bool <span class="methodname">intlcal_set ( <span class="type">IntlCalendar $cal , <span class="methodparam">int $field , int $value )

bool <span class="methodname">intlcal_set ( <span class="type">IntlCalendar $cal , <span class="methodparam">int $year , <span class="methodparam">int $month [, int $dayOfMonth = NULL [, <span class="methodparam">int $hour<span class="initializer"> = NULL [, <span class="methodparam">int $minute<span class="initializer"> = NULL [, <span class="methodparam">int $second<span class="initializer"> = NULL ]]]] )

public bool setFirstDayOfWeek ( <span class="methodparam">int $dayOfWeek )

bool <span class="methodname">intlcal_set_first_day_of_week ( <span class="methodparam">IntlCalendar $cal , int $dayOfWeek )

public bool setLenient ( <span class="methodparam">bool $isLenient )

bool <span class="methodname">intlcal_set_lenient ( <span class="methodparam">IntlCalendar $cal , bool $isLenient )

public bool setMinimalDaysInFirstWeek ( <span class="methodparam">int $minimalDays )

bool <span class="methodname">intlcal_set_minimal_days_in_first_week ( IntlCalendar $cal , int $minimalDays )

public bool setRepeatedWallTimeOption ( <span class="methodparam">int $wallTimeOption )

bool <span class="methodname">intlcal_set_repeated_wall_time_option ( IntlCalendar $cal , int $wallTimeOption )

public bool setSkippedWallTimeOption ( <span class="methodparam">int $wallTimeOption )

bool <span class="methodname">intlcal_set_skipped_wall_time_option ( IntlCalendar $cal , int $wallTimeOption )

public bool setTime ( <span class="methodparam">float $date )

bool <span class="methodname">intlcal_set_time ( <span class="methodparam">IntlCalendar $cal , float $date )

public bool setTimeZone ( <span class="methodparam">mixed $timeZone )

bool <span class="methodname">intlcal_set_time_zone ( <span class="methodparam">IntlCalendar $cal , mixed $timeZone )

public DateTime toDateTime ( <span class="methodparam">void )

DateTime <span class="methodname">intlcal_to_date_time ( <span class="methodparam">IntlCalendar $cal )

}

预定义常量

IntlCalendar::FIELD_ERA
Calendar field numerically representing an era, for instance 1 for AD and 0 for BC in the Gregorian/Julian calendars and 235 for the Heisei (平成) era in the Japanese calendar. Not all calendars have more than one era.

IntlCalendar::FIELD_YEAR
Calendar field for the year. This is not unique across eras. If the calendar type has more than one era, generally the minimum value for this field will be 1.

IntlCalendar::FIELD_MONTH
Calendar field for the month. The month sequence is zero-based, so January (here used to signify the first month of the calendar; this may be called another name, such as Muharram in the Islamic calendar) is represented by 0, February by 1, …, December by 11 and, for calendars that have it, the 13th or leap month by 12.

IntlCalendar::FIELD_WEEK_OF_YEAR
Calendar field for the number of the week of the year. This depends on which day of the week is deemed to start the week and the minimal number of days in a week.

IntlCalendar::FIELD_WEEK_OF_MONTH
Calendar field for the number of the week of the month. This depends on which day of the week is deemed to start the week and the minimal number of days in a week.

IntlCalendar::FIELD_DATE
Calendar field for the day of the month. The same as IntlCalendar::FIELD_DAY_OF_MONTH, which has a clearer name.

IntlCalendar::FIELD_DAY_OF_YEAR
Calendar field for the day of the year. For the Gregorian calendar, starts with 1 and ends with 365 or 366.

IntlCalendar::FIELD_DAY_OF_WEEK
Calendar field for the day of the week. Its values start with 1 (Sunday, see IntlCalendar::DOW_SUNDAY and subsequent constants) and the last valid value is 7 (Saturday).

IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH
Given a day of the week (Sunday, Monday, …), this calendar field assigns an ordinal to such a day of the week in a specific month. Thus, if the value of this field is 1 and the value of the day of the week is 2 (Monday), then the set day of the month is the 1st Monday of the month; the maximum value is 5.

Additionally, the value 0 and negative values are also allowed. The value 0 encompasses the seven days that occur immediately before the first seven days of a month (which therefore have a ‘day of week in month’ with value 1). Negative values starts counting from the end of the month – -1 points to the last occurrence of a day of the week in a month, -2 to the second last, and so on.

Unlike IntlCalendar::FIELD_WEEK_OF_MONTH and IntlCalendar::FIELD_WEEK_OF_YEAR, this value does not depend on <span class="function">IntlCalendar::getFirstDayOfWeek or on <span class="function">IntlCalendar::getMinimalDaysInFirstWeek. The first Monday is the first Monday, even if it occurs in a week that belongs to the previous month.

IntlCalendar::FIELD_AM_PM
Calendar field indicating whether a time is before noon (value 0, AM) or after (1). Midnight is AM, noon is PM.

IntlCalendar::FIELD_HOUR
Calendar field for the hour, without specifying whether itʼs in the morning or in the afternoon. Valid values are 0 to 11.

IntlCalendar::FIELD_HOUR_OF_DAY
Calendar field for the full (24h) hour of the day. Valid values are 0 to 23.

IntlCalendar::FIELD_MINUTE
Calendar field for the minutes component of the time.

IntlCalendar::FIELD_SECOND
Calendar field for the seconds component of the time.

IntlCalendar::FIELD_MILLISECOND
Calendar field the milliseconds component of the time.

IntlCalendar::FIELD_ZONE_OFFSET
Calendar field indicating the raw offset of the timezone, in milliseconds. The raw offset is the timezone offset, excluding any offset due to daylight saving time.

IntlCalendar::FIELD_DST_OFFSET
Calendar field for the daylight saving time offset of the calendarʼs timezone, in milliseconds, if active for calendarʼs time.

IntlCalendar::FIELD_YEAR_WOY
Calendar field representing the year for week of year purposes.

IntlCalendar::FIELD_DOW_LOCAL
Calendar field for the localized day of the week. This is a value between 1 and 7, 1 being used for the day of the week that matches the value returned by <span class="function">IntlCalendar::getFirstDayOfWeek.

IntlCalendar::FIELD_EXTENDED_YEAR
Calendar field for a year number representation that is continuous across eras. For the Gregorian calendar, the value of this field matches that of IntlCalendar::FIELD_YEAR for AD years; a BC year y is represented by -y + 1.

IntlCalendar::FIELD_JULIAN_DAY
Calendar field for a modified Julian day number. It is different from a conventional Julian day number in that its transitions occur at local zone midnight rather than at noon UTC. It uniquely identifies a date.

IntlCalendar::FIELD_MILLISECONDS_IN_DAY
Calendar field encompassing the information in IntlCalendar::FIELD_HOUR_OF_DAY, IntlCalendar::FIELD_MINUTE, IntlCalendar::FIELD_SECOND and IntlCalendar::FIELD_MILLISECOND. Range is from the 0 to 24 * 3600 * 1000 - 1. It is not the amount of milliseconds elapsed in the day since on DST transitions it will have discontinuities analog to those of the wall time.

IntlCalendar::FIELD_IS_LEAP_MONTH
Calendar field whose value is 1 for indicating a leap month and 0 otherwise.

IntlCalendar::FIELD_FIELD_COUNT
The total number of fields.

IntlCalendar::FIELD_DAY_OF_MONTH
Alias for IntlCalendar::FIELD_DATE.

IntlCalendar::DOW_SUNDAY
Sunday.

IntlCalendar::DOW_MONDAY
Monday.

IntlCalendar::DOW_TUESDAY
Tuesday.

IntlCalendar::DOW_WEDNESDAY
Wednesday.

IntlCalendar::DOW_THURSDAY
Thursday.

IntlCalendar::DOW_FRIDAY
Friday.

IntlCalendar::DOW_SATURDAY
Saturday.

IntlCalendar::DOW_TYPE_WEEKDAY
Output of IntlCalendar::getDayOfWeekType indicating a day of week is a weekday.

IntlCalendar::DOW_TYPE_WEEKEND
Output of IntlCalendar::getDayOfWeekType indicating a day of week belongs to the weekend.

IntlCalendar::DOW_TYPE_WEEKEND_OFFSET
Output of IntlCalendar::getDayOfWeekType indicating the weekend begins during the given day of week.

IntlCalendar::DOW_TYPE_WEEKEND_CEASE
Output of IntlCalendar::getDayOfWeekType indicating the weekend ends during the given day of week.

IntlCalendar::WALLTIME_FIRST
Output of <span class="function">IntlCalendar::getSkippedWallTimeOption indicating that wall times in the skipped range should refer to the same instant as wall times with one hour less and of <span class="function">IntlCalendar::getRepeatedWallTimeOption indicating the wall times in the repeated range should refer to the instant of the first occurrence of such wall time.

IntlCalendar::WALLTIME_LAST
Output of <span class="function">IntlCalendar::getSkippedWallTimeOption indicating that wall times in the skipped range should refer to the same instant as wall times with one hour after and of <span class="function">IntlCalendar::getRepeatedWallTimeOption indicating the wall times in the repeated range should refer to the instant of the second occurrence of such wall time.

IntlCalendar::WALLTIME_NEXT_VALID
Output of <span class="function">IntlCalendar::getSkippedWallTimeOption indicating that wall times in the skipped range should refer to the instant when the daylight saving time transition occurs (begins).

IntlCalendar::add

Add a (signed) amount of time to a field

说明

面向对象风格

public bool IntlCalendar::add ( <span class="methodparam">int $field , int $amount )

过程化风格

bool <span class="methodname">intlcal_add ( <span class="type">IntlCalendar $cal , <span class="methodparam">int $field , int $amount )

Add a signed amount to a field. Adding a positive amount allows advances in time, even if the numeric value of the field decreases (e.g. when working with years in BC dates).

Other fields may need to adjusted – for instance, adding a month to the 31st of January will result in the 28th (or 29th) of February. Contrary to IntlCalendar::roll, when a value wraps around, more significant fields may change. For instance, adding a day to the 31st of January will result in the 1st of February, not the 1st of January.

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

amount
The signed amount to add to the current field. If the amount is positive, the instant will be moved forward; if it is negative, the instant will be moved into the past. The unit is implicit to the field type. For instance, hours for IntlCalendar::FIELD_HOUR_OF_DAY.

返回值

Returns true on success 或者在失败时返回 false.

范例

示例 #1 IntlCalendar::add

<?php
ini_set('intl.default_locale', 'fr_FR');
ini_set('date.timezone', 'UTC');

$cal = new IntlGregorianCalendar(2012, 0 /* January */, 31);
echo IntlDateFormatter::formatObject($cal), "\n";

$cal->add(IntlCalendar::FIELD_MONTH, 1);
echo IntlDateFormatter::formatObject($cal), "\n";

$cal->add(IntlCalendar::FIELD_DAY_OF_MONTH, 1);
echo IntlDateFormatter::formatObject($cal), "\n";

以上例程会输出：

31 janv. 2012 00:00:00
29 févr. 2012 00:00:00
1 mars 2012 00:00:00

IntlCalendar::after

Whether this objectʼs time is after that of the passed object

说明

面向对象风格

public bool IntlCalendar::after ( <span class="methodparam">IntlCalendar $other )

过程化风格

bool <span class="methodname">intlcal_after ( <span class="methodparam">IntlCalendar $cal , IntlCalendar $other )

Returns whether this objectʼs time succeeds the argumentʼs time.

参数

cal
The IntlCalendar resource.

other
The calendar whose time will be checked against the primary objectʼs time.

返回值

Returns true if this objectʼs current time is after that of the calendar argumentʼs time. Returns false otherwise. Also returns false on failure. You can use exceptions or <span class="function">intl_get_error_code to detect error conditions.

范例

示例 #1 IntlCalendar::after

<?php
$cal1 = IntlCalendar::createInstance();
$cal2 = clone $cal1;

var_dump($cal1->after($cal2), //false
        $cal2->after($cal1)); //false

$cal1->roll(IntlCalendar::FIELD_MILLISECOND, true);

var_dump($cal1->after($cal2), //true
        $cal2->after($cal1)); //false

IntlCalendar::before

Whether this objectʼs time is before that of the passed object

说明

面向对象风格

public bool IntlCalendar::before ( <span class="methodparam">IntlCalendar $other )

过程化风格

bool <span class="methodname">intlcal_before ( <span class="methodparam">IntlCalendar $cal , IntlCalendar $other )

Returns whether this objectʼs time precedes the argumentʼs time.

参数

cal
The IntlCalendar resource.

other
The calendar whose time will be checked against the primary objectʼs time.

返回值

Returns true if this objectʼs current time is before that of the calendar argumentʼs time. Returns false otherwise. Also returns false on failure. You can use exceptions or <span class="function">intl_get_error_code to detect error conditions.

IntlCalendar::clear

Clear a field or all fields

说明

面向对象风格

public bool IntlCalendar::clear ([ <span class="methodparam">int $field<span class="initializer"> = NULL ] )

过程化风格

bool <span class="methodname">intlcal_clear ( <span class="methodparam">IntlCalendar $cal [, int $field = NULL ] )

Clears either all of the fields or a specific field. A cleared field is marked as unset, giving it the lowest priority against overlapping fields or even default values when calculating the time. Additionally, its value is set to 0, though given the fieldʼs low priority, its value may have been internally set to another value by the time the field has finished been queried.

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

返回值

Returns true on success 或者在失败时返回 false. Failure can only occur is invalid arguments are provided.

范例

示例 #1 IntlCalendar::clear examples

<?php
ini_set('intl.default_locale', 'es_ES');
ini_set('date.timezone', 'UTC');

$fields = array(
    'FIELD_ERA'                  => 0,
    'FIELD_YEAR'                 => 1,
    'FIELD_MONTH'                => 2,
    'FIELD_WEEK_OF_YEAR'         => 3,
    'FIELD_WEEK_OF_MONTH'        => 4,
    'FIELD_DATE'                 => 5,
    'FIELD_DAY_OF_YEAR'          => 6,
    'FIELD_DAY_OF_WEEK'          => 7,
    'FIELD_DAY_OF_WEEK_IN_MONTH' => 8,
    'FIELD_AM_PM'                => 9,
    'FIELD_HOUR'                 => 10,
    'FIELD_HOUR_OF_DAY'          => 11,
    'FIELD_MINUTE'               => 12,
    'FIELD_SECOND'               => 13,
    'FIELD_MILLISECOND'          => 14,
    'FIELD_ZONE_OFFSET'          => 15,
    'FIELD_DST_OFFSET'           => 16,
    'FIELD_YEAR_WOY'             => 17,
    'FIELD_DOW_LOCAL'            => 18,
    'FIELD_EXTENDED_YEAR'        => 19,
    'FIELD_JULIAN_DAY'           => 20,
    'FIELD_MILLISECONDS_IN_DAY'  => 21,
    'FIELD_IS_LEAP_MONTH'        => 22,
    'FIELD_FIELD_COUNT'          => 23,
);
function getSetFields(IntlCalendar $cal) {
    global $fields;
    $ret = array();
    foreach ($fields as $name => $value) {
        if ($cal->isSet($value)) {
            $ret[] = $name;
        }
    }
    return $ret;
}

$cal = new IntlGregorianCalendar(2013, 2 /* March */, 15);
echo "After GregorianCalendar creation\n";
print_r(getSetFields($cal));
echo "\n";

echo IntlDateFormatter::formatObject($cal), "\n";
echo "After the formatter requested the extended year\n";
print_r(getSetFields($cal));
echo "\n";

$cal->clear(IntlCalendar::FIELD_YEAR);
echo "After the year has been cleared, the date stays the same\n";
echo IntlDateFormatter::formatObject($cal), "\n";
echo "because FIELD_EXTENDED_YEAR is still set\n";
print_r(getSetFields($cal));
echo "\n";

var_dump($cal->clear(IntlCalendar::FIELD_EXTENDED_YEAR));
echo "After the extended year has been cleared\n";
print_r(getSetFields($cal));
echo IntlDateFormatter::formatObject($cal), "\n";
echo "\n";

echo "After the fields are recalculated,\n"
        . " extended year is set again (to 1970)\n";
print_r(getSetFields($cal));
echo "\n";

$cal->clear();
echo "After calling variant with no arguments\n";
print_r(getSetFields($cal));
echo IntlDateFormatter::formatObject($cal), "\n";

以上例程会输出：

After GregorianCalendar creation
Array
(
    [0] => FIELD_ERA
    [1] => FIELD_YEAR
    [2] => FIELD_MONTH
    [3] => FIELD_DATE
)

15/03/2013 00:00:00
After the formatter requested the extended year
Array
(
    [0] => FIELD_ERA
    [1] => FIELD_YEAR
    [2] => FIELD_MONTH
    [3] => FIELD_DATE
    [4] => FIELD_EXTENDED_YEAR
)

After the year has been cleared, the date stays the same
15/03/2013 00:00:00
because FIELD_EXTENDED_YEAR is still set
Array
(
    [0] => FIELD_ERA
    [1] => FIELD_MONTH
    [2] => FIELD_DATE
    [3] => FIELD_EXTENDED_YEAR
)

bool(true)
After the extended year has been cleared
Array
(
    [0] => FIELD_ERA
    [1] => FIELD_MONTH
    [2] => FIELD_DATE
)
15/03/1970 00:00:00

After the fields are recalculated,
 extended year is set again (to 1970)
Array
(
    [0] => FIELD_ERA
    [1] => FIELD_MONTH
    [2] => FIELD_DATE
    [3] => FIELD_EXTENDED_YEAR
)

After calling variant with no arguments
Array
(
)
01/01/1970 00:00:00

IntlCalendar::__construct

Private constructor for disallowing instantiation

说明

private <span class="methodname">IntlCalendar::__construct ( <span class="methodparam">void )

A private constructor for disallowing instantiation with the new operator.

Call IntlCalendar::createInstance instead.

参数

此函数没有参数。

返回值

没有返回值。

IntlCalendar::createInstance

Create a new IntlCalendar

说明

面向对象风格

public <span class="modifier">static IntlCalendar IntlCalendar::createInstance ([ <span class="methodparam">mixed $timeZone<span class="initializer"> = NULL [, <span class="methodparam">string $locale<span class="initializer"> = "" ]] )

过程化风格

IntlCalendar <span class="methodname">intlcal_create_instance ([ <span class="methodparam">mixed $timeZone<span class="initializer"> = NULL [, <span class="methodparam">string $locale<span class="initializer"> = "" ]] )

Given a timezone and locale, this method creates an <span class="classname">IntlCalendar object. This factory method may return a subclass of IntlCalendar.

The calendar created will represent the time instance at which it was created, based on the system time. The fields can all be cleared by calling IntCalendar::clear with no arguments. See also <span class="function">IntlGregorianCalendar::__construct.

参数

timeZone
The timezone to use.

• null, in which case the default timezone will be used, as specified in the ini setting date.timezone or through the function <span class="function">date_default_timezone_set and as returned by date_default_timezone_get.

• An IntlTimeZone, which will be used directly.

• A DateTimeZone. Its identifier will be extracted and an ICU timezone object will be created; the timezone will be backed by ICUʼs database, not PHPʼs.

• A string, which should be a valid ICU timezone identifier. See <span class="function">IntlTimeZone::createTimeZoneIDEnumeration. Raw offsets such as "GMT+08:30" are also accepted.

locale
A locale to use or null to use the default locale.

返回值

The created IntlCalendar instance or null on failure.

范例

示例 #1 IntlCalendar::createInstance

<?php
ini_set('intl.default_locale', 'es_ES');
ini_set('date.timezone', 'Europe/Madrid');

$cal = IntlCalendar::createInstance();
echo "No arguments\n";
var_dump(get_class($cal),
        IntlDateFormatter::formatObject($cal, IntlDateFormatter::FULL));
echo "\n";

echo "Explicit timezone\n";
$cal = IntlCalendar::createInstance(IntlTimeZone::getGMT());
var_dump(get_class($cal),
        IntlDateFormatter::formatObject($cal, IntlDateFormatter::FULL));
echo "\n";

echo "Explicit locale (with calendar)\n";
$cal = IntlCalendar::createInstance(NULL, 'es_ES@calendar=persian');
var_dump(get_class($cal),
        IntlDateFormatter::formatObject($cal, IntlDateFormatter::FULL));

以上例程会输出：

No arguments
string(21) "IntlGregorianCalendar"
string(68) "martes 18 de junio de 2013 14:11:02 Hora de verano de Europa Central"

Explicit timezone
string(21) "IntlGregorianCalendar"
string(45) "martes 18 de junio de 2013 12:11:02 GMT+00:00"

Explicit locale (with calendar)
string(12) "IntlCalendar"
string(70) "martes 28 de Khordad de 1392 14:11:02 Hora de verano de Europa Central"

参见

• IntlGregorianCalendar::__construct

IntlCalendar::equals

Compare time of two IntlCalendar objects for equality

说明

面向对象风格

public bool IntlCalendar::equals ( <span class="methodparam">IntlCalendar $other )

过程化风格

bool <span class="methodname">intlcal_equals ( <span class="methodparam">IntlCalendar $cal , IntlCalendar $other )

Returns true if this calendar and the given calendar have the same time. The settings, calendar types and field states do not have to be the same.

参数

cal
The IntlCalendar resource.

other
The calendar to compare with the primary object.

返回值

Returns true if the current time of both this and the passed in IntlCalendar object are the same, or false otherwise. The value false can also be returned on failure. This can only happen if bad arguments are passed in. In any case, the two cases can be distinguished by calling <span class="function">intl_get_error_code.

范例

示例 #1 IntlCalendar::equals

<?php
ini_set('date.timezone', 'UTC');

$cal1 = IntlCalendar::createInstance(NULL, 'es_ES');
$cal2 = clone $cal1;

var_dump($cal1->equals($cal2)); //TRUE

//The locale is not included in the comparison
$cal2 = IntlCalendar::createInstance(NULL, 'pt_PT');
$cal2->setTime($cal1->getTime());
var_dump($cal1->equals($cal2)); //TRUE

//And set fields state is not included as well
$cal2->clear(IntlCalendar::FIELD_YEAR);
var_dump($cal1->isSet(IntlCalendar::FIELD_YEAR) ==
        $cal2->isSet(IntlCalendar::FIELD_YEAR)); //FALSE
var_dump($cal1->equals($cal2)); //TRUE

//Neither is the calendar type
$cal2 = IntlCalendar::createInstance(NULL, 'es_ES@calendar=islamic');
$cal2->setTime($cal1->getTime());
var_dump($cal1->equals($cal2)); //TRUE

//Only the time is
$cal2 = clone $cal1;
$cal2->setTime($cal1->getTime() + 1.);
var_dump($cal1->equals($cal2)); //FALSE

IntlCalendar::fieldDifference

Calculate difference between given time and this objectʼs time

说明

面向对象风格

public <span class="type">intfalse <span class="methodname">IntlCalendar::fieldDifference ( <span class="methodparam">float $when , int $field )

过程化风格

int<span class="type">false <span class="methodname">intlcal_field_difference ( <span class="methodparam">IntlCalendar $cal , float $when , int $field )

Return the difference between the given time and the time this object is set to, with respect to the quantity specified the field parameter.

This method is meant to be called successively, first with the most significant field of interest down to the least significant field. To this end, as a side effect, this calendarʼs value for the field specified is advanced by the amount returned.

参数

cal
The IntlCalendar resource.

when
The time against which to compare the quantity represented by the field. For the result to be positive, the time given for this parameter must be ahead of the time of the object the method is being invoked on.

field
The field that represents the quantity being compared.

One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

返回值

Returns a (signed) difference of time in the unit associated with the specified field 或者在失败时返回 false.

范例

示例 #1 IntlCalendar::fieldDifference

<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'fr_FR');

$cal1 = IntlCalendar::fromDateTime('2012-02-29 09:00:11');
$cal2 = IntlCalendar::fromDateTime('2013-03-01 09:19:29');
$time = $cal2->getTime();

echo "Time before: ", IntlDateFormatter::formatObject($cal1), "\n";

printf(
    "The difference in time is %d year(s), %d month(s), "
  . "%d day(s), %d hour(s) and %d minute(s)\n",
    $cal1->fieldDifference($time, IntlCalendar::FIELD_YEAR),
    $cal1->fieldDifference($time, IntlCalendar::FIELD_MONTH),
    $cal1->fieldDifference($time, IntlCalendar::FIELD_DAY_OF_MONTH),
    $cal1->fieldDifference($time, IntlCalendar::FIELD_HOUR_OF_DAY),
    $cal1->fieldDifference($time, IntlCalendar::FIELD_MINUTE)
);

//now it was advanced to the target time, exception for the seconds,
//for which we did not measure the difference
echo "Time after: ", IntlDateFormatter::formatObject($cal1), "\n";

以上例程会输出：

Time before: 29 févr. 2012 09:00:11
The difference in time is 1 year(s), 0 month(s), 1 day(s), 0 hour(s) and 19 minute(s)
Time after: 1 mars 2013 09:19:11

IntlCalendar::fromDateTime

Create an IntlCalendar from a DateTime object or string

说明

面向对象风格

public <span class="modifier">static IntlCalendar IntlCalendar::fromDateTime ( <span class="methodparam">mixed $dateTime )

过程化风格

IntlCalendar <span class="methodname">intlcal_from_date_time ( <span class="methodparam">mixed $dateTime )

Creates an IntlCalendar object either from a DateTime object or from a string from which a DateTime object can be built.

The new calendar will represent not only the same instant as the given DateTime (subject to precision loss for dates very far into the past or future), but also the same timezone (subject to the caveat that different timezone databases will be used, and therefore the results may differ).

参数

dateTime
A DateTime object or a <span class="type">string that can be passed to <span class="function">DateTime::__construct.

返回值

The created IntlCalendar object or null in case of failure. If a string is passed, any exception that occurs inside the <span class="classname">DateTime constructor is propagated.

范例

示例 #1 IntlCalendar::fromDateTime

<?php
ini_set('date.timezone', 'Europe/Lisbon');

//same as IntlCalendar::fromDateTime(new DateTime(...))
$cal1 = IntlCalendar::fromDateTime('2013-02-28 00:01:02 Europe/Berlin');

//Note the timezone is Europe/Berlin, not the default Europe/Lisbon
echo IntlDateFormatter::formatObject($cal1, 'yyyy MMMM d HH:mm:ss VVVV', 'de_DE'), "\n";

以上例程会输出：

2013 Februar 28 00:01:02 Deutschland Zeit

IntlCalendar::get

Get the value for a field

说明

面向对象风格

public int <span class="methodname">IntlCalendar::get ( <span class="methodparam">int $field )

过程化风格

int <span class="methodname">intlcal_get ( <span class="type">IntlCalendar $cal , <span class="methodparam">int $field )

Gets the value for a specific field.

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

返回值

An integer with the value of the time field.

范例

示例 #1 IntlCalendar::get

<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'en_US');

$class = new ReflectionClass('IntlCalendar');
$fields = array();
foreach ($class->getConstants() as $name => $val) {
    if (strpos($name, 'FIELD_') !== 0 || $val > 22)
        continue;
    $fields[$val] = $name;
}

$cal = IntlCalendar::createInstance(); // current time
var_dump(IntlDateFormatter::formatObject($cal));
foreach ($fields as $val => $name) {
    echo "$val ($name)", "\n    ", $cal->get($val), "\n";
}

以上例程会输出：

string(23) "Jul 1, 2013, 4:44:44 AM"
0 (FIELD_ERA)
    1
1 (FIELD_YEAR)
    2013
2 (FIELD_MONTH)
    6
3 (FIELD_WEEK_OF_YEAR)
    27
4 (FIELD_WEEK_OF_MONTH)
    1
5 (FIELD_DAY_OF_MONTH)
    1
6 (FIELD_DAY_OF_YEAR)
    182
7 (FIELD_DAY_OF_WEEK)
    2
8 (FIELD_DAY_OF_WEEK_IN_MONTH)
    1
9 (FIELD_AM_PM)
    0
10 (FIELD_HOUR)
    4
11 (FIELD_HOUR_OF_DAY)
    4
12 (FIELD_MINUTE)
    44
13 (FIELD_SECOND)
    44
14 (FIELD_MILLISECOND)
    551
15 (FIELD_ZONE_OFFSET)
    0
16 (FIELD_DST_OFFSET)
    3600000
17 (FIELD_YEAR_WOY)
    2013
18 (FIELD_DOW_LOCAL)
    2
19 (FIELD_EXTENDED_YEAR)
    2013
20 (FIELD_JULIAN_DAY)
    2456475
21 (FIELD_MILLISECONDS_IN_DAY)
    17084551
22 (FIELD_IS_LEAP_MONTH)
    0

IntlCalendar::getActualMaximum

The maximum value for a field, considering the objectʼs current time

说明

面向对象风格

public <span class="type">intfalse <span class="methodname">IntlCalendar::getActualMaximum ( <span class="methodparam">int $field )

过程化风格

int<span class="type">false <span class="methodname">intlcal_get_actual_maximum ( <span class="methodparam">IntlCalendar $cal , int $field )

Returns a fieldʼs relative maximum value around the current time. The exact semantics vary by field, but in the general case this is the value that would be obtained if one would set the field value into the smallest relative maximum for the field and would increment it until reaching the global maximum or the field value wraps around, in which the value returned would be the global maximum or the value before the wrapping, respectively.

For instance, in the gregorian calendar, the actual maximum value for the day of month would vary between 28 and 31, depending on the month and year of the current time.

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

返回值

An int representing the maximum value in the units associated with the given field 或者在失败时返回 false.

范例

示例 #1 <span class="function">IntlCalendar::getActualMaximum

<?php
ini_set('date.timezone', 'Europe/Lisbon');

$cal = IntlCalendar::fromDateTime('2013-02-15');
var_dump($cal->getActualMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)); //28

$cal->add(IntlCalendar::FIELD_EXTENDED_YEAR, -1);
var_dump($cal->getActualMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)); //29

以上例程会输出：

int(28)
int(29)

参见

• IntlCalendar::getMaximum
• IntlCalendar::getLeastMaximum
• IntlCalendar::getActualMinimum

IntlCalendar::getActualMinimum

The minimum value for a field, considering the objectʼs current time

说明

面向对象风格

public <span class="type">intfalse <span class="methodname">IntlCalendar::getActualMinimum ( <span class="methodparam">int $field )

过程化风格

int<span class="type">false <span class="methodname">intlcal_get_actual_minimum ( <span class="methodparam">IntlCalendar $cal , int $field )

Returns a fieldʼs relative minimum value around the current time. The exact semantics vary by field, but in the general case this is the value that would be obtained if one would set the field value into the greatest relative minimum for the field and would decrement it until reaching the global minimum or the field value wraps around, in which the value returned would be the global minimum or the value before the wrapping, respectively.

For the Gregorian calendar, this is always the same as <span class="function">IntlCalendar::getMinimum.

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

返回值

An int representing the minimum value in the fieldʼs unit 或者在失败时返回 false.

参见

• IntlCalendar::getMinimum
• IntlCalendar::getGreatestMinimum
• IntlCalendar::getActualMaximum

IntlCalendar::getAvailableLocales

Get array of locales for which there is data

说明

面向对象风格

public <span class="modifier">static array <span class="methodname">IntlCalendar::getAvailableLocales ( <span class="methodparam">void )

过程化风格

array <span class="methodname">intlcal_get_available_locales ( <span class="methodparam">void )

Gives the list of locales for which calendars are installed. As of ICU 51, this is the list of all installed ICU locales.

参数

此函数没有参数。

返回值

An array of strings, one for which locale.

范例

示例 #1 <span class="function">IntlCalendar::getAvailableLocales

<?php
print_r(IntlCalendar::getAvailableLocales());

以上例程会输出：

Array
(
    [0] => af
    [1] => af_NA
    [2] => af_ZA
    [3] => agq
    [4] => agq_CM
    [5] => ak
    [6] => ak_GH
    [7] => am
    [8] => am_ET
    [9] => ar
    [10] => ar_001
    [11] => ar_AE
    [12] => ar_BH
    [13] => ar_DJ
    … output abbreviated …
    [595] => zh_Hant_HK
    [596] => zh_Hant_MO
    [597] => zh_Hant_TW
    [598] => zu
    [599] => zu_ZA
)

IntlCalendar::getDayOfWeekType

Tell whether a day is a weekday, weekend or a day that has a transition between the two

说明

面向对象风格

public <span class="type">intfalse <span class="methodname">IntlCalendar::getDayOfWeekType ( <span class="methodparam">int $dayOfWeek )

过程化风格

int<span class="type">false <span class="methodname">intlcal_get_day_of_week_type ( <span class="methodparam">IntlCalendar $cal , int $dayOfWeek )

Returns whether the passed day is a weekday (IntlCalendar::DOW_TYPE_WEEKDAY), a weekend day (IntlCalendar::DOW_TYPE_WEEKEND), a day during which a transition occurs into the weekend (IntlCalendar::DOW_TYPE_WEEKEND_OFFSET) or a day during which the weekend ceases (IntlCalendar::DOW_TYPE_WEEKEND_CEASE).

If the return is either IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or IntlCalendar::DOW_TYPE_WEEKEND_CEASE, then <span class="function">IntlCalendar::getWeekendTransition can be called to obtain the time of the transition.

This function requires ICU 4.4 or later.

参数

cal
The IntlCalendar resource.

dayOfWeek
One of the constants IntlCalendar::DOW_SUNDAY, IntlCalendar::DOW_MONDAY, …, IntlCalendar::DOW_SATURDAY.

返回值

Returns one of the constants IntlCalendar::DOW_TYPE_WEEKDAY, IntlCalendar::DOW_TYPE_WEEKEND, IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or IntlCalendar::DOW_TYPE_WEEKEND_CEASE 或者在失败时返回 false.

范例

示例 #1 <span class="function">IntlCalendar::getDayOfWeekType

<?php

foreach (array('en_US', 'ar_SA') as $locale) {
    echo "Locale: ", Locale::getDisplayName($locale, "en_US"), "\n";

    $cal = IntlCalendar::createInstance('UTC', $locale);

    for ($i = IntlCalendar::DOW_SUNDAY; $i <= IntlCalendar::DOW_SATURDAY; $i++) {
        echo $i, " ", $cal->getDayOfWeekType($i), " ",
                $cal->getDayOfWeekType($i) >= IntlCalendar::DOW_TYPE_WEEKEND_OFFSET
                        ? $cal->getWeekendTransition($i)
                        : '',
                "\n";
    }
    echo "\n";
}

以上例程会输出：

Locale: English (United States)
1 3 86400000
2 0 
3 0 
4 0 
5 0 
6 0 
7 1 

Locale: Arabic (Saudi Arabia)
1 0 
2 0 
3 0 
4 0 
5 1 
6 3 86400000
7 0 

IntlCalendar::getErrorCode

intlcal_get_error_code

Get last error code on the object

说明

面向对象风格 (method):

public int <span class="methodname">IntlCalendar::getErrorCode ( <span class="methodparam">void )

过程化风格:

int <span class="methodname">intlcal_get_error_code ( <span class="methodparam">IntlCalendar $calendar )

Returns the numeric ICU error code for the last call on this object (including cloning) or the IntlCalendar given for the calendar parameter (in the procedural‒style version). This may indicate only a warning (negative error code) or no error at all (U_ZERO_ERROR). The actual presence of an error can be tested with intl_is_failure.

Invalid arguments detected on the PHP side (before invoking functions of the ICU library) are not recorded for the purposes of this function.

The last error that occurred in any call to a function of the intl extension, including early argument errors, can be obtained with <span class="function">intl_get_error_code. This function resets the global error code, but not the objectʼs error code.

参数

calendar
The calendar object, on the procedural style interface.

返回值

An ICU error code indicating either success, failure or a warning.

范例

示例 #1 IntlCalendar::getErrorCode and IntlCalendar::getErrorMessage

<?php
ini_set("intl.error_level", E_WARNING);
ini_set("intl.default_locale", "nl");

$intlcal = new IntlGregorianCalendar(2012, 1, 29);
var_dump(
    $intlcal->getErrorCode(),
    $intlcal->getErrorMessage()
);
$intlcal->fieldDifference(-1e100, IntlCalendar::FIELD_SECOND);

var_dump(
    $intlcal->getErrorCode(),
    $intlcal->getErrorMessage()
);

以上例程会输出：

int(0)
string(12) "U_ZERO_ERROR"

Warning: IntlCalendar::fieldDifference(): intlcal_field_difference: Call to ICU method has failed in /home/glopes/php/ws/example.php on line 10
int(1)
string(81) "intlcal_field_difference: Call to ICU method has failed: U_ILLEGAL_ARGUMENT_ERROR"

参见

• IntlCalendar::getErrorMessage
• intl_is_failure
• intl_error_name
• intl_get_error_code
• intl_get_error_message

IntlCalendar::getErrorMessage

intlcal_get_error_message

Get last error message on the object

说明

面向对象风格 (method):

public string IntlCalendar::getErrorMessage ( <span class="methodparam">void )

过程化风格:

string <span class="methodname">intlcal_get_error_message ( <span class="methodparam">IntlCalendar $calendar )

Returns the error message (if any) associated with the error reported by IntlCalendar::getErrorCode or <span class="function">intlcal_get_error_code. If there is no associated error message, only the string representation of the name of the error constant will be returned. Otherwise, the message also includes a message set on the side of the PHP binding.

参数

calendar
The calendar object, on the procedural style interface.

返回值

The error message associated with last error that occurred in a function call on this object, or a string indicating the non-existance of an error.

范例

示例 #1 IntlCalendar::getErrorMessage

<?php
$cal = IntlCalendar::createInstance('UTC', 'en_US');
var_dump($cal->getErrorMessage());

$cal->getWeekendTransition(IntlCalendar::DOW_WEDNESDAY);
var_dump($cal->getErrorMessage());

以上例程会输出：

string(12) "U_ZERO_ERROR"
string(82) "intlcal_get_weekend_transition: Error calling ICU method: U_ILLEGAL_ARGUMENT_ERROR"

IntlCalendar::getFirstDayOfWeek

Get the first day of the week for the calendarʼs locale

说明

面向对象风格

public <span class="type">intfalse <span class="methodname">IntlCalendar::getFirstDayOfWeek ( <span class="methodparam">void )

过程化风格

int<span class="type">false <span class="methodname">intlcal_get_first_day_of_week ( <span class="methodparam">IntlCalendar $cal )

The week day deemed to start a week, either the default value for this locale or the value set with <span class="function">IntlCalendar::setFirstDayOfWeek.

参数

cal
The IntlCalendar resource.

返回值

One of the constants IntlCalendar::DOW_SUNDAY, IntlCalendar::DOW_MONDAY, …, IntlCalendar::DOW_SATURDAY 或者在失败时返回 false.

范例

示例 #1 <span class="function">IntlCalendar::getFirstDayOfWeek

<?php
ini_set('date.timezone', 'UTC');

$cal1 = IntlCalendar::createInstance(NULL, 'es_ES');
var_dump($cal1->getFirstDayOfWeek()); // Monday
$cal1->set(2013, 1 /* February */, 3); // a Sunday
var_dump($cal1->get(IntlCalendar::FIELD_WEEK_OF_YEAR)); // 5

$cal2 = IntlCalendar::createInstance(NULL, 'en_US');
var_dump($cal2->getFirstDayOfWeek()); // Sunday
$cal2->set(2013, 1 /* February */, 3); // a Sunday
var_dump($cal2->get(IntlCalendar::FIELD_WEEK_OF_YEAR)); // 6

以上例程会输出：

int(2)
int(5)
int(1)
int(6)

参见

• IntlCalendar::setFirstDayOfWeek

IntlCalendar::getGreatestMinimum

Get the largest local minimum value for a field

说明

面向对象风格

public <span class="type">intfalse <span class="methodname">IntlCalendar::getGreatestMinimum ( <span class="methodparam">int $field )

过程化风格

int<span class="type">false <span class="methodname">intlcal_get_greatest_minimum ( <span class="methodparam">IntlCalendar $cal , int $field )

Returns the largest local minimum for a field. This should be a value larger or equal to that returned by <span class="function">IntlCalendar::getActualMinimum, which is in its turn larger or equal to that returned by <span class="function">IntlCalendar::getMinimum. All these three functions return the same value for the Gregorian calendar.

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

返回值

An int representing a field value, in the fieldʼs unit, 或者在失败时返回 false.

IntlCalendar::getKeywordValuesForLocale

Get set of locale keyword values

说明

面向对象风格

public <span class="modifier">static <span class="type">Iteratorfalse <span class="methodname">IntlCalendar::getKeywordValuesForLocale ( string $key , string $locale , <span class="type">bool $commonlyUsed )

过程化风格

static <span class="type">Iteratorfalse <span class="methodname">intlcal_get_keyword_values_for_locale ( string $key , string $locale , <span class="type">bool $commonlyUsed )

For a given locale key, get the set of values for that key that would result in a different behavior. For now, only the 'calendar' keyword is supported.

This function requires ICU 4.2 or later.

参数

key
The locale keyword for which relevant values are to be queried. Only 'calendar' is supported.

locale
The locale onto which the keyword/value pair are to be appended.

commonlyUsed
Whether to show only the values commonly used for the specified locale.

返回值

An iterator that yields strings with the locale keyword values 或者在失败时返回 false.

范例

示例 #1 <span class="function">IntlCalendar::getKeyworkValuesForLocale

<?php
print_r(
        iterator_to_array(
                IntlCalendar::getKeywordValuesForLocale(
                        'calendar', 'fa_IR', true)));
print_r(
        iterator_to_array(
                IntlCalendar::getKeywordValuesForLocale(
                        'calendar', 'fa_IR', false)));

以上例程会输出：

Array
(
    [0] => persian
    [1] => gregorian
    [2] => islamic
    [3] => islamic-civil
)
Array
(
    [0] => persian
    [1] => gregorian
    [2] => islamic
    [3] => islamic-civil
    [4] => japanese
    [5] => buddhist
    [6] => roc
    [7] => hebrew
    [8] => chinese
    [9] => indian
    [10] => coptic
    [11] => ethiopic
    [12] => ethiopic-amete-alem
)

IntlCalendar::getLeastMaximum

Get the smallest local maximum for a field

说明

面向对象风格

public <span class="type">intfalse <span class="methodname">IntlCalendar::getLeastMaximum ( <span class="methodparam">int $field )

过程化风格

int<span class="type">false <span class="methodname">intlcal_get_least_maximum ( <span class="methodparam">IntlCalendar $cal , int $field )

Returns the smallest local maximumw for a field. This should be a value smaller or equal to that returned by <span class="function">IntlCalendar::getActualMaxmimum, which is in its turn smaller or equal to that returned by <span class="function">IntlCalendar::getMaximum.

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

返回值

An int representing a field value in the fieldʼs unit 或者在失败时返回 false.

范例

示例 #1 Maxima examples

<?php
ini_set('date.timezone', 'UTC');
ini_set('intl.default_locale', 'it_IT');

$cal = new IntlGregorianCalendar(2013, 3 /* April */, 6);
var_dump(
    $cal->getLeastMaximum(IntlCalendar::FIELD_DAY_OF_MONTH),  // 28
    $cal->getActualMaximum(IntlCalendar::FIELD_DAY_OF_MONTH), // 30
    $cal->getMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)        // 31
);

以上例程会输出：

int(28)
int(30)
int(31)

参见

• IntlCalendar::getActualMaximum
• IntlCalendar::getMaximum
• IntlCalendar::getGreatestMinimum

IntlCalendar::getLocale

Get the locale associated with the object

说明

面向对象风格

public <span class="type">stringfalse <span class="methodname">IntlCalendar::getLocale ( <span class="methodparam">int $localeType )

过程化风格

string<span class="type">false <span class="methodname">intlcal_get_locale ( <span class="methodparam">IntlCalendar $cal , int $localeType )

Returns the locale used by this calendar object.

参数

cal
The IntlCalendar resource.

localeType
Whether to fetch the actual locale (the locale from which the calendar data originates, with Locale::ACTUAL_LOCALE) or the valid locale, i.e., the most specific locale supported by ICU relatively to the requested locale – see Locale::VALID_LOCALE. From the most general to the most specific, the locales are ordered in this fashion – actual locale, valid locale, requested locale.

返回值

A locale string 或者在失败时返回 false.

范例

示例 #1 IntlCalendar::getLocale

<?php
$cal = IntlCalendar::createInstance(IntlTimeZone::getGMT(), 'en_US_CALIFORNIA');
var_dump(
    $cal->getLocale(Locale::ACTUAL_LOCALE),
    $cal->getLocale(Locale::VALID_LOCALE)
);

以上例程会输出：

string(2) "en"
string(5) "en_US"

IntlCalendar::getMaximum

Get the global maximum value for a field

说明

面向对象风格

public <span class="type">intfalse <span class="methodname">IntlCalendar::getMaximum ( <span class="methodparam">int $field )

过程化风格

int<span class="type">false <span class="methodname">intlcal_get_maximum ( <span class="methodparam">IntlCalendar $cal , int $field )

Gets the global maximum for a field, in this specific calendar. This value is larger or equal to that returned by <span class="function">IntlCalendar::getActualMaximum, which is in its turn larger or equal to that returned by <span class="function">IntlCalendar::getLeastMaximum.

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

返回值

An int representing a field value in the fieldʼs unit 或者在失败时返回 false.

参见

• IntlCalendar::getActualMaximum
• IntlCalendar::getLeastMaximum
• IntlCalendar::getMinimum

IntlCalendar::getMinimalDaysInFirstWeek

Get minimal number of days the first week in a year or month can have

说明

面向对象风格

public <span class="type">intfalse <span class="methodname">IntlCalendar::getMinimalDaysInFirstWeek ( void )

过程化风格

int<span class="type">false <span class="methodname">intlcal_get_minimal_days_in_first_week ( IntlCalendar $cal )

Returns the smallest number of days the first week of a year or month must have in the new year or month. For instance, in the Gregorian calendar, if this value is 1, then the first week of the year will necessarily include January 1st, while if this value is 7, then the week with January 1st will be the first week of the year only if the day of the week for January 1st matches the day of the week returned by <span class="function">IntlCalendar::getFirstDayOfWeek; otherwise it will be the previous yearʼs last week.

参数

cal
The IntlCalendar resource.

返回值

An int representing a number of days 或者在失败时返回 false.

范例

示例 #1 <span class="function">IntlCalendar::getMinimalDaysInFirstWeek

<?php
ini_set('date.timezone', 'UTC');
ini_set('intl.default_locale', 'en_US');

$cal = new IntlGregorianCalendar(2013, 0 /* January */, 2);
var_dump(IntlDateFormatter::formatObject($cal, 'cccc')); // Wednesday

var_dump($cal->getMinimalDaysInFirstWeek(), // 1
$cal->getFirstDayofWeek()); // 1 (Sunday)

// Week 1 of 2013
var_dump(IntlDateFormatter::formatObject($cal, "'Week 'w' of 'Y"));

$cal->setMinimalDaysInFirstWeek(4);
// Still Week 1 of 2013 (1st week has 5 days in the new year)
var_dump(IntlDateFormatter::formatObject($cal, "'Week 'w' of 'Y"));

$cal->setMinimalDaysInFirstWeek(6);
// Week 53 of 2012
var_dump(IntlDateFormatter::formatObject($cal, "'Week 'w' of 'Y"));

以上例程会输出：

string(9) "Wednesday"
int(1)
int(1)
string(14) "Week 1 of 2013"
string(14) "Week 1 of 2013"
string(15) "Week 53 of 2012"

IntlCalendar::getMinimum

Get the global minimum value for a field

说明

面向对象风格

public <span class="type">intfalse <span class="methodname">IntlCalendar::getMinimum ( <span class="methodparam">int $field )

过程化风格

int<span class="type">false <span class="methodname">intlcal_get_minimum ( <span class="methodparam">IntlCalendar $cal , int $field )

Gets the global minimum for a field, in this specific calendar. This value is smaller or equal to that returned by <span class="function">IntlCalendar::getActualMinimum, which is in its turn smaller or equal to that returned by <span class="function">IntlCalendar::getGreatestMinimum. For the Gregorian calendar, these three functions always return the same value (for each field).

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

返回值

An int representing a value for the given field in the fieldʼs unit 或者在失败时返回 false.

IntlCalendar::getNow

Get number representing the current time

说明

面向对象风格

public <span class="modifier">static float <span class="methodname">IntlCalendar::getNow ( <span class="methodparam">void )

过程化风格

float <span class="methodname">intlcal_get_now ( <span class="methodparam">void )

The number of milliseconds that have passed since the reference date. This number is derived from the system time.

参数

此函数没有参数。

返回值

A float representing a number of milliseconds since the epoch, not counting leap seconds.

范例

示例 #1 IntlCalendar::getNow

<?php
$formatter = IntlDateFormatter::create('es_ES',
        IntlDateFormatter::FULL,
        IntlDateFormatter::FULL,
        'Europe/Madrid');

$val = IntlCalendar::getNow();

var_dump($val);
echo $formatter->format(IntlCalendar::getNow() / 1000.), "\n";

以上例程会输出：

float(1371425814666)
lunes, 17 de junio de 2013 01:36:54 Hora de verano de Europa central

IntlCalendar::getRepeatedWallTimeOption

Get behavior for handling repeating wall time

说明

面向对象风格

public int <span class="methodname">IntlCalendar::getRepeatedWallTimeOption ( void )

过程化风格

int <span class="methodname">intlcal_get_repeated_wall_time_option ( IntlCalendar $cal )

Gets the current strategy for dealing with wall times that are repeated whenever the clock is set back during dailight saving time end transitions. The default value is IntlCalendar::WALLTIME_LAST.

This function requires ICU 4.9 or later.

参数

cal
The IntlCalendar resource.

返回值

One of the constants IntlCalendar::WALLTIME_FIRST or IntlCalendar::WALLTIME_LAST.

范例

示例 #1 <span class="function">IntlCalendar::getRepeatedWallTimeOption

<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'en_US');
ini_set('intl.error_level', E_WARNING);

//On October 27th at 0200, the clock goes back 1 hour and from GMT+01 to GMT+00
$cal = new IntlGregorianCalendar(2013, 9 /* October */, 27, 1, 30);

var_dump($cal->getRepeatedWalltimeOption()); // 0 WALLTIME_LAST

$formatter = IntlDateFormatter::create(
    NULL,
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'UTC'
);
var_dump($formatter->format($cal->getTime() / 1000.));

$cal->setRepeatedWalltimeOption(IntlCalendar::WALLTIME_FIRST);
var_dump($cal->getRepeatedWalltimeOption()); // 1 WALLTIME_FIRST
$cal->set(IntlCalendar::FIELD_HOUR_OF_DAY, 1);

var_dump($formatter->format($cal->getTime() / 1000.));

以上例程会输出：

int(0)
string(42) "Sunday, October 27, 2013 at 1:30:00 AM GMT"
int(1)
string(43) "Sunday, October 27, 2013 at 12:30:00 AM GMT"

参见

• <span class="methodname">IntlCalendar::getSkippedWallTimeOption
• <span class="methodname">IntlCalendar::setSkippedWallTimeOption
• <span class="methodname">IntlCalendar::setRepeatedWallTimeOption

IntlCalendar::getSkippedWallTimeOption

Get behavior for handling skipped wall time

说明

面向对象风格

public int <span class="methodname">IntlCalendar::getSkippedWallTimeOption ( <span class="methodparam">void )

过程化风格

int <span class="methodname">intlcal_get_skipped_wall_time_option ( IntlCalendar $cal )

Gets the current strategy for dealing with wall times that are skipped whenever the clock is forwarded during dailight saving time start transitions. The default value is IntlCalendar::WALLTIME_LAST.

The calendar must be lenient for this option to have any effect, otherwise attempting to set a non-existing time will cause an error.

This function requires ICU 4.9 or later.

参数

cal
The IntlCalendar resource.

返回值

One of the constants IntlCalendar::WALLTIME_FIRST, IntlCalendar::WALLTIME_LAST or IntlCalendar::WALLTIME_NEXT_VALID.

范例

示例 #1 <span class="function">IntlCalendar::getSkippedWallTimeOption

<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'en_US');
ini_set('intl.error_level', E_WARNING);

//On March 31st at 0100, the clock goes forward 1 hour and from GMT+00 to GMT+01
$cal = new IntlGregorianCalendar(2013, 2 /* March */, 31, 1, 30);

var_dump(
    $cal->isLenient(),               // true
    $cal->getSkippedWalltimeOption() // 0 WALLTIME_LAST
);

$formatter = IntlDateFormatter::create(
    NULL,
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'UTC'
);
var_dump($formatter->format($cal->getTime() / 1000));

$cal->setSkippedWallTimeOption(IntlCalendar::WALLTIME_FIRST);
var_dump($cal->getSkippedWalltimeOption()); // 1 WALLTIME_FIRST
$cal->set(IntlCalendar::FIELD_HOUR_OF_DAY, 1);

var_dump($formatter->format($cal->getTime() / 1000));

$cal->setSkippedWallTimeOption(IntlCalendar::WALLTIME_NEXT_VALID);
var_dump($cal->getSkippedWalltimeOption()); // 2 WALLTIME_NEXT_VALID
$cal->set(IntlCalendar::FIELD_HOUR_OF_DAY, 1);

var_dump($formatter->format($cal->getTime() / 1000));

以上例程会输出：

bool(true)
int(0)
string(40) "Sunday, March 31, 2013 at 1:30:00 AM GMT"
int(1)
string(41) "Sunday, March 31, 2013 at 12:30:00 AM GMT"
int(2)
string(40) "Sunday, March 31, 2013 at 1:00:00 AM GMT"

参见

• <span class="methodname">IntlCalendar::getRepeatedWallTimeOption
• <span class="methodname">IntlCalendar::setSkippedWallTimeOption
• <span class="methodname">IntlCalendar::setRepeatedWallTimeOption

IntlCalendar::getTime

Get time currently represented by the object

说明

面向对象风格

public float IntlCalendar::getTime ( <span class="methodparam">void )

过程化风格

float <span class="methodname">intlcal_get_time ( <span class="methodparam">IntlCalendar $cal )

Returns the time associated with this object, expressed as the number of milliseconds since the epoch.

参数

cal
The IntlCalendar resource.

返回值

A float representing the number of milliseconds elapsed since the reference time (1 Jan 1970 00:00:00 UTC).

范例

示例 #1 IntlCalendar::getTime

<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'en_US');

$cal = new IntlGregorianCalendar(2013, 4 /* May */, 1, 0, 0, 0);
$time = $cal->getTime();
var_dump($time, $time / 1000 == strtotime('2013-05-01 00:00:00')); //true

以上例程会输出：

float(1367362800000)
bool(true)

参见

• IntlCalendar::getNow

IntlCalendar::getTimeZone

Get the objectʼs timezone

说明

面向对象风格

public <span class="type">IntlTimeZone <span class="methodname">IntlCalendar::getTimeZone ( <span class="methodparam">void )

过程化风格

IntlTimeZone <span class="methodname">intlcal_get_time_zone ( <span class="methodparam">IntlCalendar $cal )

Returns the IntlTimeZone object associated with this calendar.

参数

cal
The IntlCalendar resource.

返回值

An IntlTimeZone object corresponding to the one used internally in this object.

范例

示例 #1 IntlCalendar::getTimeZone

<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'en_US');

$cal = IntlCalendar::createInstance();
print_r($cal->getTimeZone());

$cal->setTimeZone('UTC');
print_r($cal->getTimeZone());

$cal = IntlCalendar::fromDateTime('2012-01-01 00:00:00 GMT+03:33');
print_r($cal->getTimeZone());

以上例程会输出：

IntlTimeZone Object
(
    [valid] => 1
    [id] => Europe/Lisbon
    [rawOffset] => 0
    [currentOffset] => 3600000
)
IntlTimeZone Object
(
    [valid] => 1
    [id] => UTC
    [rawOffset] => 0
    [currentOffset] => 0
)
IntlTimeZone Object
(
    [valid] => 1
    [id] => GMT+03:33
    [rawOffset] => 12780000
    [currentOffset] => 12780000
)

参见

• IntlCalendar::setTimeZone
• IntlCalendar::createInstance
• IntlGregorianCalendar::__construct

IntlCalendar::getType

Get the calendar type

说明

面向对象风格

public string IntlCalendar::getType ( <span class="methodparam">void )

过程化风格

string <span class="methodname">intlcal_get_type ( <span class="methodparam">IntlCalendar $cal )

A string describing the type of this calendar. This is one of the valid values for the calendar keyword value 'calendar'.

参数

cal
The IntlCalendar resource.

返回值

A string representing the calendar type, such as 'gregorian', 'islamic', etc.

范例

示例 #1 IntlCalendar::getType

<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'en_US');

$cal = IntlCalendar::createInstance(NULL, '@calendar=ethiopic-amete-alem');
var_dump($cal->getType());

$cal = new IntlGregorianCalendar();
var_dump($cal->getType());

以上例程会输出：

string(19) "ethiopic-amete-alem"
string(9) "gregorian"

IntlCalendar::getWeekendTransition

Get time of the day at which weekend begins or ends

说明

面向对象风格

public <span class="type">intfalse <span class="methodname">IntlCalendar::getWeekendTransition ( <span class="methodparam">string $dayOfWeek )

过程化风格

int<span class="type">false <span class="methodname">intlcal_get_weekend_transition ( <span class="methodparam">IntlCalendar $cal , string $dayOfWeek )

Returns the number of milliseconds after midnight at which the weekend begins or ends.

This is only applicable for days of the week for which <span class="function">IntlCalendar::getDayOfWeekType returns either IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or IntlCalendar::DOW_TYPE_WEEKEND_CEASE. Calling this function for other days of the week is an error condition.

This function requires ICU 4.4 or later.

参数

cal
The IntlCalendar resource.

dayOfWeek
One of the constants IntlCalendar::DOW_SUNDAY, IntlCalendar::DOW_MONDAY, …, IntlCalendar::DOW_SATURDAY.

返回值

The number of milliseconds into the day at which the weekend begins or ends 或者在失败时返回 false.

范例

See example on <span class="function">IntlCalendar::getDayOfWeekType.

IntlCalendar::inDaylightTime

Whether the objectʼs time is in Daylight Savings Time

说明

面向对象风格

public bool IntlCalendar::inDaylightTime ( <span class="methodparam">void )

过程化风格

bool <span class="methodname">intlcal_in_daylight_time ( <span class="methodparam">IntlCalendar $cal )

Whether, for the instant represented by this object and for this objectʼs timezone, daylight saving time is in place.

参数

cal
The IntlCalendar resource.

返回值

Returns true if the date is in Daylight Savings Time, false otherwise. The value false may also be returned on failure, for instance after specifying invalid field values on non-lenient mode; use exceptions or query <span class="function">intl_get_error_code to disambiguate.

范例

示例 #1 IntlCalendar::inDaylightTime

<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'pt_PT');

$cal = new IntlGregorianCalendar(2013, 6 /* July */, 1, 4, 56, 31);
var_dump($cal->inDaylightTime()); // true
$cal->set(IntlCalendar::FIELD_MONTH, 11 /* December */);
var_dump($cal->inDaylightTime()); // false

//DST end transition on 2013-10-27 at 0200 (wall time back 1 hour)
$cal = new IntlGregorianCalendar(2013, 9 /* October */, 27, 1, 30, 0);

var_dump($cal->inDaylightTime()); // false (default WALLTIME_LAST)

$cal->setRepeatedWallTimeOption(IntlCalendar::WALLTIME_FIRST);
$cal->set(IntlCalendar::FIELD_HOUR_OF_DAY, 1); // force time recalculation
var_dump($cal->inDaylightTime()); // true

IntlCalendar::isEquivalentTo

Whether another calendar is equal but for a different time

说明

面向对象风格

public bool IntlCalendar::isEquivalentTo ( <span class="methodparam">IntlCalendar $other )

过程化风格

bool <span class="methodname">intlcal_is_equivalent_to ( <span class="methodparam">IntlCalendar $cal , IntlCalendar $other )

Returns whether this and the given object are equivalent for all purposes except as to the time they have set. The locales do not have to match, as long as no change in behavior results from such mismatch. This includes the timezone, whether the lenient mode is set, the repeated and skipped wall time settings, the days of the week when the weekend starts and ceases and the times where such transitions occur. It may also include other calendar specific settings, such as the Gregorian/Julian transition instant.

参数

cal
The IntlCalendar resource.

other
The other calendar against which the comparison is to be made.

返回值

Assuming there are no argument errors, returns true if the calendars are equivalent except possibly for their set time.

范例

示例 #1 IntlCalendar::isEquivalentTo

<?php
$cal1 = IntlCalendar::createInstance('Europe/Lisbon', 'pt_PT');
$cal2 = IntlCalendar::createInstance('Europe/Lisbon', 'es_ES');
$cal2->clear();

var_dump($cal1->isEquivalentTo($cal2)); // true

$cal3 = IntlCalendar::createInstance('Europe/Lisbon', 'en_US');
var_dump($cal1->isEquivalentTo($cal3)); // false
var_dump($cal1->getFirstDayOfWeek(),    // 2 (Monday)
$cal3->getFirstDayOfWeek());            // 1 (Sunday)

以上例程会输出：

bool(true)
bool(false)
int(2)
int(1)

参见

• IntlCalendar::equals

IntlCalendar::isLenient

Whether date/time interpretation is in lenient mode

说明

面向对象风格

public bool IntlCalendar::isLenient ( <span class="methodparam">void )

过程化风格

bool <span class="methodname">intlcal_is_lenient ( <span class="methodparam">IntlCalendar $cal )

Returns whether the current date/time interpretations is lenient (the default). If that is case, some out of range values for fields will be accepted instead of raising an error.

参数

cal
The IntlCalendar resource.

返回值

A bool representing whether the calendar is set to lenient mode.

范例

示例 #1 IntlCalendar::isLenient

<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'pt_PT');
ini_set('intl.use_exceptions', '1');

$cal = new IntlGregorianCalendar(2013, 6 /* July */, 1);
var_dump(IntlDateFormatter::formatObject($cal), // 01/07/2013, 00:00:00
$cal->isLenient()); // true

$cal->set(IntlCalendar::FIELD_DAY_OF_MONTH, 33);
var_dump(IntlDateFormatter::formatObject($cal)); // 02/08/2013, 00:00:00

$cal->setLenient(false);
var_dump($cal->isLenient()); // false
$cal->set(IntlCalendar::FIELD_DAY_OF_MONTH, 33);
var_dump(IntlDateFormatter::formatObject($cal)); // error

以上例程会输出：

string(20) "01/07/2013, 00:00:00"
bool(true)
string(20) "02/08/2013, 00:00:00"
bool(false)

Fatal error: Uncaught exception 'IntlException' with message 'datefmt_format_object: error obtaining instant from IntlCalendar' in /home/foobar/example.php:16
Stack trace:
#0 /home/foobar/example.php(16): IntlDateFormatter::formatObject(Object(IntlGregorianCalendar))
#1 {main}
  thrown in /home/foobar/example.php on line 16

IntlCalendar::isSet

Whether a field is set

说明

面向对象风格

public bool IntlCalendar::isSet ( <span class="methodparam">int $field )

过程化风格

bool <span class="methodname">intlcal_is_set ( <span class="methodparam">IntlCalendar $cal , int $field )

Returns whether a field is set (as opposed to clear). Set fields take priority over unset fields and their default values when the date/time is being calculated. Fields set later take priority over fields set earlier.

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

返回值

Assuming there are no argument errors, returns true if the field is set.

范例

See the example on IntlCalendar::clear.

参见

• IntlCalendar::clear
• IntlCalendar::set

IntlCalendar::isWeekend

Whether a certain date/time is in the weekend

说明

面向对象风格

public bool IntlCalendar::isWeekend ([ <span class="methodparam">float $date<span class="initializer"> = NULL ] )

过程化风格

bool <span class="methodname">intlcal_is_weekend ( <span class="methodparam">IntlCalendar $cal [, float $date = NULL ] )

Returns whether either the obejctʼs current time or the provided timestamp occur during a weekend in this objectʼs calendar system.

This function requires ICU 4.4 or later.

参数

cal
The IntlCalendar resource.

date
An optional timestamp representing the number of milliseconds since the epoch, excluding leap seconds. If null, this objectʼs current time is used instead.

返回值

A bool indicating whether the given or this objectʼs time occurs in a weekend.

The value false may also be returned on failure, for instance after giving a date out of bounds on non-lenient mode; use exceptions or query <span class="function">intl_get_error_code to disambiguate.

范例

示例 #1 IntlCalendar::isWeekend

<?php
ini_set('date.timezone', 'Europe/Lisbon');

$cal = new IntlGregorianCalendar(NULL, 'en_US');
$cal->set(2013, 6 /* July */, 7); // a Sunday 

var_dump($cal->isWeekend()); // true
var_dump($cal->isWeekend(strtotime('2013-07-01 00:00:00'))); // false, Monday

$cal = new IntlGregorianCalendar(NULL, 'ar_SA');
$cal->set(2013, 6 /* July */, 7); // a Sunday 
var_dump($cal->isWeekend()); // false, Sunday not in weekend in this calendar

参见

• IntlCalendar::getDayOfWeekType
• IntlCalendar::getWeekendTransition

IntlCalendar::roll

Add value to field without carrying into more significant fields

说明

面向对象风格

public bool IntlCalendar::roll ( <span class="methodparam">int $field , mixed $amountOrUpOrDown )

过程化风格

bool <span class="methodname">intlcal_roll ( <span class="methodparam">IntlCalendar $cal , int $field , <span class="type">mixed $amountOrUpOrDown )

Adds a (signed) amount to a field. The difference with respect to <span class="function">IntlCalendar::add is that when the field value overflows, it does not carry into more significant fields.

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

amountOrUpOrDown
The (signed) amount to add to the field, true for rolling up (adding 1), or false for rolling down (subtracting 1).

返回值

Returns true on success or false on failure.

范例

示例 #1 IntlCalendar::roll

<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'pt_PT');

$cal = new IntlGregorianCalendar(2013, 5 /* June */, 30);

$cal->add(IntlCalendar::FIELD_DAY_OF_MONTH, 1);
var_dump(IntlDateFormatter::formatObject($cal)); // "01/07/2013, 00:00:00"

$cal->set(2013, 5 /* June */, 30);
$cal->roll(IntlCalendar::FIELD_DAY_OF_MONTH, true); // roll up, same as rolling +1
var_dump(IntlDateFormatter::formatObject($cal)); // "01/06/2013, 00:00:00"

以上例程会输出：

string(20) "01/07/2013, 00:00:00"
string(20) "01/06/2013, 00:00:00"

参见

• IntlCalendar::add
• IntlCalendar::set

IntlCalendar::set

Set a time field or several common fields at once

说明

面向对象风格

public bool IntlCalendar::set ( <span class="methodparam">int $field , int $value )

public bool IntlCalendar::set ( <span class="methodparam">int $year , <span class="methodparam">int $month [, int $dayOfMonth = NULL [, <span class="methodparam">int $hour<span class="initializer"> = NULL [, <span class="methodparam">int $minute<span class="initializer"> = NULL [, <span class="methodparam">int $second<span class="initializer"> = NULL ]]]] )

过程化风格

bool <span class="methodname">intlcal_set ( <span class="type">IntlCalendar $cal , <span class="methodparam">int $field , int $value )

bool <span class="methodname">intlcal_set ( <span class="type">IntlCalendar $cal , <span class="methodparam">int $year , <span class="methodparam">int $month [, int $dayOfMonth = NULL [, <span class="methodparam">int $hour<span class="initializer"> = NULL [, <span class="methodparam">int $minute<span class="initializer"> = NULL [, <span class="methodparam">int $second<span class="initializer"> = NULL ]]]] )

Sets either a specific field to the given value, or sets at once several common fields. The range of values that are accepted depend on whether the calendar is using the lenient mode.

For fields that conflict, the fields that are set later have priority.

This method cannot be called with exactly four arguments.

参数

cal
The IntlCalendar resource.

field
One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

value
The new value of the given field.

year
The new value for IntlCalendar::FIELD_YEAR.

month
The new value for IntlCalendar::FIELD_MONTH. The month sequence is zero-based, i.e., January is represented by 0, February by 1, …, December is 11 and Undecember (if the calendar has it) is 12.

dayOfMonth
The new value for IntlCalendar::FIELD_DAY_OF_MONTH.

hour
The new value for IntlCalendar::FIELD_HOUR_OF_DAY.

minute
The new value for IntlCalendar::FIELD_MINUTE.

second
The new value for IntlCalendar::FIELD_SECOND.

返回值

Returns true on success and false on failure.

范例

示例 #1 IntlCalendar::set

<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'pt_PT');

//Calls made later have priority
$cal = new IntlGregorianCalendar(2013, 6 /* July */, 1);
$cal->set(IntlCalendar::FIELD_YEAR, 2012);
$cal->set(IntlCalendar::FIELD_EXTENDED_YEAR, 2011);
var_dump(IntlDateFormatter::formatObject($cal));


$cal = new IntlGregorianCalendar(2013, 6 /* July */, 1);
$cal->set(IntlCalendar::FIELD_YEAR, 2012);
$cal->set(IntlCalendar::FIELD_EXTENDED_YEAR, 2011);
//the time has not been recalculated yet. If we clear the extended year,
//the year set before will be used
$cal->clear(IntlCalendar::FIELD_EXTENDED_YEAR);
var_dump(IntlDateFormatter::formatObject($cal));

以上例程会输出：

string(20) "01/07/2011, 00:00:00"
string(20) "01/07/2012, 00:00:00"

参见