added "see also" links

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@294889 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Kristina Chodorow 2010-02-11 16:37:10 +00:00
parent 2a8a61e20a
commit 41251fe567
19 changed files with 133 additions and 37 deletions

View file

@ -144,6 +144,14 @@ $db = $m->foo; // get the database named "foo"
</variablelist>
</section>
</section>
<section>
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.connections;">connecting</link>.
</para>
</section>
<!-- }}} -->
</partintro>

View file

@ -51,6 +51,13 @@
</section>
<section>
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.collections;">collections</link>.
</para>
</section>
</partintro>
&reference.mongo.entities.mongocollection;

View file

@ -159,6 +159,13 @@ $collection->insert(array("username" => "joeschmoe"));
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.indexes;">indexes</link>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -71,6 +71,13 @@ $cursor = $collection->find($rangeQuery);
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.find;">find</link>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -130,6 +130,13 @@ catch(MongoCursorException $e) {
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.insert;">insert</link>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -65,7 +65,13 @@
<literal>"multiple"</literal>
</para>
<para>
All documents matching $criteria will be updated.
All documents matching $criteria will be updated.
<function>MongoCollection::update</function> has exactly the opposite
behavior of <function>MongoCollection::remove</function>: it updates
one document by default, not all matching documents. <emphasis>It is
recommended that you always specify whether you want to update
multiple documents or a single document</emphasis>, as the database
may change its default behavior at some point in the future.
</para>
</listitem>
</itemizedlist>
@ -197,6 +203,14 @@ $people->update("birthday" => $today), array('$set' => array('gift' => $surprise
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.update;">update</link>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -84,6 +84,13 @@ $cursor->skip(4);
</section>
<section>
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.cursors;">cursors</link>.
</para>
</section>
</partintro>
&reference.mongo.entities.mongocursor;

View file

@ -107,6 +107,14 @@ array(8) {
database.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.explain;">explain</link>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -47,6 +47,12 @@
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.limit;">limit</link>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -111,6 +111,13 @@ $db = $m->selectDB("example");
</variablelist>
</section>
</section>
<section>
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.databases;">databases</link>.
</para>
</section>
</partintro>
&reference.mongo.entities.mongodb;

View file

@ -74,6 +74,13 @@ $result = $db->command(array("authenticate" => 1,
Returns database response.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.authenticate;">authenticate</link>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -142,6 +142,14 @@ User 4af467e4fd543cce7b0ea8e2 had 1 sale(s).
</para>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.commands;">database commands</link>
and <link xlink:href="&url.mongodb.dochub.mapreduce;">MapReduce</link>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -11,8 +11,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>MongoGridFS</type><methodname>MongoDB::getGridFS</methodname>
<methodparam choice="opt"><type>string</type><parameter>arg1</parameter><initializer>&quot;fs&quot;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>arg2</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>prefix</parameter><initializer>&quot;fs&quot;</initializer></methodparam>
</methodsynopsis>
</refsect1>
@ -22,22 +21,11 @@
<variablelist>
<varlistentry>
<term>
<parameter>arg1</parameter>
<parameter>prefix</parameter>
</term>
<listitem>
<para>
If the only argument, the prefix for the files and chunks collections. Otherwise,
the name of the files collection.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>arg2</parameter>
</term>
<listitem>
<para>
Name of the chunks collection.
The prefix for the files and chunks collections.
</para>
</listitem>
</varlistentry>

View file

@ -26,6 +26,14 @@
Returns the profiling level.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.profiling;">profiling</link>
and <function>MongoDB::setProfilingLevel</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -50,6 +50,14 @@
Returns db response.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.repair;">repair</link>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -105,6 +105,12 @@ $people->insert(array("name" => "Fred", "likes" => array($trainRef, $soccerRef))
</section>
<section>
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.dbrefs;">databases references</link>.
</para>
</section>
</partintro>
&reference.mongo.entities.mongodbref;

View file

@ -220,6 +220,12 @@ $grid->storeBytes($bytes, array("whatever" => "metadata", "you" => "want");
</section>
<section>
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.gridfs;">GridFS</link>.
</para>
</section>
</partintro>
&reference.mongo.entities.mongogridfs;

View file

@ -11,8 +11,7 @@
<methodsynopsis>
<methodname>MongoGridFS::__construct</methodname>
<methodparam><type>MongoDB</type><parameter>db</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>files</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>chunks</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>prefix</parameter><initializer>&quot;fs&quot;</initializer></methodparam>
</methodsynopsis>
<para>
@ -27,13 +26,6 @@ $fs = new MongoGridFS($db, "myfiles");
]]>
uses myfiles.files and myfiles.chunks collections.
</para>
<para>
Use two arguments to fully specify the collection names:
<![CDATA[
$fs = new MongoGridFS($db, "myfiles", "mychunks");
]]>
uses myfiles and mychunks collections.
</para>
</refsect1>
<refsect1 role="parameters">
@ -56,18 +48,7 @@ $fs = new MongoGridFS($db, "myfiles", "mychunks");
</term>
<listitem>
<para>
Optional files collection name. If chunks is not given,
<literal>files</literal> is used as both collections&apos; prefix.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>chunks</parameter>
</term>
<listitem>
<para>
Optional chunks collection name.
Optional collection name prefix.
</para>
</listitem>
</varlistentry>

View file

@ -68,6 +68,12 @@ C:7:"MongoId":24:{4af9f23d8ead0e1d32000000}
</section>
<section>
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.objectids;">ids</link>.
</para>
</section>
</partintro>
&reference.mongo.entities.mongoid;