construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c44e9cb68b9b65771f9c45db2c07a06c63d71359 Maintainer: satoruyoshida Status: ready -->

<refentry xml:id="apcuiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>APCUIterator::__construct</refname>
  <refpurpose>APCUIterator イテレータオブジェクトを作成する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis>
   <modifier>public</modifier> <methodname>APCUIterator::__construct</methodname>
   <methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></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>
  </constructorsynopsis>
  <para>
   <classname>APCUIterator</classname> オブジェクトを作成します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>search</parameter></term>
    <listitem>
     <para>
      単一の文字列を指定する場合、APCu のキーの名前にマッチする
      <link linkend="book.pcre">PCRE</link> 正規表現を指定します。
      配列を指定した場合は、APCu のキーの名前を指定します。
      &null; を渡すと、検索をスキップします。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>format</parameter></term>
    <listitem>
     <para>
      希望する書式。
      <link linkend="apcu.constants">APC_ITER_*</link> 定数の組み合わせで指定します。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>chunk_size</parameter></term>
    <listitem>
     <para>
      チャンクサイズ。0 より大きい値でなければなりません。
      デフォルト値は 100 です。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>list</parameter></term>
    <listitem>
     <para>
      一覧にする形式。<constant>APC_LIST_ACTIVE</constant>
      あるいは <constant>APC_LIST_DELETED</constant> を渡します。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>APCUIterator::__construct</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
foreach (new APCUIterator('/^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>apcu_exists</function></member>
   <member><function>apcu_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
-->