From 1ac4d898229d2f9345f2833b579391bb84188fa1 Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Wed, 25 Feb 2009 22:50:52 +0000 Subject: [PATCH] Whitespace and removed leftover from docgen git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@276456 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/mongo/functions/mongo-close.xml | 5 +- reference/mongo/functions/mongo-connect.xml | 58 +++++++++---------- reference/mongo/functions/mongo-find-one.xml | 16 ++--- .../mongo/functions/mongo-gridchunk-data.xml | 28 ++++----- .../mongo/functions/mongo-gridchunk-get.xml | 51 ++++++++-------- .../mongo/functions/mongo-gridchunk-size.xml | 6 +- .../functions/mongo-gridfile-chunk-num.xml | 6 +- .../functions/mongo-gridfile-chunk-size.xml | 6 +- .../mongo/functions/mongo-gridfile-exists.xml | 6 +- .../functions/mongo-gridfile-filename.xml | 6 +- .../mongo/functions/mongo-gridfile-size.xml | 6 +- .../mongo/functions/mongo-gridfile-write.xml | 12 ++-- .../mongo/functions/mongo-gridfs-find.xml | 7 +-- .../mongo/functions/mongo-gridfs-init.xml | 10 ++-- .../mongo/functions/mongo-gridfs-list.xml | 6 +- .../mongo/functions/mongo-gridfs-store.xml | 8 +-- reference/mongo/functions/mongo-has-next.xml | 8 +-- reference/mongo/functions/mongo-insert.xml | 10 ++-- reference/mongo/functions/mongo-next.xml | 44 +++++++------- reference/mongo/functions/mongo-query.xml | 30 +++++----- reference/mongo/functions/mongo-remove.xml | 14 ++--- reference/mongo/functions/mongo-update.xml | 20 +++---- 22 files changed, 180 insertions(+), 183 deletions(-) diff --git a/reference/mongo/functions/mongo-close.xml b/reference/mongo/functions/mongo-close.xml index df68efe490..70774ee25a 100644 --- a/reference/mongo/functions/mongo-close.xml +++ b/reference/mongo/functions/mongo-close.xml @@ -1,5 +1,5 @@ - + @@ -36,9 +36,8 @@ &reftitle.returnvalues; - - &return.success; + &return.success; diff --git a/reference/mongo/functions/mongo-connect.xml b/reference/mongo/functions/mongo-connect.xml index b64ea2f89c..858e3c506d 100644 --- a/reference/mongo/functions/mongo-connect.xml +++ b/reference/mongo/functions/mongo-connect.xml @@ -1,5 +1,5 @@ - + @@ -22,44 +22,44 @@ &reftitle.parameters; - - - - host - - - - Address of the database to which to connect. - - - - - - auto_reconnect - - - - If the driver should attempt to reconnect if - the database connection is lost. - - - - + + + + host + + + + Address of the database to which to connect. + + + + + + auto_reconnect + + + + If the driver should attempt to reconnect if + the database connection is lost. + + + + - If able to connect, the connection resource is returned. - Otherwise, false. + If able to connect, the connection resource is returned. + Otherwise, false. &reftitle.errors; - 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. @@ -69,7 +69,7 @@ <function>mongo_connect</function> example - To connect to a Mongo database running locally on the default port: + To connect to a Mongo database running locally on the default port: - + @@ -16,7 +16,7 @@ arrayquery - 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. @@ -44,7 +44,7 @@ query - An array representing the desired results. + An array representing the desired results. @@ -55,7 +55,7 @@ &reftitle.returnvalues; - 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. @@ -65,8 +65,8 @@ <function>mongo_find_one</function> example - 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". <function>mongo_find_one</function> example - 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. - + @@ -14,25 +14,25 @@ resourcechunk - Returns the contents of a chunk. + Returns the contents of a chunk. &reftitle.parameters; - - - - chunk - - - - The chunk from which to fetch data. - - - - + + + + chunk + + + + The chunk from which to fetch data. + + + + diff --git a/reference/mongo/functions/mongo-gridchunk-get.xml b/reference/mongo/functions/mongo-gridchunk-get.xml index 5474059287..78a708fbd9 100644 --- a/reference/mongo/functions/mongo-gridchunk-get.xml +++ b/reference/mongo/functions/mongo-gridchunk-get.xml @@ -1,5 +1,5 @@ - + @@ -15,43 +15,42 @@ intnum - Return a chunk of a given file. + Return a chunk of a given file. &reftitle.parameters; - - - - file - - - - The file from which to fetch the chunk. - - - - - - num - - - - The number of the chunk to fetch. - - - - + + + + file + + + + The file from which to fetch the chunk. + + + + + + num + + + + The number of the chunk to fetch. + + + + &reftitle.returnvalues; - - Returns a Gridfs file chunk. + Returns a Gridfs file chunk. diff --git a/reference/mongo/functions/mongo-gridchunk-size.xml b/reference/mongo/functions/mongo-gridchunk-size.xml index ed0a53e2d5..f11829f2b3 100644 --- a/reference/mongo/functions/mongo-gridchunk-size.xml +++ b/reference/mongo/functions/mongo-gridchunk-size.xml @@ -1,5 +1,5 @@ - + @@ -14,7 +14,7 @@ resourcegridchunk - The size of a given chunk. + The size of a given chunk. @@ -37,7 +37,7 @@ &reftitle.returnvalues; - Returns the size of a chunk. + Returns the size of a chunk. diff --git a/reference/mongo/functions/mongo-gridfile-chunk-num.xml b/reference/mongo/functions/mongo-gridfile-chunk-num.xml index 840de90134..807db18d1d 100644 --- a/reference/mongo/functions/mongo-gridfile-chunk-num.xml +++ b/reference/mongo/functions/mongo-gridfile-chunk-num.xml @@ -1,5 +1,5 @@ - + @@ -14,7 +14,7 @@ resourcegridfile - Returns the number of chunks a file is composed of. + Returns the number of chunks a file is composed of. @@ -37,7 +37,7 @@ &reftitle.returnvalues; - Returns the number of chunks. + Returns the number of chunks. diff --git a/reference/mongo/functions/mongo-gridfile-chunk-size.xml b/reference/mongo/functions/mongo-gridfile-chunk-size.xml index 6da5eb97d0..8b9d6caeeb 100644 --- a/reference/mongo/functions/mongo-gridfile-chunk-size.xml +++ b/reference/mongo/functions/mongo-gridfile-chunk-size.xml @@ -1,5 +1,5 @@ - + @@ -14,7 +14,7 @@ resourcegridfile - Finds the size of chunks used by a grid file. + Finds the size of chunks used by a grid file. @@ -37,7 +37,7 @@ &reftitle.returnvalues; - Returns the size of the chunks in this file. + Returns the size of the chunks in this file. diff --git a/reference/mongo/functions/mongo-gridfile-exists.xml b/reference/mongo/functions/mongo-gridfile-exists.xml index af72b08be6..8a311433c4 100644 --- a/reference/mongo/functions/mongo-gridfile-exists.xml +++ b/reference/mongo/functions/mongo-gridfile-exists.xml @@ -1,5 +1,5 @@ - + @@ -14,7 +14,7 @@ resourcegridfile - Checks if a gridfile exists. + Checks if a gridfile exists. @@ -37,7 +37,7 @@ &reftitle.returnvalues; - Returns if the grid file exists. + Returns if the grid file exists. diff --git a/reference/mongo/functions/mongo-gridfile-filename.xml b/reference/mongo/functions/mongo-gridfile-filename.xml index 04d8529357..26dc46ac2a 100644 --- a/reference/mongo/functions/mongo-gridfile-filename.xml +++ b/reference/mongo/functions/mongo-gridfile-filename.xml @@ -1,5 +1,5 @@ - + @@ -14,7 +14,7 @@ resourcegridfile - Returns the name of a grid file. + Returns the name of a grid file. @@ -37,7 +37,7 @@ &reftitle.returnvalues; - Returns the filename. + Returns the filename. diff --git a/reference/mongo/functions/mongo-gridfile-size.xml b/reference/mongo/functions/mongo-gridfile-size.xml index 5973b7b10e..5847b8d841 100644 --- a/reference/mongo/functions/mongo-gridfile-size.xml +++ b/reference/mongo/functions/mongo-gridfile-size.xml @@ -1,5 +1,5 @@ - + @@ -14,7 +14,7 @@ resourcegridfile - Returns the size of a grid file. + Returns the size of a grid file. @@ -37,7 +37,7 @@ &reftitle.returnvalues; - Returns the size of the file. + Returns the size of the file. diff --git a/reference/mongo/functions/mongo-gridfile-write.xml b/reference/mongo/functions/mongo-gridfile-write.xml index 50829730f9..b43734e23a 100644 --- a/reference/mongo/functions/mongo-gridfile-write.xml +++ b/reference/mongo/functions/mongo-gridfile-write.xml @@ -1,5 +1,5 @@ - + @@ -15,7 +15,7 @@ stringfilename - Write a file from the database to the local filesystem. + Write a file from the database to the local filesystem. @@ -35,7 +35,7 @@ filename - Name to save the file under. + Name to save the file under. @@ -46,7 +46,7 @@ &reftitle.returnvalues; - Returns the number of bytes written. + Returns the number of bytes written. @@ -56,8 +56,8 @@ <function>mongo_gridfile_write</function> example - 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. - + @@ -15,7 +15,7 @@ arrayquery - Find a file in the database. + Find a file in the database. @@ -45,9 +45,8 @@ &reftitle.returnvalues; - - A grid file. + A grid file. diff --git a/reference/mongo/functions/mongo-gridfs-init.xml b/reference/mongo/functions/mongo-gridfs-init.xml index ea33528ce5..57932a5568 100644 --- a/reference/mongo/functions/mongo-gridfs-init.xml +++ b/reference/mongo/functions/mongo-gridfs-init.xml @@ -1,5 +1,5 @@ - + @@ -16,7 +16,7 @@ stringprefix - 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. @@ -55,7 +55,7 @@ &reftitle.returnvalues; - A connection to the grid filesystem. + A connection to the grid filesystem. @@ -65,8 +65,8 @@ <function>mongo_gridfs_init</function> example - 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. - + @@ -46,7 +46,7 @@ &reftitle.returnvalues; - Returns a cursor to information about the matching gridfs files. + Returns a cursor to information about the matching gridfs files. @@ -56,7 +56,7 @@ <function>mongo_gridfs_list</function> example - This example shows how to list the files in a grid collection. + This example shows how to list the files in a grid collection. - + @@ -15,7 +15,7 @@ stringfilename - Store a file in the database. + Store a file in the database. @@ -35,7 +35,7 @@ filename - Name of the file to store. + Name of the file to store. @@ -46,7 +46,7 @@ &reftitle.returnvalues; - The MongoId given to the file saved to the database. + The MongoId given to the file saved to the database. diff --git a/reference/mongo/functions/mongo-has-next.xml b/reference/mongo/functions/mongo-has-next.xml index 973c01e913..c539a2ad35 100644 --- a/reference/mongo/functions/mongo-has-next.xml +++ b/reference/mongo/functions/mongo-has-next.xml @@ -1,5 +1,5 @@ - + @@ -37,7 +37,7 @@ &reftitle.returnvalues; - If there is another document to return. + If there is another document to return. @@ -47,8 +47,8 @@ <function>mongo_has_next</function> example - 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. - + @@ -16,7 +16,7 @@ arrayquery - Inserts an array into a database collection. + Inserts an array into a database collection. @@ -44,7 +44,7 @@ obj - The array to insert. + The array to insert. @@ -55,7 +55,7 @@ &reftitle.returnvalues; - Whether the item was successfully inserted or not. + Whether the item was successfully inserted or not. @@ -65,7 +65,7 @@ <function>mongo_insert</function> example - This example shows how to insert an array into a database collection. + This example shows how to insert an array into a database collection. - + @@ -14,39 +14,39 @@ resourcecursor - Fetches the next document returned by a query. + Fetches the next document returned by a query. - &reftitle.parameters; - - - - - cursor - - - - The cursor to use. - - - - - + &reftitle.parameters; + + + + + cursor + + + + The cursor to use. + + + + + &reftitle.returnvalues; - The next document. + The next document. &reftitle.errors; - Creates an error if there are no more documents. + Creates an error if there are no more documents. @@ -56,9 +56,9 @@ <function>mongo_next</function> example - 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. - + @@ -21,11 +21,11 @@ arrayhint - 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. @@ -53,7 +53,7 @@ query - The query to execute. + The query to execute. @@ -61,7 +61,7 @@ skip - The number of documents to skip. + The number of documents to skip. @@ -69,7 +69,7 @@ limit - The maximum number of documents to return. + The maximum number of documents to return. @@ -77,7 +77,7 @@ sort - An array of fields and directions on which to sort. + An array of fields and directions on which to sort. @@ -85,7 +85,7 @@ fields - An array of the fields of each document to return. + An array of the fields of each document to return. @@ -93,7 +93,7 @@ hint - An array giving the database a query hint. + An array giving the database a query hint. @@ -104,7 +104,7 @@ &reftitle.returnvalues; - Returns a cursor to the resulting documents. + Returns a cursor to the resulting documents. @@ -114,8 +114,8 @@ <function>mongo_query</function> example - 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. - + @@ -17,7 +17,7 @@ booljustOne - Removes objects from a database collection based on criteria. + Removes objects from a database collection based on criteria. @@ -45,7 +45,7 @@ query - Array of criteria for objects to remove. + Array of criteria for objects to remove. @@ -53,7 +53,7 @@ justOne - If only one object matching the criteria should be removed. + If only one object matching the criteria should be removed. @@ -64,7 +64,7 @@ &reftitle.returnvalues; - If the remove was successful. + If the remove was successful. @@ -74,8 +74,8 @@ <function>mongo_remove</function> example - 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. - + @@ -18,9 +18,9 @@ boolupsert - 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. @@ -48,7 +48,7 @@ query - The object for which to query. + The object for which to query. @@ -56,7 +56,7 @@ newobj - The object to replace matches with. + The object to replace matches with. @@ -64,8 +64,8 @@ upsert - 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. @@ -76,7 +76,7 @@ &reftitle.returnvalues; - If the update was successful. + If the update was successful. @@ -93,7 +93,7 @@ <function>mongo_update</function> example - This example shows how to update an existing object. + This example shows how to update an existing object.