Internationalization FunctionsTable of Contents
The Collator classIntroductionProvides string comparison capability with support for appropriate locale-sensitive sort orderings. Class synopsis
Collator
class Collator
{
/* Methods */
public __construct
( string
$locale
)
public
bool
asort
( array
&$arr
[, int $sort_flag
] )
public
int
compare
( string
$str1
, string $str2
)
public
static
Collator
create
( string
$locale
)
public
int
getAttribute
( int
$attr
)
public
int
getErrorCode
( void
)
public
string
getErrorMessage
( void
)
public
string
getLocale
( int
$type
)
public
string
getSortKey
( string
$str
)
public
int
getStrength
( void
)
public
bool
setAttribute
( int
$attr
, int $val
)
public
bool
setStrength
( int
$strength
)
public
bool
sortWithSortKeys
( array
&$arr
)
public
bool
sort
( array
}&$arr
[, int $sort_flag
] )Predefined Constants
The NumberFormatter classIntroductionPrograms 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:
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. Class synopsis
NumberFormatter
class NumberFormatter
{
/* Methods */
public
__construct
( string
$locale
, int $style
[, string $pattern
] )
public
static
NumberFormatter
create
( string
$locale
, int $style
[, string $pattern
] )
public
string
formatCurrency
( float
$value
, string $currency
)
public
string
format
( number
$value
[, int $type
] )
public
int
getAttribute
( int
$attr
)
public
int
getErrorCode
( void
)
public
string
getErrorMessage
( void
)
public
string
getLocale
([ int
$type
] )
public
string
getPattern
( void
)
public
string
getSymbol
( int
$attr
)
public
string
getTextAttribute
( int
$attr
)
public
float
parseCurrency
( string
$value
, string &$currency
[, int &$position
] )
public
mixed
parse
( string
$value
[, int $type
[, int &$position
]] )
public
bool
setAttribute
( int
$attr
, int $value
)
public
bool
setPattern
( string
$pattern
)
public
bool
setSymbol
( int
$attr
, string $value
)
public
bool
setTextAttribute
( int
}$attr
, string $value
)Predefined ConstantsThese styles are used by the numfmt_create to define the type of the formatter.
These constants define how the numbers are parsed or formatted. They should be used as arguments to numfmt_format and numfmt_parse.
Number format attribute used by numfmt_get_attribute and numfmt_set_attribute.
Number format text attribute used by numfmt_get_text_attribute and numfmt_set_text_attribute.
Number format symbols used by numfmt_get_symbol and numfmt_set_symbol.
Rounding mode values used by numfmt_get_attribute
and numfmt_set_attribute with
Pad position values used by numfmt_get_attribute
and numfmt_set_attribute with
The Locale classIntroductionA "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:
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. Class synopsis
Locale
class Locale
{
/* Methods */
public
static
string
acceptFromHttp
( string
$header
)
public static string canonicalize
( string
$locale
)
public
static
string
composeLocale
( array
$subtags
)
public
static
bool
filterMatches
( string
$langtag
, string $locale
[, bool $canonicalize = false
] )
public
static
array
getAllVariants
( string
$locale
)
public
static
string
getDefault
( void
)
public
static
string
getDisplayLanguage
( string
$locale
[, string $in_locale
] )
public
static
string
getDisplayName
( string
$locale
[, string $in_locale
] )
public
static
string
getDisplayRegion
( string
$locale
[, string $in_locale
] )
public
static
string
getDisplayScript
( string
$locale
[, string $in_locale
] )
public
static
string
getDisplayVariant
( string
$locale
[, string $in_locale
] )
public
static
array
getKeywords
( string
$locale
)
public
static
string
getPrimaryLanguage
( string
$locale
)
public
static
string
getRegion
( string
$locale
)
public
static
string
getScript
( string
$locale
)
public
static
string
lookup
( array
$langtag
, string $locale
[, bool $canonicalize = false
[, string $default
]] )
public
static
array
parseLocale
( string
$locale
)
public
static
bool
setDefault
( string
}$locale
)Predefined Constants
These constants describe the choice of the locale for getLocalte method of different classes.
These constants define how the Locales are parsed or composed. They should be used as keys in the argument array to locale_compose and are returned from locale_parse as keys of the returned associative array.
The Normalizer classIntroductionNormalization 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:
Class synopsis
Normalizer
class Normalizer
{
/* Methods */
public
static
bool
isNormalized
( string
$input
[, string $form = Normalizer::FORM_C
] )
public
static
string
normalize
( string
}$input
[, string $form = Normalizer::FORM_C
] )Predefined ConstantsThe following constants define the normalization form used by the normalizer:
The MessageFormatter classIntroductionMessageFormatter 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. Class synopsis
MessageFormatter
class MessageFormatter
{
/* Methods */
public
__construct
( string
$locale
, string $pattern
)
public
static
MessageFormatter
create
( string
$locale
, string $pattern
)
public
static
string
formatMessage
( string
$locale
, string $pattern
, array $args
)
public
string
format
( array
$args
)
public
int
getErrorCode
( void
)
public
string
getErrorMessage
( void
)
public
string
getLocale
( void
)
public
string
getPattern
( void
)
public
static
array
parseMessage
( string
$locale
, string $pattern
, string $source
)
public
array
parse
( string
$value
)
public
bool
setPattern
( string
}$pattern
)The IntlCalendar classIntroduction
Class synopsisIntlCalendar
class IntlCalendar
{
/* Constants */
const
integer
IntlCalendar::FIELD_ERA
= 0
;
const
integer
IntlCalendar::FIELD_YEAR
= 1
;
const
integer
IntlCalendar::FIELD_MONTH
= 2
;
const
integer
IntlCalendar::FIELD_WEEK_OF_YEAR
= 3
;
const
integer
IntlCalendar::FIELD_WEEK_OF_MONTH
= 4
;
const
integer
IntlCalendar::FIELD_DATE
= 5
;
const
integer
IntlCalendar::FIELD_DAY_OF_YEAR
= 6
;
const
integer
IntlCalendar::FIELD_DAY_OF_WEEK
= 7
;
const
integer
IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH
= 8
;
const
integer
IntlCalendar::FIELD_AM_PM
= 9
;
const
integer
IntlCalendar::FIELD_HOUR
= 10
;
const
integer
IntlCalendar::FIELD_HOUR_OF_DAY
= 11
;
const
integer
IntlCalendar::FIELD_MINUTE
= 12
;
const
integer
IntlCalendar::FIELD_SECOND
= 13
;
const
integer
IntlCalendar::FIELD_MILLISECOND
= 14
;
const
integer
IntlCalendar::FIELD_ZONE_OFFSET
= 15
;
const
integer
IntlCalendar::FIELD_DST_OFFSET
= 16
;
const
integer
IntlCalendar::FIELD_YEAR_WOY
= 17
;
const
integer
IntlCalendar::FIELD_DOW_LOCAL
= 18
;
const
integer
IntlCalendar::FIELD_EXTENDED_YEAR
= 19
;
const
integer
IntlCalendar::FIELD_JULIAN_DAY
= 20
;
const
integer
IntlCalendar::FIELD_MILLISECONDS_IN_DAY
= 21
;
const
integer
IntlCalendar::FIELD_IS_LEAP_MONTH
= 22
;
const
integer
IntlCalendar::FIELD_FIELD_COUNT
= 23
;
const
integer
IntlCalendar::FIELD_DAY_OF_MONTH
= 5
;
const
integer
IntlCalendar::DOW_SUNDAY
= 1
;
const
integer
IntlCalendar::DOW_MONDAY
= 2
;
const
integer
IntlCalendar::DOW_TUESDAY
= 3
;
const
integer
IntlCalendar::DOW_WEDNESDAY
= 4
;
const
integer
IntlCalendar::DOW_THURSDAY
= 5
;
const
integer
IntlCalendar::DOW_FRIDAY
= 6
;
const
integer
IntlCalendar::DOW_SATURDAY
= 7
;
const
integer
IntlCalendar::DOW_TYPE_WEEKDAY
= 0
;
const
integer
IntlCalendar::DOW_TYPE_WEEKEND
= 1
;
const
integer
IntlCalendar::DOW_TYPE_WEEKEND_OFFSET
= 2
;
const
integer
IntlCalendar::DOW_TYPE_WEEKEND_CEASE
= 3
;
const
integer
IntlCalendar::WALLTIME_FIRST
= 1
;
const
integer
IntlCalendar::WALLTIME_LAST
= 0
;
const
integer
IntlCalendar::WALLTIME_NEXT_VALID
= 2
;
/* Methods */
public bool add
( int
$field
, int $amount
)
bool intlcal_add
( IntlCalendar
$cal
, int $field
, int $amount
)
public bool after
( IntlCalendar
$other
)
bool intlcal_after
( IntlCalendar
$cal
, IntlCalendar $other
)
public bool before
( IntlCalendar
$other
)
bool intlcal_before
( IntlCalendar
$cal
, IntlCalendar $other
)
public bool clear
([ int
$field = NULL
] )
bool intlcal_clear
( IntlCalendar
$cal
[, int $field = NULL
] )
private __construct
( void
)
public static IntlCalendar createInstance
([ mixed
$timeZone = NULL
[, string $locale = ""
]] )
IntlCalendar intlcal_create_instance
([ mixed
$timeZone = NULL
[, string $locale = ""
]] )
public bool equals
( IntlCalendar
$other
)
bool intlcal_equals
( IntlCalendar
$cal
, IntlCalendar $other
)
public int fieldDifference
( float
$when
, int $field
)
int intlcal_field_difference
( IntlCalendar
$cal
, float $when
, int $field
)
public static IntlCalendar fromDateTime
( mixed
$dateTime
)
IntlCalendar intlcal_from_date_time
( mixed
$dateTime
)
public int get
( int
$field
)
int intlcal_get
( IntlCalendar>
$cal
, int $field
)
public int getActualMaximum
( int
$field
)
int intlcal_get_actual_maximum
( IntlCalendar
$cal
, int $field
)
public int getActualMinimum
( int
$field
)
int intlcal_get_actual_minimum
( IntlCalendar
$cal
, int $field
)
public static array getAvailableLocales
( void
)
array intlcal_get_available_locales
( void
)
public int getDayOfWeekType
( int
$dayOfWeek
)
int intlcal_get_day_of_week_type
( IntlCalendar
$cal
, int $dayOfWeek
)
public int getErrorCode
( void
)
public string getErrorMessage
( void
)
public int getFirstDayOfWeek
( void
)
int intlcal_get_first_day_of_week
( IntlCalendar
$cal
)
public int getGreatestMinimum
( int
$field
)
int intlcal_get_greatest_minimum
( IntlCalendar
$cal
, int $field
)
public static Iterator getKeywordValuesForLocale
( string
$key
, string $locale
, boolean $commonlyUsed
)
Iterator intlcal_get_keyword_values_for_locale
( string
$key
, string $locale
, boolean $commonlyUsed
)
public int getLeastMaximum
( int
$field
)
int intlcal_get_least_maximum
( IntlCalendar
$cal
, int $field
)
public string getLocale
( int
$localeType
)
string intlcal_get_locale
( IntlCalendar
$cal
, int $localeType
)
public int getMaximum
( int
$field
)
int intlcal_get_maximum
( IntlCalendar
$cal
, int $field
)
public int getMinimalDaysInFirstWeek
( void
)
int intlcal_get_minimal_days_in_first_week
( IntlCalendar
$cal
)
public int getMinimum
( int
$field
)
int intlcal_get_minimum
( IntlCalendar
$cal
, int $field
)
public static float getNow
( void
)
float intlcal_get_now
( void
)
public int getRepeatedWallTimeOption
( void
)
int intlcal_get_repeated_wall_time_option
( IntlCalendar
$cal
)
public int getSkippedWallTimeOption
( void
)
int intlcal_get_skipped_wall_time_option
( IntlCalendar
$cal
)
public float getTime
( void
)
float intlcal_get_time
( IntlCalendar
$cal
)
public IntlTimeZone getTimeZone
( void
)
IntlTimeZone intlcal_get_time_zone
( IntlCalendar
$cal
)
public string getType
( void
)
string intlcal_get_type
( IntlCalendar
$cal
)
public int getWeekendTransition
( string
$dayOfWeek
)
int intlcal_get_weekend_transition
( IntlCalendar
$cal
, string $dayOfWeek
)
public bool inDaylightTime
( void
)
bool intlcal_in_daylight_time
( IntlCalendar
$cal
)
public bool isEquivalentTo
( IntlCalendar
$other
)
bool intlcal_is_equivalent_to
( IntlCalendar
$cal
, IntlCalendar $other
)
public bool isLenient
( void
)
bool intlcal_is_lenient
( IntlCalendar
$cal
)
public bool isSet
( int
$field
)
bool intlcal_is_set
( IntlCalendar
$cal
, int $field
)
public bool isWeekend
([ float
$date = NULL
] )
bool intlcal_is_weekend
( IntlCalendar
$cal
[, float $date = NULL
] )
public bool roll
( int
$field
, mixed $amountOrUpOrDown
)
bool intlcal_roll
( IntlCalendar
$cal
, int $field
, mixed $amountOrUpOrDown
)
public bool set
( int
$field
, int $value
)
public bool set
( int
$year
, int $month
[, int $dayOfMonth = NULL
[, int $hour = NULL
[, int $minute = NULL
[, int $second = NULL
]]]] )
bool intlcal_set
( IntlCalendar
$cal
, int $field
, int $value
)
bool intlcal_set
( IntlCalendar
$cal
, int $year
, int $month
[, int $dayOfMonth = NULL
[, int $hour = NULL
[, int $minute = NULL
[, int $second = NULL
]]]] )
public bool setFirstDayOfWeek
( int
$dayOfWeek
)
bool intlcal_set_first_day_of_week
( IntlCalendar
$cal
, int $dayOfWeek
)
public ReturnType setLenient
( string
$isLenient
)
ReturnType intlcal_set_lenient
( IntlCalendar
$cal
, string $isLenient
)
public bool setMinimalDaysInFirstWeek
( int
$minimalDays
)
bool intlcal_get_minimal_days_in_first_week
( IntlCalendar
$cal
, int $minimalDays
)
public bool setRepeatedWallTimeOption
( int
$wallTimeOption
)
bool intlcal_set_repeated_wall_time_option
( IntlCalendar
$cal
, int $wallTimeOption
)
public bool setSkippedWallTimeOption
( int
$wallTimeOption
)
bool intlcal_set_skipped_wall_time_option
( IntlCalendar
$cal
, int $wallTimeOption
)
public bool setTime
( float
$date
)
bool intlcal_set_time
( IntlCalendar
$cal
, float $date
)
public bool setTimeZone
( mixed
$timeZone
)
bool intlcal_set_time_zone
( IntlCalendar
$cal
, mixed $timeZone
)
public DateTime toDateTime
( void
)
DateTime intlcal_to_date_time
( IntlCalendar
}$cal
)Predefined Constants
The IntlTimeZone classIntroduction
Class synopsisIntlTimeZone
class IntlTimeZone
{
/* Constants */
const
integer
IntlTimeZone::DISPLAY_SHORT
= 1
;
const
integer
IntlTimeZone::DISPLAY_LONG
= 2
;
/* Methods */
public static integer countEquivalentIDs
( string
$zoneId
)
public static IntlTimeZone createDefault
( void
)
public static IntlIterator createEnumeration
([ mixed
$countryOrRawOffset
] )
public static IntlTimeZone createTimeZone
( string
$zoneId
)
public static IntlTimeZone fromDateTimeZone
( DateTimeZone
$zoneId
)
public static string getCanonicalID
( string
$zoneId
[, bool &$isSystemID
] )
public string getDisplayName
([ bool
$isDaylight
[, integer $style
[, string $locale
]]] )
public integer getDSTSavings
( void
)
public static string getEquivalentID
( string
$zoneId
, integer $index
)
public integer getErrorCode
( void
)
public string getErrorMessage
( void
)
public static IntlTimeZone getGMT
( void
)
public string getID
( void
)
public integer getOffset
( float
$date
, bool $local
, integer &$rawOffset
, integer &$dstOffset
)
public integer getRawOffset
( void
)
public static string getTZDataVersion
( void
)
public bool hasSameRules
( IntlTimeZone
$otherTimeZone
)
public DateTimeZone toDateTimeZone
( void
)
public bool useDaylightTime
( void
)
}Predefined Constants
The IntlDateFormatter classIntroductionDate Formatter is a concrete class that enables locale-dependent formatting/parsing of dates using pattern strings and/or canned patterns. This class represents the ICU date formatting functionality. It allows users to display dates in a localized format or to parse strings into PHP date values using pattern strings and/or canned patterns. Class synopsis
IntlDateFormatter
class IntlDateFormatter
{
/* Methods */
public
__construct
( string
$locale
, int $datetype
, int $timetype
[, mixed $timezone = NULL
[, mixed $calendar = NULL
[, string $pattern = ''
]]] )
public
static
IntlDateFormatter create
( string
$locale
, int $datetype
, int $timetype
[, mixed $timezone = NULL
[, mixed $calendar = NULL
[, string $pattern = ''
]]] )
public string format
( mixed
$value
)
public static string formatObject
( object
$object
[, mixed $format = NULL
[, string $locale = NULL
]] )
int getCalendar
( void
)
public int getDateType
( void
)
public int getErrorCode
( void
)
public string getErrorMessage
( void
)
public string getLocale
([ int
$which
] )
public string getPattern
( void
)
public int getTimeType
( void
)
public string getTimeZoneId
( void
)
public
IntlCalendar
getCalendarObject
( void
)
public IntlTimeZone getTimeZone
( void
)
public bool isLenient
( void
)
public array localtime
( string
$value
[, int &$position
] )
public int parse
( string
$value
[, int &$position
] )
bool setCalendar
( mixed
$which
)
public bool setLenient
( bool
$lenient
)
public bool setPattern
( string
$pattern
)
public bool setTimeZoneId
( string
$zone
)
public
boolean
setTimeZone
( mixed
}$zone
)Predefined ConstantsThese constants are used to specify different formats in the constructor for DateType and TimeType.
The following int constants are used to specify the calendar. These calendars are all based directly on the Gregorian calendar. Non-Gregorian calendars need to be specified in locale. Examples might include locale="hi@calendar=BUDDHIST".
The ResourceBundle classIntroductionLocalized software products often require sets of data that are to be customized depending on current locale, e.g.: messages, labels, formatting patterns. ICU resource mechanism allows to define sets of resources that the application can load on locale basis, while accessing them in unified locale-independent fashion. This class implements access to ICU resource data files. These files are binary data arrays which ICU uses to store the localized data. ICU resource bundle can hold simple resources and complex resources. Complex resources are containers which can be either integer-indexed or string-indexed (just like PHP arrays). Simple resources can be of the following typos: string, integer, binary data field or integer array. ResourceBundle supports direct access to the data through array access pattern and iteration via foreach, as well as access via class methods. The result will be PHP value for simple resources and ResourceBundle object for complex ones. All resources are read-only. Class synopsis
ResourceBundle
class ResourceBundle
{
/* Methods */
public
__construct
( string
$locale
, string $bundlename
[, bool $fallback
] )
public
int
count
( void
)
public
static
ResourceBundle
create
( string
$locale
, string $bundlename
[, bool $fallback
] )
public
int
getErrorCode
( void
)
public
string
getErrorMessage
( void
)
public
mixed
get
( string|int
$index
)
public
array
getLocales
( string
}$bundlename
)The Spoofchecker classIntroduction
Class synopsisSpoofchecker
class Spoofchecker
{
/* Constants */
const
integer
Spoofchecker::SINGLE_SCRIPT_CONFUSABLE
= 1
;
const
integer
Spoofchecker::MIXED_SCRIPT_CONFUSABLE
= 2
;
const
integer
Spoofchecker::WHOLE_SCRIPT_CONFUSABLE
= 4
;
const
integer
Spoofchecker::ANY_CASE
= 8
;
const
integer
Spoofchecker::SINGLE_SCRIPT
= 16
;
const
integer
Spoofchecker::INVISIBLE
= 32
;
const
integer
Spoofchecker::CHAR_LIMIT
= 64
;
/* Methods */
public bool areConfusable
( string
$s1
, string $s2
[, string &$error
] )
public __construct
( void
)
public bool isSuspicious
( string
$text
[, string &$error
] )
public void setAllowedLocales
( string
$locale_list
)
public void setChecks
( string
}$checks
)Predefined Constants
The Transliterator classIntroductionTransliterator provides transliteration of strings. Class synopsis
Transliterator
class Transliterator
{
/* Constants */
const
integer
Transliterator::FORWARD
= 0
;
const
integer
Transliterator::REVERSE
= 1
;
/* Properties */
public
$id
;
/* Methods */
__construct
( void
)
public static Transliterator create
( string
$id
[, int $direction
] )
public static Transliterator createFromRules
( string
$rules
[, string $direction
] )
public Transliterator createInverse
( void
)
public int getErrorCode
( void
)
public string getErrorMessage
( void
)
public static array listIDs
( void
)
public string transliterate
( string
}$subject
[, int $start
[, int $end
]] )Properties
Predefined Constants
The IntlBreakIterator classIntroductionA “break iterator” is an ICU object that exposes methods for locating boundaries in text (e.g. word or sentence boundaries). The PHP IntlBreakIterator serves as the the base class for all types of ICU break iterators. Where extra functionality is available, the intl extension may expose the ICU break iterator with suitable subclasses, such as IntlRuleBasedBreakIterator or IntlCodePointBreaIterator. This class implements Traversable. Traversing an IntlBreakIterator yields non-negative integer values representing the successive locations of the text boundaries, expressed as UTF-8 code units (byte) counts, taken from the beggining of the text (which has the location 0). The keys yielded by the iterator simply form the sequence of natural numbers {0, 1, 2, …}. Class synopsisIntlBreakIterator
class IntlBreakIterator
implements
Traversable
{
/* Constants */
const
integer
IntlBreakIterator::DONE
= -1
;
const
integer
IntlBreakIterator::WORD_NONE
= 0
;
const
integer
IntlBreakIterator::WORD_NONE_LIMIT
= 100
;
const
integer
IntlBreakIterator::WORD_NUMBER
= 100
;
const
integer
IntlBreakIterator::WORD_NUMBER_LIMIT
= 200
;
const
integer
IntlBreakIterator::WORD_LETTER
= 200
;
const
integer
IntlBreakIterator::WORD_LETTER_LIMIT
= 300
;
const
integer
IntlBreakIterator::WORD_KANA
= 300
;
const
integer
IntlBreakIterator::WORD_KANA_LIMIT
= 400
;
const
integer
IntlBreakIterator::WORD_IDEO
= 400
;
const
integer
IntlBreakIterator::WORD_IDEO_LIMIT
= 500
;
const
integer
IntlBreakIterator::LINE_SOFT
= 0
;
const
integer
IntlBreakIterator::LINE_SOFT_LIMIT
= 100
;
const
integer
IntlBreakIterator::LINE_HARD
= 100
;
const
integer
IntlBreakIterator::LINE_HARD_LIMIT
= 200
;
const
integer
IntlBreakIterator::SENTENCE_TERM
= 0
;
const
integer
IntlBreakIterator::SENTENCE_TERM_LIMIT
= 100
;
const
integer
IntlBreakIterator::SENTENCE_SEP
= 100
;
const
integer
IntlBreakIterator::SENTENCE_SEP_LIMIT
= 200
;
/* Methods */
private __construct
( void
)
public static ReturnType createCharacterInstance
([ string
$"locale"
] )
public static ReturnType createCodePointInstance
( void
)
public static ReturnType createLineInstance
([ string
$"locale"
] )
public static ReturnType createSentenceInstance
([ string
$"locale"
] )
public static ReturnType createTitleInstance
([ string
$"locale"
] )
public static ReturnType createWordInstance
([ string
$"locale"
] )
public ReturnType current
( void
)
public ReturnType first
( void
)
public ReturnType following
( string
$"offset"
)
public ReturnType getErrorCode
( void
)
ReturnType intl_get_error_code
( void
)
public ReturnType getErrorMessage
( void
)
ReturnType intl_get_error_message
( void
)
public ReturnType getLocale
( string
$"locale_type"
)
public ReturnType getPartsIterator
([ string
$"key_type"
] )
public ReturnType getText
( void
)
public ReturnType isBoundary
( string
$"offset"
)
public ReturnType last
( void
)
public ReturnType next
([ string
$"offset"
] )
public ReturnType preceding
( string
$"offset"
)
public ReturnType previous
( void
)
public ReturnType setText
( string
}$"text"
)Predefined Constants
The IntlRuleBasedBreakIterator classIntroductionA subclass of IntlBreakIterator that encapsulates ICU break iterators whose behavior is specified using a set of rules. This is the most common kind of break iterators. These rules are described in the » ICU Boundary Analysis User Guide. Class synopsisIntlRuleBasedBreakIterator
class IntlRuleBasedBreakIterator
extends
IntlBreakIterator
implements
Traversable
{
/* Constants */
const
integer
IntlRuleBasedBreakIterator::DONE
= -1
;
const
integer
IntlRuleBasedBreakIterator::WORD_NONE
= 0
;
const
integer
IntlRuleBasedBreakIterator::WORD_NONE_LIMIT
= 100
;
const
integer
IntlRuleBasedBreakIterator::WORD_NUMBER
= 100
;
const
integer
IntlRuleBasedBreakIterator::WORD_NUMBER_LIMIT
= 200
;
const
integer
IntlRuleBasedBreakIterator::WORD_LETTER
= 200
;
const
integer
IntlRuleBasedBreakIterator::WORD_LETTER_LIMIT
= 300
;
const
integer
IntlRuleBasedBreakIterator::WORD_KANA
= 300
;
const
integer
IntlRuleBasedBreakIterator::WORD_KANA_LIMIT
= 400
;
const
integer
IntlRuleBasedBreakIterator::WORD_IDEO
= 400
;
const
integer
IntlRuleBasedBreakIterator::WORD_IDEO_LIMIT
= 500
;
const
integer
IntlRuleBasedBreakIterator::LINE_SOFT
= 0
;
const
integer
IntlRuleBasedBreakIterator::LINE_SOFT_LIMIT
= 100
;
const
integer
IntlRuleBasedBreakIterator::LINE_HARD
= 100
;
const
integer
IntlRuleBasedBreakIterator::LINE_HARD_LIMIT
= 200
;
const
integer
IntlRuleBasedBreakIterator::SENTENCE_TERM
= 0
;
const
integer
IntlRuleBasedBreakIterator::SENTENCE_TERM_LIMIT
= 100
;
const
integer
IntlRuleBasedBreakIterator::SENTENCE_SEP
= 100
;
const
integer
IntlRuleBasedBreakIterator::SENTENCE_SEP_LIMIT
= 200
;
/* Methods */
public __construct
( string
$rules
[, string $areCompiled
] )
public ReturnType getBinaryRules
( void
)
public ReturnType getRules
( void
)
public ReturnType getRuleStatus
( void
)
public ReturnType getRuleStatusVec
( void
)
/* Inherited methods */
private IntlBreakIterator::__construct
( void
)
public static ReturnType IntlBreakIterator::createCharacterInstance
([ string
$"locale"
] )
public static ReturnType IntlBreakIterator::createCodePointInstance
( void
)
public static ReturnType IntlBreakIterator::createLineInstance
([ string
$"locale"
] )
public static ReturnType IntlBreakIterator::createSentenceInstance
([ string
$"locale"
] )
public static ReturnType IntlBreakIterator::createTitleInstance
([ string
$"locale"
] )
public static ReturnType IntlBreakIterator::createWordInstance
([ string
$"locale"
] )
public ReturnType IntlBreakIterator::current
( void
)
public ReturnType IntlBreakIterator::first
( void
)
public ReturnType IntlBreakIterator::following
( string
$"offset"
)
public ReturnType IntlBreakIterator::getErrorCode
( void
)
ReturnType intl_get_error_code
( void
)
public ReturnType IntlBreakIterator::getErrorMessage
( void
)
ReturnType intl_get_error_message
( void
)
public ReturnType IntlBreakIterator::getLocale
( string
$"locale_type"
)
public ReturnType IntlBreakIterator::getPartsIterator
([ string
$"key_type"
] )
public ReturnType IntlBreakIterator::getText
( void
)
public ReturnType IntlBreakIterator::isBoundary
( string
$"offset"
)
public ReturnType IntlBreakIterator::last
( void
)
public ReturnType IntlBreakIterator::next
([ string
$"offset"
] )
public ReturnType IntlBreakIterator::preceding
( string
$"offset"
)
public ReturnType IntlBreakIterator::previous
( void
)
public ReturnType IntlBreakIterator::setText
( string
}$"text"
)Predefined Constants
The IntlCodePointBreakIterator classIntroductionThis break iterator identifies the boundaries between UTF-8 code points. Class synopsisIntlCodePointBreakIterator
class IntlCodePointBreakIterator
extends
IntlBreakIterator
implements
Traversable
{
/* Constants */
const
integer
IntlCodePointBreakIterator::DONE
= -1
;
const
integer
IntlCodePointBreakIterator::WORD_NONE
= 0
;
const
integer
IntlCodePointBreakIterator::WORD_NONE_LIMIT
= 100
;
const
integer
IntlCodePointBreakIterator::WORD_NUMBER
= 100
;
const
integer
IntlCodePointBreakIterator::WORD_NUMBER_LIMIT
= 200
;
const
integer
IntlCodePointBreakIterator::WORD_LETTER
= 200
;
const
integer
IntlCodePointBreakIterator::WORD_LETTER_LIMIT
= 300
;
const
integer
IntlCodePointBreakIterator::WORD_KANA
= 300
;
const
integer
IntlCodePointBreakIterator::WORD_KANA_LIMIT
= 400
;
const
integer
IntlCodePointBreakIterator::WORD_IDEO
= 400
;
const
integer
IntlCodePointBreakIterator::WORD_IDEO_LIMIT
= 500
;
const
integer
IntlCodePointBreakIterator::LINE_SOFT
= 0
;
const
integer
IntlCodePointBreakIterator::LINE_SOFT_LIMIT
= 100
;
const
integer
IntlCodePointBreakIterator::LINE_HARD
= 100
;
const
integer
IntlCodePointBreakIterator::LINE_HARD_LIMIT
= 200
;
const
integer
IntlCodePointBreakIterator::SENTENCE_TERM
= 0
;
const
integer
IntlCodePointBreakIterator::SENTENCE_TERM_LIMIT
= 100
;
const
integer
IntlCodePointBreakIterator::SENTENCE_SEP
= 100
;
const
integer
IntlCodePointBreakIterator::SENTENCE_SEP_LIMIT
= 200
;
/* Methods */
public ReturnType getLastCodePoint
( void
)
/* Inherited methods */
private IntlBreakIterator::__construct
( void
)
public static ReturnType IntlBreakIterator::createCharacterInstance
([ string
$"locale"
] )
public static ReturnType IntlBreakIterator::createCodePointInstance
( void
)
public static ReturnType IntlBreakIterator::createLineInstance
([ string
$"locale"
] )
public static ReturnType IntlBreakIterator::createSentenceInstance
([ string
$"locale"
] )
public static ReturnType IntlBreakIterator::createTitleInstance
([ string
$"locale"
] )
public static ReturnType IntlBreakIterator::createWordInstance
([ string
$"locale"
] )
public ReturnType IntlBreakIterator::current
( void
)
public ReturnType IntlBreakIterator::first
( void
)
public ReturnType IntlBreakIterator::following
( string
$"offset"
)
public ReturnType IntlBreakIterator::getErrorCode
( void
)
ReturnType intl_get_error_code
( void
)
public ReturnType IntlBreakIterator::getErrorMessage
( void
)
ReturnType intl_get_error_message
( void
)
public ReturnType IntlBreakIterator::getLocale
( string
$"locale_type"
)
public ReturnType IntlBreakIterator::getPartsIterator
([ string
$"key_type"
] )
public ReturnType IntlBreakIterator::getText
( void
)
public ReturnType IntlBreakIterator::isBoundary
( string
$"offset"
)
public ReturnType IntlBreakIterator::last
( void
)
public ReturnType IntlBreakIterator::next
([ string
$"offset"
] )
public ReturnType IntlBreakIterator::preceding
( string
$"offset"
)
public ReturnType IntlBreakIterator::previous
( void
)
public ReturnType IntlBreakIterator::setText
( string
}$"text"
)Predefined Constants
The IntlPartsIterator classIntroductionObjects of this class can be obtained from IntlBreakIterator objects. While the break iterators provide a sequence of boundary positions when iterated, IntlPartsIterator objects provide, as a convenience, the text fragments comprehended between two successive boundaries. The keys may represent the offset of the left boundary, right boundary, or they may just the sequence of non-negative integers. See IntlBreakIterator::getPartsIterator. Class synopsisIntlPartsIterator
class IntlPartsIterator
extends
IntlIterator
implements
Iterator
{
/* Constants */
const
integer
IntlPartsIterator::KEY_SEQUENTIAL
= 0
;
const
integer
IntlPartsIterator::KEY_LEFT
= 1
;
const
integer
IntlPartsIterator::KEY_RIGHT
= 2
;
/* Methods */
public ReturnType getBreakIterator
( void
)
/* Inherited methods */
public ReturnType IntlIterator::current
( void
)
public ReturnType IntlIterator::key
( void
)
public ReturnType IntlIterator::next
( void
)
public ReturnType IntlIterator::rewind
( void
)
public ReturnType IntlIterator::valid
( void
)
}Predefined Constants
The UConverter classIntroduction
Class synopsisUConverter
class UConverter
{
/* Constants */
const
integer
UConverter::REASON_UNASSIGNED
= 0
;
const
integer
UConverter::REASON_ILLEGAL
= 1
;
const
integer
UConverter::REASON_IRREGULAR
= 2
;
const
integer
UConverter::REASON_RESET
= 3
;
const
integer
UConverter::REASON_CLOSE
= 4
;
const
integer
UConverter::REASON_CLONE
= 5
;
const
integer
UConverter::UNSUPPORTED_CONVERTER
= -1
;
const
integer
UConverter::SBCS
= 0
;
const
integer
UConverter::DBCS
= 1
;
const
integer
UConverter::MBCS
= 2
;
const
integer
UConverter::LATIN_1
= 3
;
const
integer
UConverter::UTF8
= 4
;
const
integer
UConverter::UTF16_BigEndian
= 5
;
const
integer
UConverter::UTF16_LittleEndian
= 6
;
const
integer
UConverter::UTF32_BigEndian
= 7
;
const
integer
UConverter::UTF32_LittleEndian
= 8
;
const
integer
UConverter::EBCDIC_STATEFUL
= 9
;
const
integer
UConverter::ISO_2022
= 10
;
const
integer
UConverter::LMBCS_1
= 11
;
const
integer
UConverter::LMBCS_2
= 12
;
const
integer
UConverter::LMBCS_3
= 13
;
const
integer
UConverter::LMBCS_4
= 14
;
const
integer
UConverter::LMBCS_5
= 15
;
const
integer
UConverter::LMBCS_6
= 16
;
const
integer
UConverter::LMBCS_8
= 17
;
const
integer
UConverter::LMBCS_11
= 18
;
const
integer
UConverter::LMBCS_16
= 19
;
const
integer
UConverter::LMBCS_17
= 20
;
const
integer
UConverter::LMBCS_18
= 21
;
const
integer
UConverter::LMBCS_19
= 22
;
const
integer
UConverter::LMBCS_LAST
= 22
;
const
integer
UConverter::HZ
= 23
;
const
integer
UConverter::SCSU
= 24
;
const
integer
UConverter::ISCII
= 25
;
const
integer
UConverter::US_ASCII
= 26
;
const
integer
UConverter::UTF7
= 27
;
const
integer
UConverter::BOCU1
= 28
;
const
integer
UConverter::UTF16
= 29
;
const
integer
UConverter::UTF32
= 30
;
const
integer
UConverter::CESU8
= 31
;
const
integer
UConverter::IMAP_MAILBOX
= 32
;
/* Methods */
public __construct
([ string
$destination_encoding
[, string $source_encoding
]] )
public string convert
( string
$str
[, bool $reverse
] )
public mixed fromUCallback
( integer
$reason
, string $source
, string $codePoint
, integer &$error
)
public static array getAliases
([ string
$name
] )
public static array getAvailable
( void
)
public string getDestinationEncoding
( void
)
public integer getDestinationType
( void
)
public integer getErrorCode
( void
)
public string getErrorMessage
( void
)
public string getSourceEncoding
( void
)
public integer getSourceType
( void
)
public static array getStandards
( void
)
public string getSubstChars
( void
)
public static string reasonText
([ integer
$reason
] )
public void setDestinationEncoding
( string
$encoding
)
public void setSourceEncoding
( string
$encoding
)
public void setSubstChars
( string
$chars
)
public mixed toUCallback
( integer
$reason
, string $source
, string $codeUnits
, integer &$error
)
public static string transcode
( string
}$str
, string $toEncoding
, string $fromEncoding
[, array $options
] )Predefined Constants
Exception class for intl errorsIntroductionThis class is used for generating exceptions when errors occur inside intl functions. Such exceptions are only generated when intl.use_exceptions is enabled. Class synopsisIntlException
class IntlException
extends
Exception
{
/* Inherited properties */
protected
string
$message
;
protected
int
$code
;
protected
string
$file
;
protected
int
$line
;
/* Inherited methods */
final public string Exception::getMessage
( void
)
final public Exception Exception::getPrevious
( void
)
final public mixed Exception::getCode
( void
)
final public string Exception::getFile
( void
)
final public int Exception::getLine
( void
)
final public array Exception::getTrace
( void
)
final public string Exception::getTraceAsString
( void
)
public string Exception::__toString
( void
)
final private void Exception::__clone
( void
)
}The IntlIterator classIntroductionThis class represents iterator objects throughout the intl extension whenever the iterator cannot be identified with any other object provided by the extension. The distinct iterator object used internally by the foreach construct can only be obtained (in the relevant part here) from objects, so objects of this class serve the purpose of providing the hook through which this internal object can be obtained. As a convenience, this class also implements the Iterator interface, allowing the collection of values to be navigated using the methods defined in that interface. Both these methods and the internal iterator objects provided to foreach are backed by the same state (e.g. the position of the iterator and its current value). Subclasses may provide richer functionality. Class synopsisIntlIterator
class IntlIterator
implements
Iterator
{
/* Methods */
public ReturnType current
( void
)
public ReturnType key
( void
)
public ReturnType next
( void
)
public ReturnType rewind
( void
)
public ReturnType valid
( void
)
} |