Document rest of the Mongo*Batch classes

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332966 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2014-03-12 00:05:44 +00:00
parent c267c136d6
commit 8d5cd349a2
8 changed files with 430 additions and 42 deletions

View file

@ -1747,6 +1747,8 @@ paths</simpara></warning>
<!ENTITY mongo.errors.deprecated '<para xmlns="http://docbook.org/ns/docbook">Issues <constant>E_DEPRECATED</constant> warning</para>'>
<!ENTITY mongo.gridfs.store.metadata.note '<note xmlns="http://docbook.org/ns/docbook"><para>These fields may also overwrite those that would be created automatically by the driver, as described in the MongoDB core documentation for the <link xlink:href="&url.mongodb.docs.gridfs;#the-files-collection" xmlns:xlink="http://www.w3.org/1999/xlink">files collection</link>. Some practical use cases for this behavior would be to specify a custom <literal>chunkSize</literal> or <literal>_id</literal> for the file.</para></note>'>
<!ENTITY mongo.gridfs.store.return '<para xmlns="http://docbook.org/ns/docbook">Returns the <literal>_id</literal> of the saved file document. This will be a generated <classname>MongoId</classname> unless an <literal>_id</literal> was explicitly specified in the <parameter>extra</parameter> parameter.</para>'>
<!ENTITY mongo.mongowritebatch.writeoptions.description '<listitem xmlns="http://docbook.org/ns/docbook"><para>An array of Write Options.<informaltable><thead><row><entry>key</entry><entry>value meaning</entry></row></thead><tbody><row><entry>w (int|string)</entry><entry><link linkend="mongo.writeconcern">WriteConcern</link> value</entry></row><row><entry>wtimeout (int)</entry><entry><link linkend="mongo.writeconcern">Maximum time to wait for Replication</link></entry></row><row><entry>ordered</entry><entry>Determins if MongoDB must apply this batch in order (sequentally, one item at a time) or can rearrange it. Defaults to &true;</entry></row><row><entry>j (bool)</entry><entry>Wait for journaling on the primary. This value is discouraged, use WriteConcern instead</entry></row><row><entry>fsync (bool)</entry><entry>Wait for fsync on the primary. This value is discouraged, use WriteConcern instead</entry></row></tbody></informaltable></para></listitem>'>
<!ENTITY mongo.mongowritebatch.collection.description '<listitem><para>The <classname>MongoCollection</classname> to execute the batch on.Its <link linkend="mongo.writeconcern">WriteConcern</link> will be copied and used as default WriteConcernsif none given as <parameter>$write_options</parameter> or during <methodname>MongoWriteBatch::execute</methodname>.</para></listitem>'>
<!-- Radius -->
<!ENTITY radius.request.required '<note xmlns="http://docbook.org/ns/docbook"><para>A request must be created via <function>radius_create_request</function> before this function can be called.</para></note>'>

View file

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.mongodeletebatch" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The MongoDeleteBatch class</title>
<titleabbrev>MongoDeleteBatch</titleabbrev>
<partintro>
<!-- {{{ MongoDeleteBatch intro -->
<section xml:id="mongodeletebatch.intro">
&reftitle.intro;
<para>
Constructs a batch of DELETE operations. See <classname>MongoWriteBatch</classname>.
</para>
</section>
<!-- }}} -->
<section xml:id="mongodeletebatch.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>MongoDeleteBatch</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>MongoDeleteBatch</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>MongoWriteBatch</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodeletebatch')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongowritebatch')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.mongo.entities.mongodeletebatch;
</phpdoc:classref>
<!-- 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
-->

View file

@ -0,0 +1,66 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongodeletebatch.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDeleteBatch::__construct</refname>
<refpurpose>Description</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>MongoDeleteBatch::__construct</methodname>
<methodparam><type>MongoCollection</type><parameter>collection</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>write_options</parameter></methodparam>
</methodsynopsis>
<para>
Constructs a batch of DELETE operations. See <classname>MongoWriteBatch</classname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>collection</parameter></term>
&mongo.mongowritebatch.collection.description;
</varlistentry>
<varlistentry>
<term><parameter>write_options</parameter></term>
&mongo.mongowritebatch.writeoptions.description;
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A new MongoDeleteBatch.
</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
-->

View file

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.mongoinsertbatch" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The MongoInsertBatch class</title>
<titleabbrev>MongoInsertBatch</titleabbrev>
<partintro>
<!-- {{{ MongoInsertBatch intro -->
<section xml:id="mongoinsertbatch.intro">
&reftitle.intro;
<para>
Constructs a batch of INSERT operations. See <classname>MongoWriteBatch</classname>.
</para>
</section>
<!-- }}} -->
<section xml:id="mongoinsertbatch.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>MongoInsertBatch</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>MongoInsertBatch</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>MongoWriteBatch</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongoinsertbatch')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongowritebatch')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.mongo.entities.mongoinsertbatch;
</phpdoc:classref>
<!-- 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
-->

View file

@ -0,0 +1,66 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongoinsertbatch.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoInsertBatch::__construct</refname>
<refpurpose>Description</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>MongoInsertBatch::__construct</methodname>
<methodparam><type>MongoCollection</type><parameter>collection</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>write_options</parameter></methodparam>
</methodsynopsis>
<para>
Constructs a batch of INSERT operations. See <classname>MongoWriteBatch</classname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>collection</parameter></term>
&mongo.mongowritebatch.collection.description;
</varlistentry>
<varlistentry>
<term><parameter>write_options</parameter></term>
&mongo.mongowritebatch.writeoptions.description;
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A new MongoInsertBatch.
</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
-->

View file

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.mongoupdatebatch" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The MongoUpdateBatch class</title>
<titleabbrev>MongoUpdateBatch</titleabbrev>
<partintro>
<!-- {{{ MongoUpdateBatch intro -->
<section xml:id="mongoupdatebatch.intro">
&reftitle.intro;
<para>
Constructs a batch of UPDATE operations. See <classname>MongoWriteBatch</classname>.
</para>
</section>
<!-- }}} -->
<section xml:id="mongoupdatebatch.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>MongoUpdateBatch</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>MongoUpdateBatch</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>MongoWriteBatch</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongoupdatebatch')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongowritebatch')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.mongo.entities.mongoupdatebatch;
</phpdoc:classref>
<!-- 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
-->

View file

@ -0,0 +1,66 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongoupdatebatch.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoUpdateBatch::__construct</refname>
<refpurpose>Description</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>MongoUpdateBatch::__construct</methodname>
<methodparam><type>MongoCollection</type><parameter>collection</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>write_options</parameter></methodparam>
</methodsynopsis>
<para>
Constructs a batch of UPDATE operations. See <classname>MongoWriteBatch</classname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>collection</parameter></term>
&mongo.mongowritebatch.collection.description;
</varlistentry>
<varlistentry>
<term><parameter>write_options</parameter></term>
&mongo.mongowritebatch.writeoptions.description;
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A new MongoUpdateBatch.
</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
-->

View file

@ -31,13 +31,7 @@
<variablelist>
<varlistentry>
<term><parameter>collection</parameter></term>
<listitem>
<para>
The <classname>MongoCollection</classname> to execute the batch on.
Its <link linkend="mongo.writeconcern">WriteConcern</link> will be copied and used as default WriteConcerns
if none given as <parameter>$write_options</parameter> or during <methodname>MongoWriteBatch::execute</methodname>.
</para>
</listitem>
&mongo.mongowritebatch.collection.description;
</varlistentry>
<varlistentry>
<term><parameter>batch_type</parameter></term>
@ -54,41 +48,7 @@
</varlistentry>
<varlistentry>
<term><parameter>write_options</parameter></term>
<listitem>
<para>
An array of Write Options.
<informaltable>
<thead>
<row>
<entry>key</entry>
<entry>value meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry>w (int|string)</entry>
<entry><link linkend="mongo.writeconcern">WriteConcern</link> value</entry>
</row>
<row>
<entry>wtimeout (int)</entry>
<entry><link linkend="mongo.writeconcern">Maximum time to wait for Replication</link></entry>
</row>
<row>
<entry>ordered</entry>
<entry>Determins if MongoDB must apply this batch in order (sequentally, one item at a time) or can rearrange it. Defaults to &true;</entry>
</row>
<row>
<entry>j (bool)</entry>
<entry>Wait for journaling on the primary. This value is discouraged, use WriteConcern instead</entry>
</row>
<row>
<entry>fsync (bool)</entry>
<entry>Wait for fsync on the primary. This value is discouraged, use WriteConcern instead</entry>
</row>
</tbody>
</informaltable>
</para>
</listitem>
&mongo.mongowritebatch.writeoptions.description;
</varlistentry>
</variablelist>
</refsect1>