php-doc-en/reference/intl/intlchar/iswhitespace.xml
Christoph Michael Becker f8c567a104 Fix copy&paste error
Patch provided by Andrey Gromov.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@341345 c90b9560-bf6c-de11-be94-00142212c4b1
2016-12-08 15:58:21 +00:00

116 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlchar.iswhitespace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlChar::isWhitespace</refname>
<refpurpose>Check if code point is a whitespace character according to ICU</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>IntlChar::isWhitespace</methodname>
<methodparam><type>mixed</type><parameter>codepoint</parameter></methodparam>
</methodsynopsis>
<para>
Determines if the specified code point is a whitespace character according to ICU.
</para>
<para>
A character is considered to be a ICU whitespace character if and only if it satisfies one of the following criteria:
<simplelist>
<member>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).</member>
<member>It is U+0009 HORIZONTAL TABULATION.</member>
<member>It is U+000A LINE FEED.</member>
<member>It is U+000B VERTICAL TABULATION.</member>
<member>It is U+000C FORM FEED.</member>
<member>It is U+000D CARRIAGE RETURN.</member>
<member>It is U+001C FILE SEPARATOR.</member>
<member>It is U+001D GROUP SEPARATOR.</member>
<member>It is U+001E RECORD SEPARATOR.</member>
<member>It is U+001F UNIT SEPARATOR.</member>
</simplelist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>codepoint</parameter></term>
<listitem>
&intl.codepoint.parameter;
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if
<parameter>codepoint</parameter> is a whitespace character according to ICU, &false; if not.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>&intl.codepoint.example;</title>
<programlisting role="php">
<![CDATA[
<?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}"));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(false)
bool(true)
bool(true)
bool(true)
bool(false)
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>IntlChar::isspace</function></member>
<member><function>IntlChar::isJavaSpaceChar</function></member>
<member><function>IntlChar::isUWhiteSpace</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->