IntlChar::isWhitespace
Check if code point is a whitespace character according to ICU
Description
public static boolnull IntlChar::isWhitespace(intstring $codepoint
)
A character is considered to be a ICU whitespace character if and only if it satisfies one of the following criteria:
- It is a Unicode Separator character (categories "Z" = "Zs" or "Zl" or "Zp"), but is not also a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP).
- It is U+0009 HORIZONTAL TABULATION.
- It is U+000A LINE FEED.
- It is U+000B VERTICAL TABULATION.
- It is U+000C FORM FEED.
- It is U+000D CARRIAGE RETURN.
- It is U+001C FILE SEPARATOR.
- It is U+001D GROUP SEPARATOR.
- It is U+001E RECORD SEPARATOR.
- It is U+001F UNIT SEPARATOR.
Parameters
-
codepoint
-
The int codepoint value (e.g. 0x2603
for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}"
)
Return Values
Returns true
if
codepoint
is a whitespace character according to ICU, false
if not. Returns null
on failure.
Examples
Example #1 Testing different code points
<?php
var_dump(IntlChar::iswhitespace("A"));
var_dump(IntlChar::iswhitespace(" "));
var_dump(IntlChar::iswhitespace("\n"));
var_dump(IntlChar::iswhitespace("\t"));
var_dump(IntlChar::iswhitespace("\u{00A0}"));
?>
The above example will output:
bool(false)
bool(true)
bool(true)
bool(true)
bool(false)
See Also
- IntlChar::isspace
- IntlChar::isJavaSpaceChar
- IntlChar::isUWhiteSpace