Bunch of little tiny doc updates and fixes.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332947 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Derick Rethans 2014-03-10 15:03:19 +00:00
parent 849749083c
commit cb5b7284fe
10 changed files with 126 additions and 57 deletions

View file

@ -83,8 +83,6 @@
<literal>0</literal> (<constant>MongoBinData::GENERIC</constant>).
</entry>
</row>
</tbody>
<tbody>
<row>
<entry>1.2.11</entry>
<entry>

View file

@ -74,11 +74,10 @@
</listitem>
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.journal;
<!--
&mongo.writes.parameters.sockettimeoutms;
-->
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.writeconcerntimeout;
&mongo.writes.parameters.writeconcerntimeoutms;
&mongo.writes.parameters.safe;
&mongo.writes.parameters.timeout;
</itemizedlist>
@ -121,13 +120,16 @@
</row>
</thead>
<tbody>
<!--
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"wtimeout"</literal> option to
<literal>"wTimeoutMS"</literal>.</entry>
</row>
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"timeout"</literal> option to
<literal>"socketTimeoutMS"</literal>.</entry>
</row>
-->
<row>
<entry>1.2.7</entry>
<entry>Added <literal>"continueOnError"</literal> option.</entry>

View file

@ -54,11 +54,10 @@
<itemizedlist>
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.journal;
<!--
&mongo.writes.parameters.sockettimeoutms;
-->
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.writeconcerntimeout;
&mongo.writes.parameters.writeconcerntimeoutms;
&mongo.writes.parameters.safe;
&mongo.writes.parameters.timeout;
</itemizedlist>
@ -221,13 +220,16 @@
</row>
</thead>
<tbody>
<!--
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"wtimeout"</literal> option to
<literal>"wTimeoutMS"</literal>.</entry>
</row>
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"timeout"</literal> option to
<literal>"socketTimeoutMS"</literal>.</entry>
</row>
-->
<row>
<entry>1.3.0</entry>
<entry>

View file

@ -49,11 +49,10 @@
</listitem>
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.journal;
<!--
&mongo.writes.parameters.sockettimeoutms;
-->
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.writeconcerntimeout;
&mongo.writes.parameters.writeconcerntimeoutms;
&mongo.writes.parameters.safe;
&mongo.writes.parameters.timeout;
</itemizedlist>
@ -93,13 +92,16 @@
</row>
</thead>
<tbody>
<!--
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"wtimeout"</literal> option to
<literal>"wTimeoutMS"</literal>.</entry>
</row>
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"timeout"</literal> option to
<literal>"socketTimeoutMS"</literal>.</entry>
</row>
-->
<row>
<entry>1.3.0</entry>
<entry>

View file

@ -53,11 +53,10 @@
<itemizedlist>
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.journal;
<!--
&mongo.writes.parameters.sockettimeoutms;
-->
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.writeconcerntimeout;
&mongo.writes.parameters.writeconcerntimeoutms;
&mongo.writes.parameters.safe;
&mongo.writes.parameters.timeout;
</itemizedlist>
@ -99,13 +98,16 @@
</row>
</thead>
<tbody>
<!--
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"wtimeout"</literal> option to
<literal>"wTimeoutMS"</literal>.</entry>
</row>
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"timeout"</literal> option to
<literal>"socketTimeoutMS"</literal>.</entry>
</row>
-->
<row>
<entry>1.2.0</entry>
<entry>Added <literal>"timeout"</literal> option.</entry>

View file

@ -13,6 +13,11 @@
<modifier>static protected</modifier> <type>string</type><methodname>MongoCollection::toIndexString</methodname>
<methodparam><type>mixed</type><parameter>keys</parameter></methodparam>
</methodsynopsis>
<warning>
<para>
This method is deprecated since version 1.5.0.
</para>
</warning>
</refsect1>
<refsect1 role="parameters">
@ -77,6 +82,30 @@ echo MyCollection::toIndexString(array('name' => 1, 'age' => -1)), "\n";
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>1.5.0</entry>
<entry>
This method has been deprecated.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -85,11 +85,10 @@
</listitem>
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.journal;
<!--
&mongo.writes.parameters.sockettimeoutms;
-->
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.writeconcerntimeout;
&mongo.writes.parameters.writeconcerntimeoutms;
&mongo.writes.parameters.safe;
&mongo.writes.parameters.timeout;
</itemizedlist>
@ -129,13 +128,16 @@
</row>
</thead>
<tbody>
<!--
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"wtimeout"</literal> option to
<literal>"wTimeoutMS"</literal>.</entry>
</row>
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"timeout"</literal> option to
<literal>"socketTimeoutMS"</literal>.</entry>
</row>
-->
<row>
<entry>1.3.0</entry>
<entry>

View file

@ -36,7 +36,7 @@
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><methodname>MongoCursor::setReadPreference</methodname> tag set array syntaxexample
<title><methodname>MongoCursor::setReadPreference</methodname> tag set array syntax example
</title>
<programlisting role="php">
<![CDATA[

View file

@ -4,7 +4,7 @@
<refentry xml:id="mongocursor.slaveokay" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoCursor::slaveOkay</refname>
<refpurpose>Sets whether this query can be done on a secondary</refpurpose>
<refpurpose>Sets whether this query can be done on a secondary [deprecated]</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -13,18 +13,25 @@
<modifier>public</modifier> <type>MongoCursor</type><methodname>MongoCursor::slaveOkay</methodname>
<methodparam choice="opt"><type>bool</type><parameter>okay</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<warning>
<para>
This method is deprecated since version 1.5.0. Instead, please use
<methodname>MongoCursor::setReadPreference</methodname> and <xref
linkend="mongo.readpreferences" />.
</para>
</warning>
<para>
Calling this will make the driver route reads to secondaries if:
<itemizedlist>
<listitem>
<simpara>
You are using a replica set and
You are using a replica set, and
</simpara>
</listitem>
<listitem>
<simpara>
You created a <classname>MongoClient</classname> instance using the option
<literal>"replicaSet" => "setName" and</literal>
<literal>"replicaSet" => "setName"</literal>, and
</simpara>
</listitem>
<listitem>
@ -125,6 +132,31 @@ $cursor = $collection->find()->slaveOkay(false);
</simplelist>
</refsect1><!-- }}} -->
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>1.5.0</entry>
<entry>
This method has been deprecated in favour of
<methodname>MongoCursor::setReadPreference</methodname> and <xref
linkend="mongo.readpreferences" />.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -42,37 +42,37 @@
<!-- }}} -->
</section>
<section role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>1.3.0</entry>
<entry>
This functionality has been removed and no longer does anything other
than emit deprecation warnings. This class is only kept around for
backwards compatability and will be removed in the near future.
</entry>
</row>
<row>
<entry>1.2.11</entry>
<entry>
Emits <constant>E_DEPRECATED</constant> when used.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>
<section role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>1.3.0</entry>
<entry>
This functionality has been removed and no longer does anything other
than emit deprecation warnings. This class is only kept around for
backwards compatability and will be removed in the near future.
</entry>
</row>
<row>
<entry>1.2.11</entry>
<entry>
Emits <constant>E_DEPRECATED</constant> when used.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>
</partintro>