mb-ucfirst.xml

<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.mb-ucfirst" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_ucfirst</refname>
  <refpurpose>Make a string's first character uppercase</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_ucfirst</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Performs a multi-byte safe <function>ucfirst</function> operation,
   and returns a string with the first character of
   <parameter>string</parameter> title-cased.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>string</parameter></term>
    <listitem>
     <simpara>
      The input string.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>encoding</parameter></term>
    <listitem>
     <simpara>
      The string encoding.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Returns the resulting string.
  </simpara>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <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 a-umlaut (ä).
   </para>
  </note>
  <para>
   For more information about the Unicode properties, please see <link
   xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>mb_lcfirst</function></member>
   <member><function>mb_convert_case</function></member>
   <member><function>ucfirst</function></member>
  </simplelist>
 </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
 -->