<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: 60809ebcf7d0c261b2f00e093e4fab70326ffc7b Maintainer: yannick Status: ready -->

<!-- Reviewed: no -->

<refentry xml:id="function.iterator-apply" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>iterator_apply</refname>

<refpurpose>Appelle une fonction pour tous les éléments d'un itérateur</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>int</type><methodname>iterator_apply</methodname>

<methodparam><type>Traversable</type><parameter>iterator</parameter></methodparam>

<methodparam><type>callable</type><parameter>callback</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>args</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

Appelle une fonction pour tous les éléments d'un itérateur.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>iterator</parameter></term>

<listitem>

<para>

L'objet itérateur à parcourir.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>callback</parameter></term>

<listitem>

<para>

La fonction de rappel à appeler à chaque élément.

Cette fonction ne reçoit que les arguments <parameter>args</parameter> donnés, elle est donc nullaire par défaut.

Si <literal>count($args) === 3</literal>, par exemple, la fonction est ternaire.

<note>

<simpara>

La fonction doit retourner &true; afin de continuer

d'itérer à travers l'itérateur nommé par le paramètre

<parameter>iterator</parameter>.

</simpara>

</note>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>args</parameter></term>

<listitem>

<para>

Un tableau <type>array</type> d'arguments; chaque élément de

<parameter>args</parameter> est passé à la fonction de rappel

<parameter>callback</parameter> comme argument séparé.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retourne le nombre d'itération.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Exemple avec <function>iterator_apply</function></title>

<programlisting role="php">

<![CDATA[

<?php

function print_caps(Iterator $iterator) {

echo strtoupper($iterator->current()) . "\n";

return TRUE;

}

$it = new ArrayIterator(array("Apples", "Bananas", "Cherries"));

iterator_apply($it, "print_caps", array($it));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

APPLES

BANANAS

CHERRIES

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>array_walk</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

-->