Merge pull request #391

docs/includes/apiargs-MongoDBCollection-common-option.yaml

@@ -4,6 +4,9 @@ type: boolean
 description: |
    If ``true``, allows the write operation to circumvent document level
    validation. Defaults to ``false``.
+
+   This option is available in MongoDB 3.2+ and is ignored for older server
+   versions, which do not support document level validation.
 interface: phpmethod
 operation: ~
 optional: true

src/Operation/Aggregate.php

@@ -62,8 +62,8 @@ class Aggregate implements Executable
      *
      *  * batchSize (integer): The number of documents to return per batch.
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation. This only applies when the $out
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation. This only applies when the $out
      *    stage is specified.
      *
      *    For servers < 3.2, this option is ignored as document level validation

src/Operation/BulkWrite.php

@@ -86,8 +86,11 @@ class BulkWrite implements Executable
      *
      * Supported options for the bulk write operation:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation. The default is false.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * ordered (boolean): If true, when an insert fails, return without
      *    performing the remaining writes. If false, when a write fails,

src/Operation/FindAndModify.php

@@ -54,8 +54,11 @@ class FindAndModify implements Executable
      *    This is not supported for server versions < 3.4 and will result in an
      *    exception at execution time if used.
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * fields (document): Limits the fields to return for the matching
      *    document.

src/Operation/FindOneAndReplace.php

@@ -41,8 +41,11 @@ class FindOneAndReplace implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *

src/Operation/FindOneAndUpdate.php

@@ -41,8 +41,11 @@ class FindOneAndUpdate implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *

src/Operation/InsertMany.php

@@ -45,8 +45,11 @@ class InsertMany implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * ordered (boolean): If true, when an insert fails, return without
      *    performing the remaining writes. If false, when a write fails,

src/Operation/InsertOne.php

@@ -45,8 +45,11 @@ class InsertOne implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
      *

src/Operation/ReplaceOne.php

@@ -39,8 +39,11 @@ class ReplaceOne implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *

src/Operation/Update.php

@@ -50,8 +50,11 @@ class Update implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *

src/Operation/UpdateMany.php

@@ -39,8 +39,11 @@ class UpdateMany implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *

src/Operation/UpdateOne.php

@@ -39,8 +39,11 @@ class UpdateOne implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *