MongoDB\GridFS\Bucket::openDownloadStream()

Definition

MongoDB\GridFS\Bucket::openDownloadStream()

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

function openDownloadStream($id): resource

Parameters

$id : mixed

The _id of the file to download.

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 extension level (e.g. connection errors).

Examples

<?php
$bucket = (new MongoDB\Client)->test->getGridFSBucket();
$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:

string(6) "foobar"

See Also

• MongoDB\GridFS\Bucket::downloadToStream()

• MongoDB\GridFS\Bucket::downloadToStreamByName()

• MongoDB\GridFS\Bucket::openDownloadStreamByName()