mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Whitespace and removed leftover <!-- comments --> from docgen
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@276456 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson
parent
40b1dea738
commit
1ac4d89822
22 changed files with 180 additions and 183 deletions
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-close" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -36,9 +36,8 @@
|
|||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<!-- See also &return.success; -->
|
||||
<para>
|
||||
&return.success;
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.1.1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-connect" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -22,44 +22,44 @@
|
|||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>host</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Address of the database to which to connect.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>auto_reconnect</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
If the driver should attempt to reconnect if
|
||||
the database connection is lost.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>host</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Address of the database to which to connect.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>auto_reconnect</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
If the driver should attempt to reconnect if
|
||||
the database connection is lost.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
<para>
|
||||
If able to connect, the connection resource is returned.
|
||||
Otherwise, false.
|
||||
If able to connect, the connection resource is returned.
|
||||
Otherwise, false.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
If the server name is invalid (null or the empty string).
|
||||
If the driver is unable to connect to the host.
|
||||
If the server name is invalid (null or the empty string).
|
||||
If the driver is unable to connect to the host.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -69,7 +69,7 @@
|
|||
<example>
|
||||
<title><function>mongo_connect</function> example</title>
|
||||
<para>
|
||||
To connect to a Mongo database running locally on the default port:
|
||||
To connect to a Mongo database running locally on the default port:
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-find-one" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -16,7 +16,7 @@
|
|||
<methodparam><type>array</type><parameter>query</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Queries the database for a single record. This can also be used for database commands.
|
||||
Queries the database for a single record. This can also be used for database commands.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -44,7 +44,7 @@
|
|||
<term><parameter>query</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An array representing the desired results.
|
||||
An array representing the desired results.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -55,7 +55,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an array if an element matching the query was found, null otherwise.
|
||||
Returns an array if an element matching the query was found, null otherwise.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -65,8 +65,8 @@
|
|||
<example>
|
||||
<title><function>mongo_find_one</function> example</title>
|
||||
<para>
|
||||
This example shows how to find the most recently inserted record
|
||||
in the collection "bar" in the database "foo".
|
||||
This example shows how to find the most recently inserted record
|
||||
in the collection "bar" in the database "foo".
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
@ -100,8 +100,8 @@ array(2) {
|
|||
<example>
|
||||
<title><function>mongo_find_one</function> example</title>
|
||||
<para>
|
||||
This example shows how to execute a database command using
|
||||
the "foo" database.
|
||||
This example shows how to execute a database command using
|
||||
the "foo" database.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridchunk-data" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -14,25 +14,25 @@
|
|||
<methodparam><type>resource</type><parameter>chunk</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns the contents of a chunk.
|
||||
Returns the contents of a chunk.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>chunk</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The chunk from which to fetch data.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>chunk</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The chunk from which to fetch data.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridchunk-get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -15,43 +15,42 @@
|
|||
<methodparam><type>int</type><parameter>num</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Return a chunk of a given file.
|
||||
Return a chunk of a given file.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>file</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The file from which to fetch the chunk.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>num</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The number of the chunk to fetch.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>file</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The file from which to fetch the chunk.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>num</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The number of the chunk to fetch.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<!-- See also &return.success; -->
|
||||
<para>
|
||||
Returns a Gridfs file chunk.
|
||||
Returns a Gridfs file chunk.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridchunk-size" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<methodparam><type>resource</type><parameter>gridchunk</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
The size of a given chunk.
|
||||
The size of a given chunk.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the size of a chunk.
|
||||
Returns the size of a chunk.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridfile-chunk-num" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<methodparam><type>resource</type><parameter>gridfile</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns the number of chunks a file is composed of.
|
||||
Returns the number of chunks a file is composed of.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the number of chunks.
|
||||
Returns the number of chunks.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridfile-chunk-size" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<methodparam><type>resource</type><parameter>gridfile</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Finds the size of chunks used by a grid file.
|
||||
Finds the size of chunks used by a grid file.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the size of the chunks in this file.
|
||||
Returns the size of the chunks in this file.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridfile-exists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<methodparam><type>resource</type><parameter>gridfile</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Checks if a gridfile exists.
|
||||
Checks if a gridfile exists.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns if the grid file exists.
|
||||
Returns if the grid file exists.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridfile-filename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<methodparam><type>resource</type><parameter>gridfile</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns the name of a grid file.
|
||||
Returns the name of a grid file.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the filename.
|
||||
Returns the filename.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridfile-size" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<methodparam><type>resource</type><parameter>gridfile</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns the size of a grid file.
|
||||
Returns the size of a grid file.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the size of the file.
|
||||
Returns the size of the file.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridfile-write" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Write a file from the database to the local filesystem.
|
||||
Write a file from the database to the local filesystem.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
<term><parameter>filename</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name to save the file under.
|
||||
Name to save the file under.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -46,7 +46,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the number of bytes written.
|
||||
Returns the number of bytes written.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -56,8 +56,8 @@
|
|||
<example>
|
||||
<title><function>mongo_gridfile_write</function> example</title>
|
||||
<para>
|
||||
This example shows a file being retreived from the database and
|
||||
saved to the local filesystem.
|
||||
This example shows a file being retreived from the database and
|
||||
saved to the local filesystem.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridfs-find" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<methodparam><type>array</type><parameter>query</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Find a file in the database.
|
||||
Find a file in the database.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -45,9 +45,8 @@
|
|||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<!-- See also &return.success; -->
|
||||
<para>
|
||||
A grid file.
|
||||
A grid file.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridfs-init" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -16,7 +16,7 @@
|
|||
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Creates a new gridfs connection which can be used to interact with files in the database.
|
||||
Creates a new gridfs connection which can be used to interact with files in the database.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -55,7 +55,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
A connection to the grid filesystem.
|
||||
A connection to the grid filesystem.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -65,8 +65,8 @@
|
|||
<example>
|
||||
<title><function>mongo_gridfs_init</function> example</title>
|
||||
<para>
|
||||
This example creates a new connection and uses it to find a file
|
||||
in the database.
|
||||
This example creates a new connection and uses it to find a file
|
||||
in the database.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridfs-list" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -46,7 +46,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns a cursor to information about the matching gridfs files.
|
||||
Returns a cursor to information about the matching gridfs files.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -56,7 +56,7 @@
|
|||
<example>
|
||||
<title><function>mongo_gridfs_list</function> example</title>
|
||||
<para>
|
||||
This example shows how to list the files in a grid collection.
|
||||
This example shows how to list the files in a grid collection.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-gridfs-store" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Store a file in the database.
|
||||
Store a file in the database.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
<term><parameter>filename</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the file to store.
|
||||
Name of the file to store.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -46,7 +46,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The MongoId given to the file saved to the database.
|
||||
The MongoId given to the file saved to the database.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-has-next" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
If there is another document to return.
|
||||
If there is another document to return.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -47,8 +47,8 @@
|
|||
<example>
|
||||
<title><function>mongo_has_next</function> example</title>
|
||||
<para>
|
||||
This example shows how mongo_has_next can be used to
|
||||
iterate through results.
|
||||
This example shows how mongo_has_next can be used to
|
||||
iterate through results.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-insert" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -16,7 +16,7 @@
|
|||
<methodparam><type>array</type><parameter>query</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Inserts an array into a database collection.
|
||||
Inserts an array into a database collection.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -44,7 +44,7 @@
|
|||
<term><parameter>obj</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The array to insert.
|
||||
The array to insert.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -55,7 +55,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Whether the item was successfully inserted or not.
|
||||
Whether the item was successfully inserted or not.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -65,7 +65,7 @@
|
|||
<example>
|
||||
<title><function>mongo_insert</function> example</title>
|
||||
<para>
|
||||
This example shows how to insert an array into a database collection.
|
||||
This example shows how to insert an array into a database collection.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-next" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -14,39 +14,39 @@
|
|||
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Fetches the next document returned by a query.
|
||||
Fetches the next document returned by a query.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>cursor</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The cursor to use.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>cursor</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The cursor to use.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The next document.
|
||||
The next document.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
Creates an error if there are no more documents.
|
||||
Creates an error if there are no more documents.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -56,9 +56,9 @@
|
|||
<example>
|
||||
<title><function>mongo_next</function> example</title>
|
||||
<para>
|
||||
This example uses mongo_has_next and mongo_next to
|
||||
iterate through query results and storing them in
|
||||
an array.
|
||||
This example uses mongo_has_next and mongo_next to
|
||||
iterate through query results and storing them in
|
||||
an array.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-query" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -21,11 +21,11 @@
|
|||
<methodparam><type>array</type><parameter>hint</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Performs a database query, returning a database cursor that
|
||||
can be passed to mongo_has_next or mongo_next. It is highly
|
||||
suggested that users use MongoCollection's find() function
|
||||
instead, as it is basically a wrapper for this function that
|
||||
handles of the extensive parameter list for the user.
|
||||
Performs a database query, returning a database cursor that
|
||||
can be passed to mongo_has_next or mongo_next. It is highly
|
||||
suggested that users use MongoCollection's find() function
|
||||
instead, as it is basically a wrapper for this function that
|
||||
handles of the extensive parameter list for the user.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -53,7 +53,7 @@
|
|||
<term><parameter>query</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The query to execute.
|
||||
The query to execute.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -61,7 +61,7 @@
|
|||
<term><parameter>skip</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The number of documents to skip.
|
||||
The number of documents to skip.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -69,7 +69,7 @@
|
|||
<term><parameter>limit</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The maximum number of documents to return.
|
||||
The maximum number of documents to return.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -77,7 +77,7 @@
|
|||
<term><parameter>sort</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An array of fields and directions on which to sort.
|
||||
An array of fields and directions on which to sort.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -85,7 +85,7 @@
|
|||
<term><parameter>fields</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An array of the fields of each document to return.
|
||||
An array of the fields of each document to return.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -93,7 +93,7 @@
|
|||
<term><parameter>hint</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An array giving the database a query hint.
|
||||
An array giving the database a query hint.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -104,7 +104,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns a cursor to the resulting documents.
|
||||
Returns a cursor to the resulting documents.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -114,8 +114,8 @@
|
|||
<example>
|
||||
<title><function>mongo_query</function> example</title>
|
||||
<para>
|
||||
This example shows how to use a query to get a page of
|
||||
search results from the database.
|
||||
This example shows how to use a query to get a page of
|
||||
search results from the database.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-remove" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -17,7 +17,7 @@
|
|||
<methodparam><type>bool</type><parameter>justOne</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Removes objects from a database collection based on criteria.
|
||||
Removes objects from a database collection based on criteria.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -45,7 +45,7 @@
|
|||
<term><parameter>query</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Array of criteria for objects to remove.
|
||||
Array of criteria for objects to remove.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -53,7 +53,7 @@
|
|||
<term><parameter>justOne</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If only one object matching the criteria should be removed.
|
||||
If only one object matching the criteria should be removed.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -64,7 +64,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
If the remove was successful.
|
||||
If the remove was successful.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -74,8 +74,8 @@
|
|||
<example>
|
||||
<title><function>mongo_remove</function> example</title>
|
||||
<para>
|
||||
In this example, all users named Doug are deleted from
|
||||
the users collection of the www database.
|
||||
In this example, all users named Doug are deleted from
|
||||
the users collection of the www database.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<refentry xml:id="function.mongo-update" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
|
|
@ -18,9 +18,9 @@
|
|||
<methodparam><type>bool</type><parameter>upsert</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Removes matching objects, changes them to match a new object form, and
|
||||
resaves them to the database. If there are no matching objects and
|
||||
upsert is set, the new object will be inserted into the database.
|
||||
Removes matching objects, changes them to match a new object form, and
|
||||
resaves them to the database. If there are no matching objects and
|
||||
upsert is set, the new object will be inserted into the database.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -48,7 +48,7 @@
|
|||
<term><parameter>query</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The object for which to query.
|
||||
The object for which to query.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -56,7 +56,7 @@
|
|||
<term><parameter>newobj</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The object to replace matches with.
|
||||
The object to replace matches with.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -64,8 +64,8 @@
|
|||
<term><parameter>upsert</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Whether to insert newobj into the collection
|
||||
if no objects are returned by the query.
|
||||
Whether to insert newobj into the collection
|
||||
if no objects are returned by the query.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -76,7 +76,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
If the update was successful.
|
||||
If the update was successful.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -93,7 +93,7 @@
|
|||
<example>
|
||||
<title><function>mongo_update</function> example</title>
|
||||
<para>
|
||||
This example shows how to update an existing object.
|
||||
This example shows how to update an existing object.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
|
|||
Loading…
Reference in a new issue