From 8d5cd349a21b194de870d1a8e097e45af0e5c330 Mon Sep 17 00:00:00 2001 From: Hannes Magnusson Date: Wed, 12 Mar 2014 00:05:44 +0000 Subject: [PATCH] Document rest of the Mongo*Batch classes git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332966 c90b9560-bf6c-de11-be94-00142212c4b1 --- language-snippets.ent | 2 + reference/mongo/mongodeletebatch.xml | 76 +++++++++++++++++++ .../mongo/mongodeletebatch/construct.xml | 66 ++++++++++++++++ reference/mongo/mongoinsertbatch.xml | 76 +++++++++++++++++++ .../mongo/mongoinsertbatch/construct.xml | 66 ++++++++++++++++ reference/mongo/mongoupdatebatch.xml | 76 +++++++++++++++++++ .../mongo/mongoupdatebatch/construct.xml | 66 ++++++++++++++++ reference/mongo/mongowritebatch/construct.xml | 44 +---------- 8 files changed, 430 insertions(+), 42 deletions(-) create mode 100644 reference/mongo/mongodeletebatch.xml create mode 100644 reference/mongo/mongodeletebatch/construct.xml create mode 100644 reference/mongo/mongoinsertbatch.xml create mode 100644 reference/mongo/mongoinsertbatch/construct.xml create mode 100644 reference/mongo/mongoupdatebatch.xml create mode 100644 reference/mongo/mongoupdatebatch/construct.xml diff --git a/language-snippets.ent b/language-snippets.ent index de00ecf760..7a6939b618 100644 --- a/language-snippets.ent +++ b/language-snippets.ent @@ -1747,6 +1747,8 @@ paths Issues E_DEPRECATED warning'> These fields may also overwrite those that would be created automatically by the driver, as described in the MongoDB core documentation for the files collection. Some practical use cases for this behavior would be to specify a custom chunkSize or _id for the file.'> Returns the _id of the saved file document. This will be a generated MongoId unless an _id was explicitly specified in the extra parameter.'> +An array of Write Options.keyvalue meaningw (int|string)WriteConcern valuewtimeout (int)Maximum time to wait for ReplicationorderedDetermins if MongoDB must apply this batch in order (sequentally, one item at a time) or can rearrange it. Defaults to &true;j (bool)Wait for journaling on the primary. This value is discouraged, use WriteConcern insteadfsync (bool)Wait for fsync on the primary. This value is discouraged, use WriteConcern instead'> +The MongoCollection to execute the batch on.Its WriteConcern will be copied and used as default WriteConcernsif none given as $write_options or during MongoWriteBatch::execute.'> A request must be created via radius_create_request before this function can be called.'> diff --git a/reference/mongo/mongodeletebatch.xml b/reference/mongo/mongodeletebatch.xml new file mode 100644 index 0000000000..0603d348f3 --- /dev/null +++ b/reference/mongo/mongodeletebatch.xml @@ -0,0 +1,76 @@ + + + + + + The MongoDeleteBatch class + MongoDeleteBatch + + + + +
+ &reftitle.intro; + + Constructs a batch of DELETE operations. See MongoWriteBatch. + +
+ + +
+ &reftitle.classsynopsis; + + + + MongoDeleteBatch + + + + + MongoDeleteBatch + + + + extends + MongoWriteBatch + + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + + + &reference.mongo.entities.mongodeletebatch; + + + + diff --git a/reference/mongo/mongodeletebatch/construct.xml b/reference/mongo/mongodeletebatch/construct.xml new file mode 100644 index 0000000000..fabddf4e5b --- /dev/null +++ b/reference/mongo/mongodeletebatch/construct.xml @@ -0,0 +1,66 @@ + + + + + + MongoDeleteBatch::__construct + Description + + + + &reftitle.description; + + public MongoDeleteBatch::__construct + MongoCollectioncollection + arraywrite_options + + + Constructs a batch of DELETE operations. See MongoWriteBatch. + + + + + + &reftitle.parameters; + + + collection + &mongo.mongowritebatch.collection.description; + + + write_options + &mongo.mongowritebatch.writeoptions.description; + + + + + + &reftitle.returnvalues; + + A new MongoDeleteBatch. + + + + + + + diff --git a/reference/mongo/mongoinsertbatch.xml b/reference/mongo/mongoinsertbatch.xml new file mode 100644 index 0000000000..80f43e4bfa --- /dev/null +++ b/reference/mongo/mongoinsertbatch.xml @@ -0,0 +1,76 @@ + + + + + + The MongoInsertBatch class + MongoInsertBatch + + + + +
+ &reftitle.intro; + + Constructs a batch of INSERT operations. See MongoWriteBatch. + +
+ + +
+ &reftitle.classsynopsis; + + + + MongoInsertBatch + + + + + MongoInsertBatch + + + + extends + MongoWriteBatch + + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + + + &reference.mongo.entities.mongoinsertbatch; + + + + diff --git a/reference/mongo/mongoinsertbatch/construct.xml b/reference/mongo/mongoinsertbatch/construct.xml new file mode 100644 index 0000000000..589879c7e7 --- /dev/null +++ b/reference/mongo/mongoinsertbatch/construct.xml @@ -0,0 +1,66 @@ + + + + + + MongoInsertBatch::__construct + Description + + + + &reftitle.description; + + public MongoInsertBatch::__construct + MongoCollectioncollection + arraywrite_options + + + Constructs a batch of INSERT operations. See MongoWriteBatch. + + + + + + &reftitle.parameters; + + + collection + &mongo.mongowritebatch.collection.description; + + + write_options + &mongo.mongowritebatch.writeoptions.description; + + + + + + &reftitle.returnvalues; + + A new MongoInsertBatch. + + + + + + + diff --git a/reference/mongo/mongoupdatebatch.xml b/reference/mongo/mongoupdatebatch.xml new file mode 100644 index 0000000000..a550b8dc29 --- /dev/null +++ b/reference/mongo/mongoupdatebatch.xml @@ -0,0 +1,76 @@ + + + + + + The MongoUpdateBatch class + MongoUpdateBatch + + + + +
+ &reftitle.intro; + + Constructs a batch of UPDATE operations. See MongoWriteBatch. + +
+ + +
+ &reftitle.classsynopsis; + + + + MongoUpdateBatch + + + + + MongoUpdateBatch + + + + extends + MongoWriteBatch + + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + + + &reference.mongo.entities.mongoupdatebatch; + + + + diff --git a/reference/mongo/mongoupdatebatch/construct.xml b/reference/mongo/mongoupdatebatch/construct.xml new file mode 100644 index 0000000000..dbf8ad930c --- /dev/null +++ b/reference/mongo/mongoupdatebatch/construct.xml @@ -0,0 +1,66 @@ + + + + + + MongoUpdateBatch::__construct + Description + + + + &reftitle.description; + + public MongoUpdateBatch::__construct + MongoCollectioncollection + arraywrite_options + + + Constructs a batch of UPDATE operations. See MongoWriteBatch. + + + + + + &reftitle.parameters; + + + collection + &mongo.mongowritebatch.collection.description; + + + write_options + &mongo.mongowritebatch.writeoptions.description; + + + + + + &reftitle.returnvalues; + + A new MongoUpdateBatch. + + + + + + + diff --git a/reference/mongo/mongowritebatch/construct.xml b/reference/mongo/mongowritebatch/construct.xml index 68f4fe87b6..a21e12a88b 100644 --- a/reference/mongo/mongowritebatch/construct.xml +++ b/reference/mongo/mongowritebatch/construct.xml @@ -31,13 +31,7 @@ collection - - - The MongoCollection to execute the batch on. - Its WriteConcern will be copied and used as default WriteConcerns - if none given as $write_options or during MongoWriteBatch::execute. - - + &mongo.mongowritebatch.collection.description; batch_type @@ -54,41 +48,7 @@ write_options - - - An array of Write Options. - - - - key - value meaning - - - - - w (int|string) - WriteConcern value - - - wtimeout (int) - Maximum time to wait for Replication - - - ordered - Determins if MongoDB must apply this batch in order (sequentally, one item at a time) or can rearrange it. Defaults to &true; - - - j (bool) - Wait for journaling on the primary. This value is discouraged, use WriteConcern instead - - - fsync (bool) - Wait for fsync on the primary. This value is discouraged, use WriteConcern instead - - - - - + &mongo.mongowritebatch.writeoptions.description;