svn: /phpdoc/en/trunk/reference/spl/callbackfilteriterator/ accept.xml construct.xml

From: Date: Wed, 13 Jul 2011 09:45:09 +0000
Subject: svn: /phpdoc/en/trunk/reference/spl/callbackfilteriterator/ accept.xml construct.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-8478@lists.php.net to get a copy of this message
salathe Wed, 13 Jul 2011 09:45:09 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=313200 Log: replay reverted r313182 for callbackfilteriterator::* Changed paths: U phpdoc/en/trunk/reference/spl/callbackfilteriterator/accept.xml U phpdoc/en/trunk/reference/spl/callbackfilteriterator/construct.xml Modified: phpdoc/en/trunk/reference/spl/callbackfilteriterator/accept.xml =================================================================== --- phpdoc/en/trunk/reference/spl/callbackfilteriterator/accept.xml 2011-07-13 09:39:04 UTC (rev 313199) +++ phpdoc/en/trunk/reference/spl/callbackfilteriterator/accept.xml 2011-07-13 09:45:09 UTC (rev 313200) @@ -14,11 +14,14 @@ <void /> </methodsynopsis> <para> - + This method calls the callback with the current value, current key + and the inner iterator. </para> + <para> + The callback is expected to return &true; if the current item is + to be accepted, or &false; otherwise. + </para> - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> @@ -29,11 +32,20 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> + Returns &true; to accept the current item, or &false; otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><link linkend="callbackfilteriterator.examples">CallbackFilterIterator Examples</link></member> + <member><methodname>CallbackFilterIterator::__construct</methodname></member> + </simplelist> </para> </refsect1> - </refentry> <!-- Keep this comment at the end of the file Modified: phpdoc/en/trunk/reference/spl/callbackfilteriterator/construct.xml =================================================================== --- phpdoc/en/trunk/reference/spl/callbackfilteriterator/construct.xml 2011-07-13 09:39:04 UTC (rev 313199) +++ phpdoc/en/trunk/reference/spl/callbackfilteriterator/construct.xml 2011-07-13 09:45:09 UTC (rev 313200) @@ -4,22 +4,21 @@ <refentry xml:id="callbackfilteriterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CallbackFilterIterator::__construct</refname> - <refpurpose>Create an Iterator from another iterator</refpurpose> + <refpurpose>Create a filtered iterator from another iterator</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; - <methodsynopsis> + <constructorsynopsis role="oop"> + <modifier>public</modifier> <methodname>CallbackFilterIterator::__construct</methodname> <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam> - <methodparam><type>string</type><parameter>callback</parameter></methodparam> - </methodsynopsis> + <methodparam><type>callback</type><parameter>callback</parameter></methodparam> + </constructorsynopsis> <para> - + Creates a filtered iterator using the <parameter>callback</parameter> to + determine which items are accepted or rejected. </para> - - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> @@ -29,7 +28,7 @@ <term><parameter>iterator</parameter></term> <listitem> <para> - + The iterator to be filtered. </para> </listitem> </varlistentry> @@ -37,8 +36,13 @@ <term><parameter>callback</parameter></term> <listitem> <para> - + The callback, which should return &true; to accept the current item + or &false; otherwise. + See <link linkend="callbackfilteriterator.examples">Examples</link>. </para> + <para> + May be any valid <type>callback</type> value. + </para> </listitem> </varlistentry> </variablelist> @@ -47,11 +51,20 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> + &return.void; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><link linkend="callbackfilteriterator.examples">CallbackFilterIterator Examples</link></member> + <member><methodname>CallbackFilterIterator::accept</methodname></member> + </simplelist> </para> </refsect1> - </refentry> <!-- Keep this comment at the end of the file

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