Skip to content

Commit 1442347

Browse files
authored
DOCSP-45100: GridFS methods api docs (#196)
* DOCSP-45100: GridFS methods api docs * edits * RR feedback * JT feedback
1 parent ed284fa commit 1442347

File tree

4 files changed

+119
-1
lines changed

4 files changed

+119
-1
lines changed

source/reference/class/MongoDBGridFSBucket.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Methods
3535

3636
__construct() </reference/method/MongoDBGridFSBucket__construct>
3737
delete() </reference/method/MongoDBGridFSBucket-delete>
38+
deleteByName() </reference/method/MongoDBGridFSBucket-deleteByName>
3839
downloadToStream() </reference/method/MongoDBGridFSBucket-downloadToStream>
3940
downloadToStreamByName() </reference/method/MongoDBGridFSBucket-downloadToStreamByName>
4041
drop() </reference/method/MongoDBGridFSBucket-drop>
@@ -56,10 +57,12 @@ Methods
5657
openUploadStream() </reference/method/MongoDBGridFSBucket-openUploadStream>
5758
registerGlobalStreamWrapperAlias() </reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias>
5859
rename() </reference/method/MongoDBGridFSBucket-rename>
60+
renameByName() </reference/method/MongoDBGridFSBucket-renameByName>
5961
uploadFromStream() </reference/method/MongoDBGridFSBucket-uploadFromStream>
6062

6163
- :phpmethod:`MongoDB\GridFS\Bucket::__construct()`
6264
- :phpmethod:`MongoDB\GridFS\Bucket::delete()`
65+
- :phpmethod:`MongoDB\GridFS\Bucket::deleteByName()`
6366
- :phpmethod:`MongoDB\GridFS\Bucket::downloadToStream()`
6467
- :phpmethod:`MongoDB\GridFS\Bucket::drop()`
6568
- :phpmethod:`MongoDB\GridFS\Bucket::find()`
@@ -80,4 +83,5 @@ Methods
8083
- :phpmethod:`MongoDB\GridFS\Bucket::openUploadStream()`
8184
- :phpmethod:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias()`
8285
- :phpmethod:`MongoDB\GridFS\Bucket::rename()`
86+
- :phpmethod:`MongoDB\GridFS\Bucket::renameByName()`
8387
- :phpmethod:`MongoDB\GridFS\Bucket::uploadFromStream()`
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
=======================================
2+
MongoDB\\GridFS\\Bucket::deleteByName()
3+
=======================================
4+
5+
6+
.. contents:: On this page
7+
:local:
8+
:backlinks: none
9+
:depth: 1
10+
:class: singlecol
11+
12+
Definition
13+
----------
14+
15+
.. phpmethod:: MongoDB\GridFS\Bucket::deleteByName()
16+
17+
Deletes a file and all its revisions from the GridFS bucket.
18+
19+
.. code-block:: php
20+
21+
function deleteByName(string $filename): void
22+
23+
Parameters
24+
----------
25+
26+
``$filename`` : string
27+
The ``filename`` of the files to delete.
28+
29+
Errors/Exceptions
30+
-----------------
31+
32+
.. include:: /includes/extracts/error-gridfs-filenotfoundexception.rst
33+
.. include:: /includes/extracts/error-driver-runtimeexception.rst
34+
35+
Examples
36+
--------
37+
38+
.. code-block:: php
39+
40+
<?php
41+
42+
$bucket = (new MongoDB\Client)->test->selectGridFSBucket();
43+
44+
$stream = fopen('php://temp', 'w+b');
45+
fwrite($stream, "foobar");
46+
rewind($stream);
47+
48+
$bucket->uploadFromStream('filename', $stream);
49+
50+
$bucket->deleteByName('filename');
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
=======================================
2+
MongoDB\\GridFS\\Bucket::renameByName()
3+
=======================================
4+
5+
6+
.. contents:: On this page
7+
:local:
8+
:backlinks: none
9+
:depth: 1
10+
:class: singlecol
11+
12+
Definition
13+
----------
14+
15+
.. phpmethod:: MongoDB\GridFS\Bucket::renameByName()
16+
17+
Sets a new ``filename`` value for a GridFS file and any of its
18+
revisions.
19+
20+
.. code-block:: php
21+
22+
function renameByName(string $filename, string $newFilename): void
23+
24+
Parameters
25+
----------
26+
27+
``$filename`` : string
28+
The ``filename`` of the files to rename.
29+
30+
``$newFilename`` : string
31+
The new ``filename`` value.
32+
33+
Errors/Exceptions
34+
-----------------
35+
36+
.. include:: /includes/extracts/error-gridfs-filenotfoundexception.rst
37+
.. include:: /includes/extracts/error-driver-runtimeexception.rst
38+
39+
Examples
40+
--------
41+
42+
.. code-block:: php
43+
44+
<?php
45+
46+
$bucket = (new MongoDB\Client)->test->selectGridFSBucket();
47+
48+
$stream = fopen('php://temp', 'w+b');
49+
fwrite($stream, "foobar");
50+
rewind($stream);
51+
52+
$bucket->uploadFromStream('a', $stream);
53+
54+
$bucket->renameByName('a', 'b');
55+
56+
var_dump(stream_get_contents($bucket->openDownloadStreamByName('b')));
57+
58+
The output would then resemble:
59+
60+
.. code-block:: none
61+
62+
string(6) "foobar"

source/write/gridfs.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -449,4 +449,6 @@ see the following API documentation:
449449
- :phpmethod:`MongoDB\GridFS\Bucket::openDownloadStream()`
450450
- :phpmethod:`MongoDB\GridFS\Bucket::downloadToStream()`
451451
- :phpmethod:`MongoDB\GridFS\Bucket::rename()`
452-
- :phpmethod:`MongoDB\GridFS\Bucket::delete()`
452+
- :phpmethod:`MongoDB\GridFS\Bucket::renameByName()`
453+
- :phpmethod:`MongoDB\GridFS\Bucket::delete()`
454+
- :phpmethod:`MongoDB\GridFS\Bucket::deleteByName()`

0 commit comments

Comments
 (0)