php-doc-en/reference/mongo/context/log-write-batch.xml

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

<refentry xml:id="function.log-write-batch" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>log_write_batch</refname>
  <refpurpose>Callback When Writing Batches</refpurpose>
 </refnamediv>

 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis role="procedural">
   <methodname>log_write_batch</methodname>
   <methodparam><type>array</type><parameter>server</parameter></methodparam>
   <methodparam><type>array</type><parameter>writeOptions</parameter></methodparam>
   <methodparam><type>array</type><parameter>batch</parameter></methodparam>
   <methodparam><type>array</type><parameter>protocolOptions</parameter></methodparam>
  </methodsynopsis>
  <para>
   A <type>callable</type> function, used by the
   <link linkend="context.mongodb.log-write-batch">log_write_batch context option</link>,
   when executing a batch operation.
  </para>
  <note>
   <para>
    This is <emphasis>not</emphasis> a real function, only a prototype of how the function should
    be.
   </para>
  </note>
 </refsect1><!-- }}} -->

 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <variablelist>
   &mongo.context.server;
   &mongo.context.writeoptions;
   <varlistentry>
    <term>
     <parameter>batch</parameter>
    </term>
    <listitem>
     <para>
      Array, the actual batch operation.
     </para>
    </listitem>
   </varlistentry>
   &mongo.context.protocoloptions;
  </variablelist>
 </refsect1><!-- }}} -->

 <refsect1 role="changelog"><!-- {{{ -->
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>1.5.0</entry>
      <entry>
       Only available when connected to MongoDB 2.6.0+
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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
-->