• API Documentation >
• MongoDB\GridFS\Bucket Class >
• MongoDB\GridFS\Bucket::openDownloadStream()

MongoDB\GridFS\Bucket::openDownloadStream()

Definition

MongoDB\GridFS\Bucket::openDownloadStream

Selects a GridFS file by its _id and opens it as a readable stream.

copy

function openDownloadStream($id): resource

This method has the following parameters:

Parameter	Type	Description
$id	mixed	The _id of the file.

Return Values

A readable stream resource.

Errors/Exceptions

MongoDB\GridFS\Exception\FileNotFoundException if no file was found for the selection criteria.

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

Examples

copy

<?php

$bucket = (new MongoDB\Client)->test->selectGridFSBucket();

$uploadStream = fopen('php://temp', 'w+b');
fwrite($uploadStream, "foobar");
rewind($uploadStream);

$id = $bucket->uploadFromStream('filename', $uploadStream);

$downloadStream = $bucket->openDownloadStream($id);

var_dump(stream_get_contents($downloadStream));

The output would then resemble:

copy

string(6) "foobar"

See Also

• MongoDB\GridFS\Bucket::downloadToStream()
• MongoDB\GridFS\Bucket::downloadToStreamByName()
• MongoDB\GridFS\Bucket::openDownloadStreamByName()

←   MongoDB\GridFSBucket::getWriteConcern() MongoDB\GridFS\Bucket::openDownloadStreamByName()  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.