php-doc-en/reference/mbstring/functions/mb-convert-case.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
  <refentry id="function.mb-convert-case">
   <refnamediv>
    <refname>mb_convert_case</refname>
    <refpurpose>Perform case folding on a string</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>mb_convert_case</methodname>
      <methodparam><type>string</type><parameter>str</parameter></methodparam>
      <methodparam><type>int</type><parameter>mode</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>mb_convert_case</function> returns case folded version of
     <parameter>string</parameter> converted in the way specified by
     <parameter>mode</parameter>.
    </para>
    <para>
     <parameter>mode</parameter> can be one of MB_CASE_UPPER, MB_CASE_LOWER
     or MB_CASE_TITLE.
    </para>
    <para>
     <parameter>encoding</parameter> specifies the encoding of
     <parameter>str</parameter>; if omitted, the internal character encoding
     value will be used.
    </para>
    <para>
     The return value is str with the appropriate case folding applied.
    </para>
    <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 (&Auml;). 
    </para>
    <para>
     For more information about the Unicode properties, please see <ulink
     url="&url.unicode.reports;">&url.unicode.reports;</ulink>.
    </para>
    <example>
     <title><function>mb_convert_case</function> example</title>
     <programlisting role="php">
<![CDATA[
$str = "mary had a Little lamb and she loved it so";
$str = mb_convert_case($str, MB_CASE_UPPER, "UTF-8");
print $str; # Prints MARY HAD A LITTLE LAMB AND SHE LOVED IT SO
$str = mb_convert_case($str, MB_CASE_TITLE, "UTF-8");
print $str; # Prints Mary Had A Little Lamb And She Loved It So
]]>
     </programlisting>
    </example>
    <para>
     See also <function>mb_strtolower</function>,
     <function>mb_strtoupper</function>, <function>strtolower</function>,
     <function>strtoupper</function>.
    </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:"../../../../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
-->