array-change-key-case.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.array-change-key-case" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_change_key_case</refname>
  <refpurpose>Changes the case of all keys in an array</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_change_key_case</methodname>
   <methodparam><type>array</type><parameter>array</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>case</parameter><initializer><constant>CASE_LOWER</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Returns an array with all keys from <parameter>array</parameter> lowercased
   or uppercased. Numbered indices are left as is.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>

    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       The array to work on
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>case</parameter></term>
     <listitem>
      <para>
       Either <constant>CASE_UPPER</constant> or
       <constant>CASE_LOWER</constant> (default)
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array with its keys lower or uppercased.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example xml:id="function.array-change-key-case.example-1">
    <title><function>array_change_key_case</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$input_array = array("FirSt" => 1, "SecOnd" => 4);
print_r(array_change_key_case($input_array, CASE_UPPER));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [FIRST] => 1
    [SECOND] => 4
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    If an array has indices that will be the same once run through this
    function (e.g. "<literal>keY</literal>" and "<literal>kEY</literal>"), 
    the value that is later in the array will override other indices.
   </para>
  </note>
 </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
-->