IntlChar::enumCharNames
(PHP 7, PHP 8)
IntlChar::enumCharNames — Enumerate all assigned Unicode characters within a range
Description
int|string
$start,int|string
$end,callable
$callback,int
$type = IntlChar::UNICODE_CHAR_NAME): ?bool
Enumerate all assigned Unicode characters between the start and limit code points (start inclusive, limit exclusive) and call a function for each, passing the code point value and the character name.
For Unicode 1.0 names, only those are enumerated that differ from the modern names.
Parameters
-
start -
The first code point in the enumeration range.
-
end -
One more than the last code point in the enumeration range (the first one after the range).
-
callback -
The function that is to be called for each character name. The following three arguments will be passed into it:
- int
$codepoint- The numeric code point value - int
$nameChoice- The same value as thetypeparameter below - string
$name- The name of the character
- int
-
type -
Selector for which kind of names to enumerate. Can be any of these constants:
IntlChar::UNICODE_CHAR_NAME(default)IntlChar::UNICODE_10_CHAR_NAMEIntlChar::EXTENDED_CHAR_NAMEIntlChar::CHAR_NAME_ALIASIntlChar::CHAR_NAME_CHOICE_COUNT
Return Values
Returns null on success or false on failure.
Examples
Example #1 Enumerating over a sample range of code points
<?php
IntlChar::enumCharNames(0x2600, 0x2610, function($codepoint, $nameChoice, $name) {
printf("U+%04x %s\n", $codepoint, $name);
});
?>
The above example will output:
U+2600 BLACK SUN WITH RAYS U+2601 CLOUD U+2602 UMBRELLA U+2603 SNOWMAN U+2604 COMET U+2605 BLACK STAR U+2606 WHITE STAR U+2607 LIGHTNING U+2608 THUNDERSTORM U+2609 SUN U+260a ASCENDING NODE U+260b DESCENDING NODE U+260c CONJUNCTION U+260d OPPOSITION U+260e BLACK TELEPHONE U+260f WHITE TELEPHONE
See Also
- IntlChar::charName() - Retrieve the name of a Unicode character
- IntlChar::charFromName() - Find Unicode character by name and return its code point value
