sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added example and alterered spacing - it should be complete now, comments welcome!

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@165039 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Aidan Lister 2004-08-03 08:52:13 +00:00
parent 2e7fb0b1f6
commit 893a062437
1 changed files with 67 additions and 72 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

139
reference/array/functions/array-walk-recursive.xml
View file

@ -1,86 +1,81 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.array-walk-recursive">
<refnamediv>
<refname>array_walk_recursive</refname>
<refpurpose>
Apply a user function recursively to every member of an array
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>array_walk_recursive</methodname>
<methodparam><type>array</type><parameter>input</parameter></methodparam>
<methodparam><type>string</type><parameter>funcname</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>userdata</parameter></methodparam>
</methodsynopsis>
<simpara>
&return.success;
</simpara>
<simpara>
Applies the user-defined function <parameter>function</parameter> to each
element of the <parameter>array</parameter> array. This function will recur
into deeper arrays. Typically, <parameter>function</parameter> takes on two
parameters. The <parameter>array</parameter> parameter's value being the first, and
the key/index second. If the optional <parameter>userdata</parameter>
parameter is supplied, it will be passed as the third parameter to
the callback <parameter>function</parameter>.
</simpara>
<note>
<para>
If <parameter>function</parameter> needs to be working with the
actual values of the array, specify the first parameter of
<parameter>function</parameter> as a
<link linkend="language.references">reference</link>. Then,
any changes made to those elements will be made in the
original array itself.
</para>
</note>
<para>
<example>
<title><function>array_walk_recursive</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.3 $ -->
<refentry id="function.array-walk-recursive">
<refnamediv>
<refname>array_walk_recursive</refname>
<refpurpose>
Apply a user function recursively to every member of an array
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>array_walk_recursive</methodname>
<methodparam><type>array</type><parameter>input</parameter></methodparam>
<methodparam><type>string</type><parameter>funcname</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>userdata</parameter></methodparam>
</methodsynopsis>
<simpara>
Applies the user-defined function <parameter>funcname</parameter> to each
element of the <parameter>input</parameter> array. This function will recur
into deeper arrays. Typically, <parameter>funcname</parameter> takes on two
parameters. The <parameter>input</parameter> parameter's value being the first, and
the key/index second. If the optional <parameter>userdata</parameter>
parameter is supplied, it will be passed as the third parameter to
the callback <parameter>funcname</parameter>.
</simpara>
<simpara>
&return.success;
</simpara>
<note>
<para>
If <parameter>funcname</parameter> needs to be working with the
actual values of the array, specify the first parameter of
<parameter>funcname</parameter> as a
<link linkend="language.references">reference</link>. Then,
any changes made to those elements will be made in the
original array itself.
</para>
</note>
<para>
<example>
<title><function>array_walk_recursive</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$sweet = array('a' => 'apple', 'b' => 'banana');
$fruits = array('sweet' => $sweet, 'sour' => 'lemon');
function test_alter(&$item1, $key, $prefix)
function test_print($item, $key)
{
$item1 = "$prefix: $item1";
echo "$key holds $item\n";
}
function test_print($item2, $key)
{
echo "$key. $item2<br />\n";
}
echo "Before ...:\n";
array_walk($fruits, 'test_print');
array_walk($fruits, 'test_alter', 'fruit');
echo "... and after:\n";
array_walk($fruits, 'test_print');
array_walk_recursive($fruits, 'test_print');
?>
]]>
</programlisting>
<para>
The printout of the program above will be:
</para>
<screen role="php">
<![CDATA[
// No idea, because PHP segfaults!
]]>
</screen>
</example>
</programlisting>
<para>
The printout of the program above will be:
</para>
<simpara>
See also <function>array_walk</function>
</simpara>
</refsect1>
</refentry>
<screen role="php">
<![CDATA[
a holds apple
b holds banana
sour holds lemon
]]>
</screen>
<para>
You may notice that the key 'sweet' is never displayed. Any key that holds an
<type>array</type> will not be passed to the function.
</para>
</example>
</para>
<simpara>
See also <function>array_walk</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
@ -101,4 +96,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->