Elep

=================================================
MongoDB\\GridFS\\Bucket::downloadToStreamByName()
=================================================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. phpmethod:: MongoDB\\GridFS\\Bucket::downloadToStreamByName()

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

.. code-block:: php

function downloadToStreamByName($filename, $destination, array $options = []): void

This method has the following parameters:

.. include:: /includes/apiargs/MongoDBGridFSBucket-method-downloadToStreamByName-param.rst

The ``$options`` parameter supports the following options:

.. include:: /includes/apiargs/MongoDBGridFSBucket-method-downloadToStreamByName-option.rst

Errors/Exceptions
-----------------

.. include:: /includes/extracts/error-gridfs-filenotfoundexception.rst
.. include:: /includes/extracts/error-invalidargumentexception.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);

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

$bucket->downloadToStreamByName('filename', $destination);

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

The output would then resemble::

string(6) "foobar"