array-combine.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.array-combine" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_combine</refname>
  <refpurpose>Creates an array by using one array for keys and another for its values</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_combine</methodname>
   <methodparam><type>array</type><parameter>keys</parameter></methodparam>
   <methodparam><type>array</type><parameter>values</parameter></methodparam>
  </methodsynopsis>
  <para>
   Creates an <type>array</type> by using the values from the
   <parameter>keys</parameter> array as keys and the values from the
   <parameter>values</parameter> array as the corresponding values.
  </para>
 </refsect1>

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

    <varlistentry>
     <term><parameter>keys</parameter></term>
     <listitem>
      <para>
       Array of keys to be used. Illegal values for key will be
       converted to <type>string</type>.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>values</parameter></term>
     <listitem>
      <para>
       <type>Array</type> of values to be used
      </para>
     </listitem>
    </varlistentry>

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

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

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   As of PHP 8.0.0, a <classname>ValueError</classname> is thrown if the number of elements in
   <parameter>keys</parameter> and <parameter>values</parameter> does not
   match.
   Prior to PHP 8.0.0, a <constant>E_WARNING</constant> was emitted instead.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <function>array_combine</function> will now throw a
       <classname>ValueError</classname> if the number of elements
       for each array is not equal;
       previously this function returned &false; instead.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A simple <function>array_combine</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$a = array('green', 'red', 'yellow');
$b = array('avocado', 'apple', 'banana');
$c = array_combine($a, $b);

print_r($c);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [green] => avocado
    [red] => apple
    [yellow] => banana
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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