php-doc-en/reference/apc/apciterator/construct.xml

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

<refentry xml:id="apciterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>APCIterator::__construct</refname>
  <refpurpose>Constructs an APCIterator iterator object</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <methodname>APCIterator::__construct</methodname>
   <methodparam><type>string</type><parameter>cache</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>search</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>format</parameter><initializer>APC_ITER_ALL</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>chunk_size</parameter><initializer>100</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>list</parameter><initializer>APC_LIST_ACTIVE</initializer></methodparam>
  </methodsynopsis>
  <para>
   Constructs an <classname>APCIterator</classname> <type>object</type>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>cache</parameter></term>
    <listitem>
     <para>
      The cache type, which will be <literal>user</literal> or
      <literal>file</literal>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>search</parameter></term>
    <listitem>
     <para>
      A <link linkend="book.pcre">PCRE</link> regular expression that
      matches against APC key names, either as a <type>string</type> for
      a single regular expression, or as an <type>array</type> of regular
      expressions. Or, optionally pass in &null; to skip the search.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>format</parameter></term>
    <listitem>
     <para>
      The desired format, as configured with one or more of the
      <link linkend="apc.constants">APC_ITER_*</link> constants.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>chunk_size</parameter></term>
    <listitem>
     <para>
      The chunk size. Must be a value greater than 0. The default
      value is 100.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>list</parameter></term>
    <listitem>
     <para>
      The type to list. Either pass in <constant>APC_LIST_ACTIVE</constant>
      or <constant>APC_LIST_DELETED</constant>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An <classname>APCIterator</classname> <type>object</type> on success,
   or &null; on failure.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>APCIterator::__construct</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
foreach (new APCIterator('user', '/^counter\./') as $counter) {
    echo "$counter[key]: $counter[value]\n";
    apc_dec($counter['key'], $counter['value']);
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>apc_exists</function></member>
   <member><function>apc_cache_info</function></member>
  </simplelist>
 </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
-->