Commit graph

570 commits

Author SHA1 Message Date
Jeremy Mikola
2260593b82 Reword docs on read preference inheritance among MongoDB classes
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335762 c90b9560-bf6c-de11-be94-00142212c4b1
2015-01-15 21:54:39 +00:00
Jeremy Mikola
9de4d8fb3e Document MongoCommandCursor read preference methods
https://jira.mongodb.org/browse/PHP-1370


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335761 c90b9560-bf6c-de11-be94-00142212c4b1
2015-01-15 21:34:50 +00:00
Jeremy Mikola
9f0e1e36a3 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
2015-01-15 21:10:35 +00:00
Jeremy Mikola
96ac68c599 Fix example output for MongoCollection::getIndexInfo()
The previous output looked nothing like var_dump(). The indexes are are comparable to those in the previous example, although there are some additional fields and I changed the geo-spatial index to "2dsphere".


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335757 c90b9560-bf6c-de11-be94-00142212c4b1
2015-01-15 16:24:54 +00:00
Jeremy Mikola
2fba051b83 Update example output for MongoDB::getCollectionInfo()
This returns a numerically indexed array and collection names do not include the namespace prefix.

https://jira.mongodb.org/browse/PHP-1376
https://jira.mongodb.org/browse/PHP-1378


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335756 c90b9560-bf6c-de11-be94-00142212c4b1
2015-01-15 16:22:40 +00:00
Jeremy Mikola
54cf5f9e3f Revise docs for MongoDB collection enumeration methods
These methods now take an options array in 1.6+. Additionally, this fixes the description of getCollectionInfo().

https://jira.mongodb.org/browse/PHP-1318


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335744 c90b9560-bf6c-de11-be94-00142212c4b1
2015-01-14 15:29:05 +00:00
Jeremy Mikola
fda62fbc6e Remove full text search example from MongoDB::command() docs
This example is obsolete. The text command was experimental in 2.4 and deprecated in favor of the $text query operator in 2.6.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335738 c90b9560-bf6c-de11-be94-00142212c4b1
2015-01-13 21:00:46 +00:00
Jeremy Mikola
da1b439fc9 Document MongoDB::command() $hash by-reference parameter
https://jira.mongodb.org/browse/PHP-1330


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335737 c90b9560-bf6c-de11-be94-00142212c4b1
2015-01-13 20:58:06 +00:00
Jeremy Mikola
ed3172ce5d Specify "seconds since the epoch" in MongoDB type docs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335736 c90b9560-bf6c-de11-be94-00142212c4b1
2015-01-13 20:25:00 +00:00
Jeremy Mikola
40d18f45d5 Clarify that MongoTimestamp is for internal use only
We'll leave Kristina's Monopoly reference in place for historical reasons.

https://jira.mongodb.org/browse/PHP-1374


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335735 c90b9560-bf6c-de11-be94-00142212c4b1
2015-01-13 20:17:41 +00:00
Jeremy Mikola
3382aa19c7 Fix typo in MongoMaxKey documentation
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335734 c90b9560-bf6c-de11-be94-00142212c4b1
2015-01-13 19:20:33 +00:00
Jeremy Mikola
58374fa210 Clarify that MongoMaxKey/MongoMinKey are primarily for internal use
This also revises some language in the usage examplex for both classes.

https://jira.mongodb.org/browse/PHP-1375


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335733 c90b9560-bf6c-de11-be94-00142212c4b1
2015-01-13 19:18:31 +00:00
Jeremy Mikola
9eeba8cb28 Update docs for MongoCursor interator methods
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335444 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-28 22:05:21 +00:00
Jeremy Mikola
eecf0808f0 Revise formatting and example for MongoCommandCursor::timeout()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335443 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-28 21:57:51 +00:00
Jeremy Mikola
63b0d9a05f Revise docs and examples for creating MongoCommandCursors
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335442 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-28 21:56:56 +00:00
Jeremy Mikola
78b7d262be Revise docs for MongoCursor::dead()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335441 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-28 21:55:05 +00:00
Jeremy Mikola
a7f59b4761 Revise docs and examples for MongoCursor::info()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335440 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-28 21:54:15 +00:00
Jeremy Mikola
e39cacd755 Fix capitalization in MongoDB::command() links
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335348 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-23 21:46:07 +00:00
Jeremy Mikola
fdf29338d6 Revise MongoCommandCursor class documentation
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335347 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-23 21:44:31 +00:00
Jeremy Mikola
4688808f52 Fix grammar in MongoCommandCursor::timeout() docs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335346 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-23 21:34:42 +00:00
Jeremy Mikola
a9502d1ec1 Clarify language in MongoCursor batchSize docs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335345 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-23 21:09:33 +00:00
Derick Rethans
87344fb9db Document MongoDB::getCollectionInfo.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335314 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-19 15:53:55 +00:00
Peter Cowburn
329f9b41ef svn keywords and eol-style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335313 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-19 15:46:28 +00:00
Derick Rethans
7e47cadc79 Sort this better, and put the magic methods first.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335312 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-19 15:34:12 +00:00
Derick Rethans
f48b8dec36 Document MongoCommandCursor::timeout.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335311 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-19 15:26:14 +00:00
Derick Rethans
8d1e2309b7 Add example to MongoCommandCursor::construct and added see-alsos.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335300 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-16 11:18:20 +00:00
Jeremy Mikola
ee509342bd Fix typo and dump formatting in MongoCommandCursor::createFromDocument()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335258 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-09 23:08:13 +00:00
Jeremy Mikola
ed20cf8bb5 Correct signature for MongoCommandCursor::createFromDocument()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335257 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-09 21:02:55 +00:00
Derick Rethans
7619681d4b Document return type of next(), and document getNext() as an alias of next().
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335247 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-05 16:42:09 +00:00
Jeremy Mikola
6c668086fa Fix discrepancy in MongoCollection::insert() changelog
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335239 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-02 18:28:01 +00:00
Jeremy Mikola
bdedce75e7 MongoCollection::save() never accepted non-array $options
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335238 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-02 18:24:10 +00:00
Jeremy Mikola
9e3918a89b Rename parameter for MongoCollection insert/save methods
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335237 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-02 18:19:58 +00:00
Tjerk Anne Meesters
60e8e031cf Fixed error in reference link
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335215 c90b9560-bf6c-de11-be94-00142212c4b1
2014-11-25 23:25:24 +00:00
Derick Rethans
054dd025b7 Clarify here as well that we pass the options straight to the server.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335213 c90b9560-bf6c-de11-be94-00142212c4b1
2014-11-25 10:25:23 +00:00
Derick Rethans
9e364cb1a9 Fixed docs to say we pass in all raw options to the server.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335212 c90b9560-bf6c-de11-be94-00142212c4b1
2014-11-25 10:22:02 +00:00
Derick Rethans
0f4ab917eb Added docs for MongoDate::toDateTime.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335192 c90b9560-bf6c-de11-be94-00142212c4b1
2014-11-18 11:06:14 +00:00
Jeremy Mikola
13445ae645 Revise MongoWriteBatch::add() parameter docs
Rewrote argument descriptions and cross-referenced relevant update() and remove() parameters/options. Also clarified valid "limit" values for delete operations.

https://jira.mongodb.org/browse/PHP-1126


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335169 c90b9560-bf6c-de11-be94-00142212c4b1
2014-11-07 19:51:28 +00:00
Jeremy Mikola
a5492acb76 Fix descriptions of MongoWriteBatch methods
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335168 c90b9560-bf6c-de11-be94-00142212c4b1
2014-11-07 19:47:27 +00:00
Jeremy Mikola
dbdc52230d MongoCollection::count() now takes an $options array
https://jira.mongodb.org/browse/PHP-1160
https://jira.mongodb.org/browse/PHP-1263


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335161 c90b9560-bf6c-de11-be94-00142212c4b1
2014-11-05 21:15:09 +00:00
Jeremy Mikola
95f7837cdc MongoDB 2.8+ no longer supports "dropDups" index creation option
https://jira.mongodb.org/browse/PHP-1205


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335079 c90b9560-bf6c-de11-be94-00142212c4b1
2014-10-17 21:50:32 +00:00
Jeremy Mikola
22f2853d0b Make MongoCollection::save() 1.5 changelog consistent
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334972 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-23 15:36:42 +00:00
Jeremy Mikola
0e0f965045 Document socketTimeoutMS for MongoDB::command()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334971 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-23 15:33:02 +00:00
Richard Quadling
cb2e7b70b1 svn:keywords, svn:eol-style, svn:ignore all set appropriately.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334955 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-23 12:08:23 +00:00
Derick Rethans
5da46a59d6 Integrate note for nicer formatting.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334841 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-11 11:53:57 +00:00
Derick Rethans
6133457550 Changed example to be non-destructive.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334840 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-11 11:50:19 +00:00
Jeremy Mikola
6652e50b56 Note libsasl.dll dependency on Windows for MongoDB driver
https://jira.mongodb.org/browse/PHP-1159


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334827 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-09 18:41:17 +00:00
Jeremy Mikola
565e478d69 Fix <programlisting> formatting in MongoDB docs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334826 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-09 18:31:20 +00:00
Jeremy Mikola
ad82d24105 Clarify that differing MongoDB seed list connections are persisted
https://jira.mongodb.org/browse/PHP-1216


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334825 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-09 18:16:10 +00:00
Simion Onea
14af302c9c Making the XML definition consistent across the entire project.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334762 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-05 07:44:07 +00:00
Derick Rethans
61fa6fb092 PHP-1214: Added the addOption( '$comment', … ) example.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334691 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-01 15:01:16 +00:00