mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 04:48:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
134 lines
3.9 KiB
XML
134 lines
3.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.mb-convert-case" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>mb_convert_case</refname>
|
|
<refpurpose>Perform case folding on a string</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>mb_convert_case</methodname>
|
|
<methodparam><type>string</type><parameter>str</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>mode</parameter><initializer>MB_CASE_UPPER</initializer></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Performs case folding on a <type>string</type>, converted in the way specified by
|
|
<parameter>mode</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>str</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <type>string</type> being converted.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>mode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The mode of the conversion. It can be one of
|
|
<constant>MB_CASE_UPPER</constant>,
|
|
<constant>MB_CASE_LOWER</constant>, or
|
|
<constant>MB_CASE_TITLE</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>encoding</parameter></term>
|
|
<listitem>
|
|
&mbstring.encoding.parameter;
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A case folded version of <parameter>string</parameter> converted in the
|
|
way specified by <parameter>mode</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="unicode">
|
|
&reftitle.unicode;
|
|
<para>
|
|
By contrast to the standard case folding functions such as
|
|
<function>strtolower</function> and <function>strtoupper</function>,
|
|
case folding is performed on the basis of the Unicode character
|
|
properties. Thus the behaviour of this function is not affected
|
|
by locale settings and it can convert any characters that have
|
|
'alphabetic' property, such as A-umlaut (Ä).
|
|
</para>
|
|
<para>
|
|
For more information about the Unicode properties, please see <link
|
|
xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>mb_convert_case</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$str = "mary had a Little lamb and she loved it so";
|
|
$str = mb_convert_case($str, MB_CASE_UPPER, "UTF-8");
|
|
echo $str; // Prints MARY HAD A LITTLE LAMB AND SHE LOVED IT SO
|
|
$str = mb_convert_case($str, MB_CASE_TITLE, "UTF-8");
|
|
echo $str; // Prints Mary Had A Little Lamb And She Loved It So
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>mb_strtolower</function></member>
|
|
<member><function>mb_strtoupper</function></member>
|
|
<member><function>strtolower</function></member>
|
|
<member><function>strtoupper</function></member>
|
|
<member><function>ucfirst</function></member>
|
|
<member><function>ucwords</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
|
|
-->
|