<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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 a filtered iterator from another iterator</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis role="CallbackFilterIterator">
   <modifier>public</modifier> <methodname>CallbackFilterIterator::__construct</methodname>
   <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
   <methodparam><type>callable</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>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>iterator</parameter></term>
    <listitem>
     <para>
      The iterator to be filtered.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <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>callable</type> value.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </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
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
-->
