From 1624dcaf80de955f612559ca0745c31ba80f3a1a Mon Sep 17 00:00:00 2001 From: Hannes Magnusson Date: Fri, 14 Mar 2014 23:49:51 +0000 Subject: [PATCH] Document the MongoWriteBatch constants git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333001 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/mongo/mongowritebatch.xml | 47 +++++++++++++++++++ reference/mongo/mongowritebatch/add.xml | 6 +-- reference/mongo/mongowritebatch/construct.xml | 6 +-- reference/mongo/mongowritebatch/execute.xml | 10 ++-- 4 files changed, 58 insertions(+), 11 deletions(-) diff --git a/reference/mongo/mongowritebatch.xml b/reference/mongo/mongowritebatch.xml index 7cac10e830..23c91b44ea 100644 --- a/reference/mongo/mongowritebatch.xml +++ b/reference/mongo/mongowritebatch.xml @@ -46,12 +46,59 @@ + &Constants; + + const + int + MongoWriteBatch::COMMAND_INSERT + 1 + + + const + int + MongoWriteBatch::COMMAND_UPDATE + 2 + + + const + int + MongoWriteBatch::COMMAND_DELETE + 3 + + &Methods; +
+ MongoWriteBatch types + + + + MongoWriteBatch::COMMAND_INSERT + + Create an Insert Write Batch + + + + + MongoWriteBatch::COMMAND_UPDATE + + Create an Update Write Batch + + + + + MongoWriteBatch::COMMAND_DELETE + + Create an Delete Write Batch + + + + +
diff --git a/reference/mongo/mongowritebatch/add.xml b/reference/mongo/mongowritebatch/add.xml index 05fc33e703..cd1e6b5082 100644 --- a/reference/mongo/mongowritebatch/add.xml +++ b/reference/mongo/mongowritebatch/add.xml @@ -40,18 +40,18 @@ - INSERT + MongoWriteBatch::COMMAND_INSERT The document to add - UPDATE + MongoWriteBatch::COMMAND_UPDATE Raw update operation. Required keys are: array("q" => array("criteria"), "u" => array("new data")) Optionally with the "multi" and "upsert" keys as boolean values - DELETE + MongoWriteBatch::COMMAND_DELETE Raw delete operation. Required keys are: array("q" => array("criteria"), "limit" => 1) diff --git a/reference/mongo/mongowritebatch/construct.xml b/reference/mongo/mongowritebatch/construct.xml index 004d02f592..907b663523 100644 --- a/reference/mongo/mongowritebatch/construct.xml +++ b/reference/mongo/mongowritebatch/construct.xml @@ -39,9 +39,9 @@ One of: - 0 - make an INSERT batch - 1 - make an UPDATE batch - 2 - make a DELETE batch + 0 - make an MongoWriteBatch::COMMAND_INSERT batch + 1 - make an MongoWriteBatch::COMMAND_UPDATE batch + 2 - make a MongoWriteBatch::COMMAND_DELETE batch diff --git a/reference/mongo/mongowritebatch/execute.xml b/reference/mongo/mongowritebatch/execute.xml index e6f4829b44..670c145fe4 100644 --- a/reference/mongo/mongowritebatch/execute.xml +++ b/reference/mongo/mongowritebatch/execute.xml @@ -57,27 +57,27 @@ nInserted Number of inserted documents - INSERT batch + MongoWriteBatch::COMMAND_INSERT batch nMatched Number of documents matching the query criteria - UPDATE batch + MongoWriteBatch::COMMAND_UPDATE batch nModified Number of documents actually needed to be modied - UPDATE batch + MongoWriteBatch::COMMAND_UPDATE batch nUpserted Number of upserted documents - UPDATE batch + MongoWriteBatch::COMMAND_UPDATE batch nRemoved Number of documents removed - DELETE batch + MongoWriteBatch::COMMAND_DELETE batch ok