PHP Classes

File: vendor/mongodb/mongodb/docs/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt

Recommend this page to a friend!
  Classes of walid laggoune   MongoDB Queue PHP Query Execute   vendor/mongodb/mongodb/docs/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt   Download  
File: vendor/mongodb/mongodb/docs/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt
Role: Documentation
Content type: text/plain
Description: Documentation
Class: MongoDB Queue PHP Query Execute
Query and execute multiple queries using MongoDB
Author: By
Last change:
Date: 4 years ago
Size: 1,696 bytes
 

Contents

Class file image Download
=================================================== MongoDB\\GridFS\\Bucket::openDownloadStreamByName() =================================================== .. default-domain:: mongodb .. contents:: On this page :local: :backlinks: none :depth: 1 :class: singlecol Definition ---------- .. phpmethod:: MongoDB\\GridFS\\Bucket::openDownloadStreamByName() Selects a GridFS file by its ``filename`` and opens it as a readable stream. .. code-block:: php function openDownloadStreamByName($filename, array $options = []): resource This method has the following parameters: .. include:: /includes/apiargs/MongoDBGridFSBucket-method-openDownloadStreamByName-param.rst The ``$options`` parameter supports the following options: .. include:: /includes/apiargs/MongoDBGridFSBucket-method-openDownloadStreamByName-option.rst Return Values ------------- A readable stream resource. Errors/Exceptions ----------------- .. include:: /includes/extracts/error-gridfs-filenotfoundexception.rst .. include:: /includes/extracts/error-driver-runtimeexception.rst Examples -------- .. code-block:: php <?php $bucket = (new MongoDB\Client)->test->selectGridFSBucket(); $stream = fopen('php://temp', 'w+b'); fwrite($stream, "foobar"); rewind($stream); $bucket->uploadFromStream('filename', $stream); var_dump(stream_get_contents($bucket->openDownloadStreamByName('filename'))); The output would then resemble:: string(6) "foobar" See Also -------- - :phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStream()` - :phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStreamByName()` - :phpmethod:`MongoDB\\GridFS\\Bucket::openDownloadStream()`