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

MongoDB\GridFS\Bucket::downloadToStream()

Definition

MongoDB\GridFS\Bucket::downloadToStream

Selects a GridFS file by its _id and copies its contents to a writable stream.

copy

function downloadToStream($id, $destination): void

This method has the following parameters:

Parameter	Type	Description
$id	mixed	The _id of the file.
$destination	resource	Writable stream, to which the GridFS file’s contents will be written.

Errors/Exceptions

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

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).

Examples

copy

<?php

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

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

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

$destination = fopen('php://temp', 'w+b');

$bucket->downloadToStream($id, $destination);

var_dump(stream_get_contents($destination, -1, 0));

The output would then resemble:

copy

string(6) "foobar"

See Also

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

←   MongoDB\GridFS\Bucket::delete() MongoDB\GridFS\Bucket::downloadToStreamByName()  →

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