Docs Menu

Docs HomePHP Library Manual


On this page

  • Definition
  • Parameters
  • Return Values
  • Errors/Exceptions
  • Examples
  • See Also

Gets the file document's ID of the GridFS file associated with a stream.

function getFileIdForStream(resource $stream): mixed
$stream : resource
The GridFS stream resource.

The _id field of the metadata document associated with the GridFS stream. The return type will depend on the bucket's typeMap option.

MongoDB\GridFS\Exception\CorruptFileException if the file's metadata or chunk documents contain unexpected or invalid data.

MongoDB\Exception\InvalidArgumentException for errors related to the parsing of parameters or options.

MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).

$bucket = (new MongoDB\Client)->test->selectGridFSBucket();
$stream = $bucket->openUploadStream('filename');
$id = $bucket->getFileIdForStream($stream);

The output would then resemble:

object(MongoDB\BSON\ObjectId)#3005 (1) {
string(24) "5acfb37d7e21e83cdb3e1583"
← MongoDB\GridFS\Bucket::getFileDocumentForStream()