php-doc-en/reference/array/functions/array-merge.xml
2002-05-18 09:55:41 +00:00

126 lines
3.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<refentry id="function.array-merge">
<refnamediv>
<refname>array_merge</refname>
<refpurpose>Merge two or more arrays</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>array_merge</methodname>
<methodparam><type>array</type><parameter>array1</parameter></methodparam>
<methodparam><type>array</type><parameter>array2</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
<function>array_merge</function> merges the elements of two or
more arrays together so that the values of one are appended to
the end of the previous one. It returns the resulting array.
</para>
<para>
If the input arrays have the same string keys, then the later value for
that key will overwrite the previous one. If, however, the arrays
contain numeric keys, the later value will <emphasis
role="strong">not</emphasis> overwrite the original value, but will be
appended.
</para>
<para>
<example>
<title><function>array_merge</function> example</title>
<programlisting role="php">
<![CDATA[
$array1 = array ("color" => "red", 2, 4);
$array2 = array ("a", "b", "color" => "green", "shape" => "trapezoid", 4);
$result = array_merge ($array1, $array2);
]]>
</programlisting>
<para>
The <literal>$result</literal> will be:
<screen role="php">
<![CDATA[
Array
(
[color] => green
[0] => 2
[1] => 4
[2] => a
[3] => b
[shape] => trapezoid
[4] => 4
)
]]>
</screen>
</para>
</example>
</para>
<para>
<example>
<title>Simple <function>array_merge</function> example</title>
<programlisting role="php">
<![CDATA[
$array1 = array();
$array2 = array(1 => "data");
$result = array_merge($array1, $array2);
]]>
</programlisting>
<para>
Don't forget that numeric keys will be renumbered!
<screen role="php">
<![CDATA[
Array
(
[0] => data
)
]]>
</screen>
</para>
<para>
If you want to completely preserve the arrays and just want to append
them to each other, use the <literal>+</literal> operator:
<programlisting role="php">
<![CDATA[
$array1 = array();
$array2 = array(1 => "data");
$result = $array1 + $array2;
]]>
</programlisting>
The numeric key will be preserved and thus the association remains.
<screen role="php">
<![CDATA[
Array
(
[1] => data
)
]]>
</screen>
</para>
</example>
</para>
<para>
See also <function>array_merge_recursive</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
-->