svn: /phpdoc/en/trunk/reference/spl/functions/ iterator-apply.xml

From: Date: Sun, 04 Oct 2009 14:56:29 +0000
Subject: svn: /phpdoc/en/trunk/reference/spl/functions/ iterator-apply.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-5065@lists.php.net to get a copy of this message
salathe Sun, 04 Oct 2009 14:56:29 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=289185 Log: Updated iterator_apply docs Changed paths: U phpdoc/en/trunk/reference/spl/functions/iterator-apply.xml Modified: phpdoc/en/trunk/reference/spl/functions/iterator-apply.xml =================================================================== --- phpdoc/en/trunk/reference/spl/functions/iterator-apply.xml 2009-10-04 14:22:37 UTC (rev 289184) +++ phpdoc/en/trunk/reference/spl/functions/iterator-apply.xml 2009-10-04 14:56:29 UTC (rev 289185) @@ -4,7 +4,7 @@ <refentry xml:id="function.iterator-apply" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>iterator_apply</refname> - <refpurpose>Apply a user function to every element of an iterator</refpurpose> + <refpurpose>Call a function for every element in an iterator</refpurpose> </refnamediv> <refsect1 role="description"> @@ -28,7 +28,7 @@ <term><parameter>iterator</parameter></term> <listitem> <para> - The class to walk through. + The class to iterate over. </para> </listitem> </varlistentry> @@ -37,6 +37,12 @@ <listitem> <para> The callback function to call on every element. + <note> + <simpara> + The function must return &true; in order to + continue iterating over the <parameter>iterator</parameter>. + </simpara> + </note> </para> </listitem> </varlistentry> @@ -60,6 +66,36 @@ </para> </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>iterator_apply</function> example</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="errors"> &reftitle.errors;

« previous php.doc.cvs (#5065) next »