mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
568d95f88b
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324714 c90b9560-bf6c-de11-be94-00142212c4b1
140 lines
3.8 KiB
XML
140 lines
3.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.array-walk-recursive" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>array_walk_recursive</refname>
|
|
<refpurpose>Apply a user function recursively to every member of an array</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>array_walk_recursive</methodname>
|
|
<methodparam><type>array</type><parameter role="reference">input</parameter></methodparam>
|
|
<methodparam><type>callable</type><parameter>funcname</parameter></methodparam>
|
|
<methodparam choice="opt"><type>mixed</type><parameter>userdata</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Applies the user-defined function <parameter>funcname</parameter> to each
|
|
element of the <parameter>input</parameter> array. This function will recurse
|
|
into deeper arrays.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>input</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The input array.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>funcname</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Typically, <parameter>funcname</parameter> takes on two parameters.
|
|
The <parameter>input</parameter> parameter's value being the first, and
|
|
the key/index second.
|
|
</para>
|
|
<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>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>userdata</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If the optional <parameter>userdata</parameter> parameter is supplied,
|
|
it will be passed as the third parameter to the callback
|
|
<parameter>funcname</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<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_print($item, $key)
|
|
{
|
|
echo "$key holds $item\n";
|
|
}
|
|
|
|
array_walk_recursive($fruits, 'test_print');
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen role="php">
|
|
<![CDATA[
|
|
a holds apple
|
|
b holds banana
|
|
sour holds lemon
|
|
]]>
|
|
</screen>
|
|
<para>
|
|
You may notice that the key '<literal>sweet</literal>' is never displayed. Any key that holds an
|
|
<type>array</type> will not be passed to the function.
|
|
</para>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>array_walk</function></member>
|
|
<member>&seealso.callback;</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
|
|
-->
|