php-doc-en/reference/intl/intlchar/foldcase.xml
Colin O'Dell 911013ce81 Add documentation for the IntlChar class and its methods.
Documentation is based on PHP 7.0.0 RC2.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337779 c90b9560-bf6c-de11-be94-00142212c4b1
2015-09-08 01:07:12 +00:00

72 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlchar.foldcase" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlChar::foldCase</refname>
<refpurpose>Perform case folding on a code point</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>mixed</type><methodname>IntlChar::foldCase</methodname>
<methodparam><type>mixed</type><parameter>codepoint</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer><constant>IntlChar::FOLD_CASE_DEFAULT</constant></initializer></methodparam>
</methodsynopsis>
<para>
The given character is mapped to its case folding equivalent; if the character has no case folding equivalent,
the character itself is returned.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>codepoint</parameter></term>
<listitem>
&intl.codepoint.parameter;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Either <constant>IntlChar::FOLD_CASE_DEFAULT</constant> (default)
or <constant>IntlChar::FOLD_CASE_EXCLUDE_SPECIAL_I</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the <emphasis>Simple_Case_Folding</emphasis> of the code point, if any; otherwise the code point itself.
</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
-->