IntlChar

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

The Unicode property to lookup (see the IntlChar::PROPERTY_* constants).

Returns TRUE or FALSE according to the binary Unicode property value for codepoint. Also FALSE if property is out of bounds or if the Unicode version does not have data for the property at all, or not for this code point. Or NULL if codepoint is out of bounds.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

The Unicode version number, as an array. For example, version 1.3.31.2 would be represented as [1, 3, 31, 2]. Or NULL if codepoint is out of bounds.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

The decimal digit value of codepoint, or -1 if it is not a decimal digit character. Or NULL if codepoint is out of bounds.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

The bidirectional category value; one of the following constants:

• IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT
• IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT
• IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER
• IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_SEPARATOR
• IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_TERMINATOR
• IntlChar::CHAR_DIRECTION_ARABIC_NUMBER
• IntlChar::CHAR_DIRECTION_COMMON_NUMBER_SEPARATOR
• IntlChar::CHAR_DIRECTION_BLOCK_SEPARATOR
• IntlChar::CHAR_DIRECTION_SEGMENT_SEPARATOR
• IntlChar::CHAR_DIRECTION_WHITE_SPACE_NEUTRAL
• IntlChar::CHAR_DIRECTION_OTHER_NEUTRAL
• IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_EMBEDDING
• IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_OVERRIDE
• IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ARABIC
• IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_EMBEDDING
• IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_OVERRIDE
• IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_FORMAT
• IntlChar::CHAR_DIRECTION_DIR_NON_SPACING_MARK
• IntlChar::CHAR_DIRECTION_BOUNDARY_NEUTRAL
• IntlChar::CHAR_DIRECTION_FIRST_STRONG_ISOLATE
• IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_ISOLATE
• IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ISOLATE
• IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_ISOLATE
• IntlChar::CHAR_DIRECTION_CHAR_DIRECTION_COUNT

Or NULL if codepoint is out of bounds.

Full name of the Unicode character.

[optional]

Which set of names to use for the lookup. Can be any of these constants:

• IntlChar::UNICODE_CHAR_NAME (default)
• IntlChar::UNICODE_10_CHAR_NAME
• IntlChar::EXTENDED_CHAR_NAME
• IntlChar::CHAR_NAME_ALIAS
• IntlChar::CHAR_NAME_CHOICE_COUNT

The Unicode value of the code point with the given name (as an integer), or NULL if there is no such code point.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns another Unicode code point that may serve as a mirror-image substitute, or codepoint itself if there is no such mapping or codepoint does not have the Bidi_Mirrored property. The return type will be integer unless the code point was passed as a UTF-8 string, in which case a string will be returned. Or NULL if codepoint will be out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

[optional] Which set of names to use for the lookup. Can be any of these constants:

• IntlChar::UNICODE_CHAR_NAME (default)
• IntlChar::UNICODE_10_CHAR_NAME
• IntlChar::EXTENDED_CHAR_NAME
• IntlChar::CHAR_NAME_ALIAS
• IntlChar::CHAR_NAME_CHOICE_COUNT

The corresponding name, or an empty string if there is no name for this character, or NULL if codepoint is out of bounds.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns the general category type, which may be one of the following constants:

• IntlChar::CHAR_CATEGORY_UNASSIGNED
• IntlChar::CHAR_CATEGORY_GENERAL_OTHER_TYPES
• IntlChar::CHAR_CATEGORY_UPPERCASE_LETTER
• IntlChar::CHAR_CATEGORY_LOWERCASE_LETTER
• IntlChar::CHAR_CATEGORY_TITLECASE_LETTER
• IntlChar::CHAR_CATEGORY_MODIFIER_LETTER
• IntlChar::CHAR_CATEGORY_OTHER_LETTER
• IntlChar::CHAR_CATEGORY_NON_SPACING_MARK
• IntlChar::CHAR_CATEGORY_ENCLOSING_MARK
• IntlChar::CHAR_CATEGORY_COMBINING_SPACING_MARK
• IntlChar::CHAR_CATEGORY_DECIMAL_DIGIT_NUMBER
• IntlChar::CHAR_CATEGORY_LETTER_NUMBER
• IntlChar::CHAR_CATEGORY_OTHER_NUMBER
• IntlChar::CHAR_CATEGORY_SPACE_SEPARATOR
• IntlChar::CHAR_CATEGORY_LINE_SEPARATOR
• IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR
• IntlChar::CHAR_CATEGORY_CONTROL_CHAR
• IntlChar::CHAR_CATEGORY_FORMAT_CHAR
• IntlChar::CHAR_CATEGORY_PRIVATE_USE_CHAR
• IntlChar::CHAR_CATEGORY_SURROGATE
• IntlChar::CHAR_CATEGORY_DASH_PUNCTUATION
• IntlChar::CHAR_CATEGORY_START_PUNCTUATION
• IntlChar::CHAR_CATEGORY_END_PUNCTUATION
• IntlChar::CHAR_CATEGORY_CONNECTOR_PUNCTUATION
• IntlChar::CHAR_CATEGORY_OTHER_PUNCTUATION
• IntlChar::CHAR_CATEGORY_MATH_SYMBOL
• IntlChar::CHAR_CATEGORY_CURRENCY_SYMBOL
• IntlChar::CHAR_CATEGORY_MODIFIER_SYMBOL
• IntlChar::CHAR_CATEGORY_OTHER_SYMBOL
• IntlChar::CHAR_CATEGORY_INITIAL_PUNCTUATION
• IntlChar::CHAR_CATEGORY_FINAL_PUNCTUATION
• IntlChar::CHAR_CATEGORY_CHAR_CATEGORY_COUNT

Or NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

A string containing the single character specified by the Unicode code point value. Or NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

The radix (defaults to 10).

Returns the numeric value represented by the character in the specified radix, or FALSE if there is no value or if the value exceeds the radix, or NULL if codepoint is out of bound.

The first code point in the enumeration range.

One more than the last code point in the enumeration range (the first one after the range).

The function that is to be called for each character name. The following three arguments will be passed into it:

• integer $codepoint - The numeric code point value
• integer $nameChoice - The same value as the nameChoice parameter below
• string $name - The name of the character

[optional]

Selector for which kind of names to enumerate. Can be any of these constants:

• IntlChar::UNICODE_CHAR_NAME (default)
• IntlChar::UNICODE_10_CHAR_NAME
• IntlChar::EXTENDED_CHAR_NAME
• IntlChar::CHAR_NAME_ALIAS
• IntlChar::CHAR_NAME_CHOICE_COUNT

The function that is to be called for each contiguous range of code points with the same general category. The following three arguments will be passed into it:

• integer $start - The starting code point of the range
• integer $end - The ending code point of the range
• integer $name - The category type (one of the IntlChar::CHAR_CATEGORY_* constants)

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

[optional] Either IntlChar::FOLD_CASE_DEFAULT (default) or IntlChar::FOLD_CASE_EXCLUDE_SPECIAL_I.

Returns the Simple_Case_Folding of the code point, if any; otherwise the code point itself. Returns NULL if codepoint is out of bound.

The number to convert to a character.

[optional]

The radix (defaults to 10).

The character representation (as a string) of the specified digit in the specified radix.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns the paired bracket code point, or codepoint itself if there is no such mapping. The return type will be integer unless the code point was passed as a UTF-8 string, in which case a string will be returned. Or NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns the block value for codepoint, or NULL if codepoint is out of bound. See the IntlChar::BLOCKCODE* constants for possible return values.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns the combining class of the character. Or NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns the FC_NFKC_Closure property string for the codepoint, or an empty string if there is none, or NULL if codepoint is out of bound, or FALSE if there was an error.

The Unicode property to lookup (see the IntlChar::PROPERTY_* constants).

The maximum value returned by {IntlChar for a Unicode property. <=0 if the property selector is out of range.

The Unicode property to lookup (see the IntlChar::PROPERTY_* constants).

The minimum value returned by {IntlChar for a Unicode property. 0 if the property selector is out of range.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

The Unicode property to lookup (see the IntlChar::PROPERTY_* constants).

Returns the numeric value that is directly the property value or, for enumerated properties, corresponds to the numeric value of the enumerated constant of the respective property value enumeration type.

Returns 0 or 1 (for FALSE/TRUE) for binary Unicode properties.

Returns a bit-mask for mask properties.

Returns 0 if property is out of bounds or if the Unicode version does not have data for the property at all, or not for this code point.

Returns NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Numeric value of codepoint, or float(-123456789) if none is defined, or NULL if codepoint is out of bound.

The property name to be matched. The name is compared using "loose matching" as described in PropertyAliases.txt.

Returns an IntlChar::PROPERTY_ constant value, or IntlChar::PROPERTY_INVALID_CODE if the given name does not match any property.

The Unicode property to lookup (see the IntlChar::PROPERTY_* constants).

IntlChar::PROPERTY_INVALID_CODE should not be used. Also, if property is out of range, FALSE is returned.

Selector for which name to get. If out of range, FALSE is returned.

All properties have a long name. Most have a short name, but some do not. Unicode allows for additional names; if present these will be returned by adding 1, 2, etc. to IntlChar::LONG_PROPERTY_NAME.

Returns the name, or FALSE if either the property or the nameChoice is out of range.

If a given nameChoice returns FALSE, then all larger values of nameChoice will return FALSE, with one exception: if FALSE is returned for IntlChar::SHORT_PROPERTY_NAME, then IntlChar::LONG_PROPERTY_NAME (and higher) may still return a non-FALSE value.

The Unicode property to lookup (see the IntlChar::PROPERTY_* constants). If out of range, or this method doesn't work with the given value, IntlChar::PROPERTY_INVALID_CODE is returned

The value name to be matched. The name is compared using "loose matching" as described in PropertyValueAliases.txt.

Returns the corresponding value integer, or IntlChar::PROPERTY_INVALID_CODE if the given name does not match any value of the given property, or if the property is invalid.

The Unicode property to lookup (see the IntlChar::PROPERTY_* constants). If out of range, or this method doesn't work with the given value, FALSE is returned.

Selector for a value for the given property. If out of range, FALSE is returned.

In general, valid values range from 0 up to some maximum. There are a couple exceptions:

• IntlChar::PROPERTY_BLOCK values begin at the non-zero value IntlChar::BLOCK_CODE_BASIC_LATIN
• IntlChar::PROPERTY_CANONICAL_COMBINING_CLASS values are not contiguous and range from 0..240.

[optional]

Selector for which name to get. If out of range, FALSE is returned. All values have a long name. Most have a short name, but some do not. Unicode allows for additional names; if present these will be returned by adding 1, 2, etc. to IntlChar::LONG_PROPERTY_NAME.

Returns the name, or FALSE if either the property or the nameChoice is out of range. If a given nameChoice returns FALSE, then all larger values of nameChoice will return FALSE, with one exception: if FALSE is returned for IntlChar::SHORT_PROPERTY_NAME, then IntlChar::LONG_PROPERTY_NAME (and higher) may still return a non-FALSE value.

An array containing the Unicode version number.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is an alphanumeric character, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a letter character, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a base character, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is either a "blank" or "horizontal space" character, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a control character, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a defined character, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a digit character, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a "graphic" character, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is ignorable in identifiers, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is the code point may occur in an identifier, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint may start an identifier, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is an ISO control code, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint may occur in a Java identifier, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint may start a Java identifier, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a space character according to Java, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is an Ll lowercase letter, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint has the Bidi_Mirrored property, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a printable character, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a punctuation character, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a space character, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a titlecase letter, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint has the Alphabetic Unicode property, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint has the Lowercase Unicode property, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is an Lu uppercase letter, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint has the Uppercase Unicode property, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint has the White_Space Unicode property, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a whitespace character according to ICU, FALSE if not, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns TRUE if codepoint is a hexadecimal character, FALSE if not, NULL if codepoint is out of bound.

A Unicode character.

Returns the Unicode code point value as an integer, NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns the Simple_Lowercase_Mapping of the code point, if any; otherwise the code point itself. The return type will be integer unless the code point was passed as a UTF-8 string, in which case a string will be returned. Or NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns the Simple_Titlecase_Mapping of the code point, if any; otherwise the code point itself. The return type will be integer unless the code point was passed as a UTF-8 string, in which case a string will be returned. Or NULL if codepoint is out of bound.

The integer codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")

Returns the Simple_Uppercase_Mapping of the code point, if any; otherwise the code point itself. The return type will be integer unless the code point was passed as a UTF-8 string, in which case a string will be returned. Or NULL if codepoint is out of bound.