Deprecate setting GridFS disableMD5 to false explicitly

mongodb · Jan 3, 2024 · 83c0083 · 83c0083
1 parent 92e0a10
commit 83c0083
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 4 deletions.
diff --git a/docs/reference/method/MongoDBDatabase-selectGridFSBucket.txt b/docs/reference/method/MongoDBDatabase-selectGridFSBucket.txt
@@ -48,7 +48,7 @@ Parameters
        - boolean
        - Whether to disable automatic MD5 generation when storing files.
 
-         Defaults to ``false``.
+         Defaults to ``false``. Only ``true`` will be supported in 2.0.
 
          .. versionadded: 1.4
 

diff --git a/docs/reference/method/MongoDBGridFSBucket-openUploadStream.txt b/docs/reference/method/MongoDBGridFSBucket-openUploadStream.txt
@@ -55,7 +55,7 @@ Parameters
        - boolean
        - Whether to disable automatic MD5 generation when storing files.
 
-         Defaults to ``false``.
+         Defaults to ``false``. Only ``true`` will be supported in 2.0.
 
          .. versionadded: 1.4
 

diff --git a/docs/reference/method/MongoDBGridFSBucket-uploadFromStream.txt b/docs/reference/method/MongoDBGridFSBucket-uploadFromStream.txt
@@ -59,7 +59,7 @@ Parameters
        - boolean
        - Whether to disable automatic MD5 generation when storing files.
 
-         Defaults to ``false``.
+         Defaults to ``false``. Only ``true`` will be supported in 2.0.
 
          .. versionadded: 1.4
 

diff --git a/docs/reference/method/MongoDBGridFSBucket__construct.txt b/docs/reference/method/MongoDBGridFSBucket__construct.txt
@@ -59,7 +59,7 @@ Parameters
        - boolean
        - Whether to disable automatic MD5 generation when storing files.
 
-         Defaults to ``false``.
+         Defaults to ``false``. Only ``true`` will be supported in 2.0.
 
          .. versionadded: 1.4
 

diff --git a/src/GridFS/Bucket.php b/src/GridFS/Bucket.php
@@ -61,6 +61,7 @@
 use function stream_copy_to_stream;
 use function stream_get_meta_data;
 use function stream_get_wrappers;
+use function trigger_deprecation;
 use function urlencode;
 
 /**
@@ -132,6 +133,10 @@ class Bucket
      */
     public function __construct(Manager $manager, string $databaseName, array $options = [])
     {
+        if (isset($options['disableMD5']) && $options['disableMD5'] === false) {
+            trigger_deprecation('mongodb/mongodb', '1.10', 'Setting GridFS "disableMD5" option to "false" is deprecated and will not be supported in version 2.0.');
+        }
+
         $options += [
             'bucketName' => self::DEFAULT_BUCKET_NAME,
             'chunkSizeBytes' => self::DEFAULT_CHUNK_SIZE_BYTES,