DOCSP-45100: GridFS methods api docs

source/reference/class/MongoDBGridFSBucket.txt

@@ -35,6 +35,7 @@ Methods
 
    __construct() </reference/method/MongoDBGridFSBucket__construct>
    delete() </reference/method/MongoDBGridFSBucket-delete>
+   deleteByName() </reference/method/MongoDBGridFSBucket-deleteByName>
    downloadToStream() </reference/method/MongoDBGridFSBucket-downloadToStream>
    downloadToStreamByName() </reference/method/MongoDBGridFSBucket-downloadToStreamByName>
    drop() </reference/method/MongoDBGridFSBucket-drop>
@@ -56,10 +57,12 @@ Methods
    openUploadStream() </reference/method/MongoDBGridFSBucket-openUploadStream>
    registerGlobalStreamWrapperAlias() </reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias>
    rename() </reference/method/MongoDBGridFSBucket-rename>
+   renameByName() </reference/method/MongoDBGridFSBucket-renameByName>
    uploadFromStream() </reference/method/MongoDBGridFSBucket-uploadFromStream>
 
 - :phpmethod:`MongoDB\GridFS\Bucket::__construct()`
 - :phpmethod:`MongoDB\GridFS\Bucket::delete()`
+- :phpmethod:`MongoDB\GridFS\Bucket::deleteByName()`
 - :phpmethod:`MongoDB\GridFS\Bucket::downloadToStream()`
 - :phpmethod:`MongoDB\GridFS\Bucket::drop()`
 - :phpmethod:`MongoDB\GridFS\Bucket::find()`
@@ -80,4 +83,5 @@ Methods
 - :phpmethod:`MongoDB\GridFS\Bucket::openUploadStream()`
 - :phpmethod:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias()`
 - :phpmethod:`MongoDB\GridFS\Bucket::rename()`
+- :phpmethod:`MongoDB\GridFS\Bucket::renameByName()`
 - :phpmethod:`MongoDB\GridFS\Bucket::uploadFromStream()`

source/reference/method/MongoDBGridFSBucket-deleteByName.txt

@@ -0,0 +1,50 @@
+=======================================
+MongoDB\\GridFS\\Bucket::deleteByName()
+=======================================
+
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Definition
+----------
+
+.. phpmethod:: MongoDB\GridFS\Bucket::deleteByName()
+
+   Deletes a file and all its revisions from the GridFS bucket.
+
+   .. code-block:: php
+
+      function deleteByName(string $filename): void
+
+Parameters
+----------
+
+``$filename`` : string
+  The ``filename`` of the files to delete.
+
+Errors/Exceptions
+-----------------
+
+.. include:: /includes/extracts/error-gridfs-filenotfoundexception.rst
+.. include:: /includes/extracts/error-driver-runtimeexception.rst
+
+Examples
+--------
+
+.. code-block:: php
+
+   <?php
+
+   $bucket = (new MongoDB\Client)->test->selectGridFSBucket();
+
+   $stream = fopen('php://temp', 'w+b');
+   fwrite($stream, "foobar");
+   rewind($stream);
+
+   $bucket->uploadFromStream('filename', $stream);
+
+   $bucket->deleteByName('filename');

source/reference/method/MongoDBGridFSBucket-renameByName.txt

@@ -0,0 +1,62 @@
+=======================================
+MongoDB\\GridFS\\Bucket::renameByName()
+=======================================
+
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Definition
+----------
+
+.. phpmethod:: MongoDB\GridFS\Bucket::renameByName()
+
+   Selects a GridFS file and any of its revisions by their ``filename``
+   and sets a new ``filename`` value.
+
+   .. code-block:: php
+
+      function renameByName(string $filename, string $newFilename): void
+
+Parameters
+----------
+
+``$filename`` : string
+  The ``filename`` of the files to rename.
+
+``$newFilename`` : string
+  The new ``filename`` value.
+
+Errors/Exceptions
+-----------------
+
+.. include:: /includes/extracts/error-gridfs-filenotfoundexception.rst
+.. include:: /includes/extracts/error-driver-runtimeexception.rst
+
+Examples
+--------
+
+.. code-block:: php
+
+   <?php
+
+   $bucket = (new MongoDB\Client)->test->selectGridFSBucket();
+
+   $stream = fopen('php://temp', 'w+b');
+   fwrite($stream, "foobar");
+   rewind($stream);
+
+   $bucket->uploadFromStream('a', $stream);
+
+   $bucket->renameByName('a', 'b');
+
+   var_dump(stream_get_contents($bucket->openDownloadStreamByName('b')));
+
+The output would then resemble:
+
+.. code-block:: none
+
+   string(6) "foobar"

source/write/gridfs.txt

@@ -449,4 +449,6 @@ see the following API documentation:
 - :phpmethod:`MongoDB\GridFS\Bucket::openDownloadStream()`
 - :phpmethod:`MongoDB\GridFS\Bucket::downloadToStream()`
 - :phpmethod:`MongoDB\GridFS\Bucket::rename()`
-- :phpmethod:`MongoDB\GridFS\Bucket::delete()`
+- :phpmethod:`MongoDB\GridFS\Bucket::renameByName()`
+- :phpmethod:`MongoDB\GridFS\Bucket::delete()`
+- :phpmethod:`MongoDB\GridFS\Bucket::deleteByName()`