array-flip.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.array-flip">
 <refnamediv>
  <refname>array_flip</refname>
  <refpurpose>Exchanges all keys with their associated values in an array</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_flip</methodname>
   <methodparam><type>array</type><parameter>array</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>array_flip</function> returns an <type>array</type> in flip
   order, i.e. keys from <parameter>array</parameter> become values and values
   from <parameter>array</parameter> become keys.
  </para>
  <para>
   Note that the values of <parameter>array</parameter> need to be valid
   keys, i.e. they need to be either <type>int</type> or
   <type>string</type>. A warning will be emitted if a value has the wrong
   type, and the key/value pair in question <emphasis>will not be included
   in the result</emphasis>.
  </para>
  <para>
   If a value has several occurrences, the latest key will be
   used as its value, and all others will be lost.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       An array of key/value pairs to be flipped.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the flipped array.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>array_flip</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$input = array("oranges", "apples", "pears");
$flipped = array_flip($input);

print_r($flipped);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [oranges] => 0
    [apples] => 1
    [pears] => 2
)
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title><function>array_flip</function> example : collision</title>
    <programlisting role="php">
<![CDATA[
<?php
$input = array("a" => 1, "b" => 1, "c" => 2);
$flipped = array_flip($input);

print_r($flipped);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [1] => b
    [2] => c
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>array_values</function></member>
    <member><function>array_keys</function></member>
    <member><function>array_reverse</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
-->