php-doc-en/reference/mongo/mongowritebatch/construct.xml

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

<refentry xml:id="mongowritebatch.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>MongoWriteBatch::__construct</refname>
  <refpurpose>Creates a new batch of write operations</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis>
   <modifier>protected</modifier> <methodname>MongoWriteBatch::__construct</methodname>
   <methodparam><type>MongoCollection</type><parameter>collection</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>batch_type</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>write_options</parameter></methodparam>
  </constructorsynopsis>
  <para>
   Constructs a new MongoWriteBatch.
  </para>
  <note>
   <para>
    This is a protected constructor. Please use one of the classes inheriting <classname>MongoWriteBatch</classname>.
   </para>
  </note>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>collection</parameter></term>
    &mongo.mongowritebatch.collection.description;
   </varlistentry>
   <varlistentry>
    <term><parameter>batch_type</parameter></term>
    <listitem>
     <para>
      One of:
      <simplelist>
       <member><literal>0</literal> - make an MongoWriteBatch::COMMAND_INSERT batch</member>
       <member><literal>1</literal> - make an MongoWriteBatch::COMMAND_UPDATE batch</member>
       <member><literal>2</literal> - make a  MongoWriteBatch::COMMAND_DELETE batch</member>
      </simplelist>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="mongowritebatch.construct.write_options">
    <term><parameter>write_options</parameter></term>
    &mongo.mongowritebatch.writeoptions.description;
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   A new MongoWriteBatch of type <parameter>batch_type</parameter>.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><classname>MongoInsertBatch</classname></member>
   <member><classname>MongoUpdateBatch</classname></member>
   <member><classname>MongoDeleteBatch</classname></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
-->