1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
=============================================
MongoDB\\GridFS\\Bucket::getFileIdForStream()
=============================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\GridFS\\Bucket::getFileIdForStream()
Gets the file document's ID of the GridFS file associated with a stream.
.. code-block:: php
function getFileIdForStream($stream): mixed
This method has the following parameters:
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-getFileIdForStream-param.rst
Return Values
-------------
The ``_id`` field of the metadata document associated with the GridFS stream.
The return type will depend on the bucket's ``typeMap`` option.
Errors/Exceptions
-----------------
.. include:: /includes/extracts/error-gridfs-corruptfileexception.rst
.. include:: /includes/extracts/error-invalidargumentexception.rst
.. include:: /includes/extracts/error-driver-runtimeexception.rst
.. todo: add examples
See Also
--------
- :phpmethod:`MongoDB\\GridFS\\Bucket::getFileDocumentForStream()`