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

replay reverted r313182 for callbackfilteriterator::*

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@313200 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Peter Cowburn 2011-07-13 09:45:09 +00:00
parent a1e4712d6a
commit 82b7ff16c1
2 changed files with 40 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
reference/spl/callbackfilteriterator/accept.xml
View file

@ -14,10 +14,13 @@
<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>
@ -29,10 +32,19 @@
<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>

35
reference/spl/callbackfilteriterator/construct.xml
View file

@ -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,7 +36,12 @@
<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>
@ -47,10 +51,19 @@
<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>