From 9f0e1e36a3eeac3652b724a834dbf241a8c90527 Mon Sep 17 00:00:00 2001 From: Jeremy Mikola Date: Thu, 15 Jan 2015 21:10:35 +0000 Subject: [PATCH] Documentation for MongoCursorInterface This interface extends Iterator and is implemented internally by MongoCursor and MongoCommandCursor. In addition to the interface methods, "see also" links were added on the implemented methods to point back to the interface documentation (as we did for Iterator methods). https://jira.mongodb.org/browse/PHP-1328 git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335760 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/mongo/changelog.xml | 2 +- reference/mongo/core.xml | 1 + reference/mongo/mongocommandcursor.xml | 4 +- .../mongo/mongocommandcursor/batchsize.xml | 6 ++ reference/mongo/mongocommandcursor/dead.xml | 7 ++ reference/mongo/mongocommandcursor/info.xml | 6 ++ .../mongo/mongocommandcursor/timeout.xml | 1 + reference/mongo/mongocursor.xml | 3 + reference/mongo/mongocursor/batchsize.xml | 1 + reference/mongo/mongocursor/dead.xml | 7 ++ .../mongo/mongocursor/getreadpreference.xml | 1 + reference/mongo/mongocursor/info.xml | 6 ++ .../mongo/mongocursor/setreadpreference.xml | 1 + reference/mongo/mongocursor/timeout.xml | 1 + reference/mongo/mongocursorinterface.xml | 83 ++++++++++++++++++ .../mongo/mongocursorinterface/batchsize.xml | 68 +++++++++++++++ reference/mongo/mongocursorinterface/dead.xml | 56 +++++++++++++ .../getreadpreference.xml | 56 +++++++++++++ reference/mongo/mongocursorinterface/info.xml | 56 +++++++++++++ .../setreadpreference.xml | 64 ++++++++++++++ .../mongo/mongocursorinterface/timeout.xml | 84 +++++++++++++++++++ reference/mongo/versions.xml | 9 ++ 22 files changed, 520 insertions(+), 3 deletions(-) create mode 100644 reference/mongo/mongocursorinterface.xml create mode 100644 reference/mongo/mongocursorinterface/batchsize.xml create mode 100644 reference/mongo/mongocursorinterface/dead.xml create mode 100644 reference/mongo/mongocursorinterface/getreadpreference.xml create mode 100644 reference/mongo/mongocursorinterface/info.xml create mode 100644 reference/mongo/mongocursorinterface/setreadpreference.xml create mode 100644 reference/mongo/mongocursorinterface/timeout.xml diff --git a/reference/mongo/changelog.xml b/reference/mongo/changelog.xml index dbd2bcd580..b44b1cb60b 100644 --- a/reference/mongo/changelog.xml +++ b/reference/mongo/changelog.xml @@ -96,7 +96,7 @@ Following is a list of all improvements to existing methods since their inception. - + diff --git a/reference/mongo/core.xml b/reference/mongo/core.xml index 3e44f46f24..449f0e9d78 100644 --- a/reference/mongo/core.xml +++ b/reference/mongo/core.xml @@ -14,6 +14,7 @@ &reference.mongo.mongodb; &reference.mongo.mongocollection; &reference.mongo.mongocursor; + &reference.mongo.mongocursorinterface; &reference.mongo.mongocommandcursor; diff --git a/reference/mongo/mongocommandcursor.xml b/reference/mongo/mongocommandcursor.xml index fd5114edc7..34f6000fe5 100644 --- a/reference/mongo/mongocommandcursor.xml +++ b/reference/mongo/mongocommandcursor.xml @@ -81,10 +81,10 @@ foreach ($cursor as $result) { MongoCommandCursor - Iterator + MongoCursorInterface - MongoCursorInterface + Iterator diff --git a/reference/mongo/mongocommandcursor/batchsize.xml b/reference/mongo/mongocommandcursor/batchsize.xml index 86bfeacbb3..b1f985cac5 100644 --- a/reference/mongo/mongocommandcursor/batchsize.xml +++ b/reference/mongo/mongocommandcursor/batchsize.xml @@ -65,6 +65,12 @@ $commandCursor->batchSize(20); + + &reftitle.seealso; + + MongoCursorInterface::batchSize + + + + + The MongoCursorInterface interface + MongoCursorInterface + + + + +
+ &reftitle.intro; + + Interface for cursors, which can be used to iterate through results of a + database query or command. This interface is implemented by the + MongoCursor and + MongoCommandCursor classes. + + + + Similar to Traversable, this interface cannot be + implemented in PHP scripts. + + +
+ + +
+ &reftitle.classsynopsis; + + + + MongoCursorInterface + + + + + MongoCursorInterface + + + + extends + Iterator + + + + + &Methods; + + + &InheritedMethods; + + + +
+ +
+ + &reference.mongo.entities.mongocursorinterface; + +
+ + diff --git a/reference/mongo/mongocursorinterface/batchsize.xml b/reference/mongo/mongocursorinterface/batchsize.xml new file mode 100644 index 0000000000..c81ac8bafe --- /dev/null +++ b/reference/mongo/mongocursorinterface/batchsize.xml @@ -0,0 +1,68 @@ + + + + + + MongoCursorInterface::batchSize + Limits the number of elements returned in one batch. + + + + &reftitle.description; + + abstract public MongoCursorInterfaceMongoCursorInterface::batchSize + intbatchSize + + + A cursor typically fetches a batch of result objects and stores them + locally. This method sets the batch size value to configure the amount of + documents retrieved from the server in one round trip. + + + + + &reftitle.parameters; + + + + + batchSize + + + + The number of results to return per batch. + + + + + + + + + &reftitle.returnvalues; + + Returns this cursor. + + + + + diff --git a/reference/mongo/mongocursorinterface/dead.xml b/reference/mongo/mongocursorinterface/dead.xml new file mode 100644 index 0000000000..719a7e472e --- /dev/null +++ b/reference/mongo/mongocursorinterface/dead.xml @@ -0,0 +1,56 @@ + + + + + + MongoCursorInterface::dead + Checks if there are results that have not yet been sent from the database + + + + &reftitle.description; + + abstract public boolMongoCursorInterface::dead + + + + This method checks whether the cursor has been exhausted and the database has + no more results to send to the client. A cursor being "dead" does not + necessarily mean that there are no more results available for iteration. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns &true; if there are more results that have not yet been sent to the + client, and &false; otherwise. + + + + + diff --git a/reference/mongo/mongocursorinterface/getreadpreference.xml b/reference/mongo/mongocursorinterface/getreadpreference.xml new file mode 100644 index 0000000000..4ebc6d3376 --- /dev/null +++ b/reference/mongo/mongocursorinterface/getreadpreference.xml @@ -0,0 +1,56 @@ + + + + + + MongoCursorInterface::getReadPreference + Get the read preference for this query + + + + &reftitle.description; + + abstract public arrayMongoCursorInterface::getReadPreference + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + &mongo.getreadpreference.returnvalues; + + + + &reftitle.seealso; + + The read preferences documentation. + MongoCursorInterface::setReadPreference + + + + + diff --git a/reference/mongo/mongocursorinterface/info.xml b/reference/mongo/mongocursorinterface/info.xml new file mode 100644 index 0000000000..a9270cfdee --- /dev/null +++ b/reference/mongo/mongocursorinterface/info.xml @@ -0,0 +1,56 @@ + + + + + + MongoCursorInterface::info + Gets information about the cursor's creation and iteration + + + + &reftitle.description; + + abstract public arrayMongoCursorInterface::info + + + + Returns information about the cursor's creation and iteration. This can be + called before or after the cursor has started iterating. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the namespace, batch size, limit, skip, flags, query, and projected + fields for this cursor. If the cursor has started iterating, additional + information about iteration and the connection will be included. + + + + + diff --git a/reference/mongo/mongocursorinterface/setreadpreference.xml b/reference/mongo/mongocursorinterface/setreadpreference.xml new file mode 100644 index 0000000000..6b4a7203e8 --- /dev/null +++ b/reference/mongo/mongocursorinterface/setreadpreference.xml @@ -0,0 +1,64 @@ + + + + + + MongoCursorInterface::setReadPreference + Set the read preference for this query + + + + &reftitle.description; + + abstract public MongoCursorInterfaceMongoCursorInterface::setReadPreference + stringread_preference + arraytags + + + + + &reftitle.parameters; + &mongo.setreadpreference.parameters; + + + + &reftitle.returnvalues; + + Returns this cursor. + + + + + &reftitle.errors; + &mongo.setreadpreference.errors; + + + + &reftitle.seealso; + + The read preferences documentation. + MongoCursorInterface::getReadPreference + + + + + diff --git a/reference/mongo/mongocursorinterface/timeout.xml b/reference/mongo/mongocursorinterface/timeout.xml new file mode 100644 index 0000000000..8784c1138d --- /dev/null +++ b/reference/mongo/mongocursorinterface/timeout.xml @@ -0,0 +1,84 @@ + + + + + + MongoCursorInterface::timeout + Sets a client-side timeout for this query + + + + &reftitle.description; + + abstract public MongoCursorInterfaceMongoCursorInterface::timeout + intms + + + A timeout can be set at any time and will affect subsequent data retrieval + associated with this cursor, including fetching more results from the + database. + + + + + &reftitle.parameters; + + + + ms + + + + The number of milliseconds for the cursor to wait for a response. Use + -1 to wait forever. By default, the cursor will wait + 30000 milliseconds (30 seconds). + + + + + + + + &reftitle.returnvalues; + + Returns this cursor. + + + + + &reftitle.errors; + + Causes methods that fetch results to throw a + MongoCursorTimeoutException if the data fetch takes + longer than the specified number of milliseconds. + + + + + &reftitle.seealso; + + The socketTimeoutMS option for MongoClient::__construct + + + + + diff --git a/reference/mongo/versions.xml b/reference/mongo/versions.xml index 8292f5a02c..a6b2d82891 100644 --- a/reference/mongo/versions.xml +++ b/reference/mongo/versions.xml @@ -143,6 +143,15 @@ + + + + + + + + +