[PHP-DOC] cvs: phpdoc /en/functions array.xml From: Andrei Zmievski (andrei <email protected>)
Date: 07/11/00

andrei Tue Jul 11 12:33:05 2000 EDT

  Modified files:
    /phpdoc/en/functions array.xml
  Log:
  Docs for array_merge_recursive().
  
  
Index: phpdoc/en/functions/array.xml
diff -u phpdoc/en/functions/array.xml:1.11 phpdoc/en/functions/array.xml:1.12
--- phpdoc/en/functions/array.xml:1.11 Tue Jul 11 12:00:23 2000
+++ phpdoc/en/functions/array.xml Tue Jul 11 12:33:04 2000
@@ -217,6 +217,53 @@
    </refsect1>
   </refentry>
 
+ <refentry id="function.array-merge-recursive">
+ <refnamediv>
+ <refname>array_merge_recursive</refname>
+ <refpurpose>Merge two or more arrays recursively</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>array <function>array_merge_recursive</function></funcdef>
+ <paramdef>array <parameter>array1</parameter></paramdef>
+ <paramdef>array <parameter>array2</parameter></paramdef>
+ <paramdef>
+ <parameter><optional> ...</optional></parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ <function>array_merge_recursive</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 values for
+ these keys are merged together into an array, and this is done
+ recursively, so that if one of the values is an array itself, the
+ function will merge it with a corresponding entry in another array
+ too. If, however, the arrays have the same numeric key, the later
+ value will not overwrite the original value, but will be appended.
+ </para>
+ <para>
+ <example>
+ <title><function>array_merge_recursive</function> example</title>
+ <programlisting role="php">
+$ar1 = array("color" => array("favorite" => "red"), 5);
+$ar2 = array(10, "color" => array("favorite" => "green", "blue"));
+$result = array_merge_recursive($ar1, $ar2);
+ </programlisting>
+ <para>
+ Resulting array will be array("color" => array("favorite" =>
+ array("red", "green"), "blue"), 5, 10).
+ </para>
+ </example>
+ </para>
+ </refsect1>
+ </refentry>
+
   <refentry id="function.array-multisort">
    <refnamediv>
     <refname>array_multisort</refname>