PHPackages                             yiisoft/response-download - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. yiisoft/response-download

ActiveLibrary[Framework](/categories/framework)

yiisoft/response-download
=========================

The package provides a factory to help forming file download PSR-7 response.

1.0.0(3y ago)119.2k↓37.5%3[2 issues](https://github.com/yiisoft/response-download/issues)BSD-3-ClausePHPPHP ^8.1CI passing

Since Mar 14Pushed 5mo ago12 watchersCompare

[ Source](https://github.com/yiisoft/response-download)[ Packagist](https://packagist.org/packages/yiisoft/response-download)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-response-download/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (10)Versions (2)Used By (0)

 [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft)

Yii PSR-7 Download Response Factory
===================================

[](#yii-psr-7-download-response-factory)

[![Latest Stable Version](https://camo.githubusercontent.com/c7a1d70a942655c3a6340db192e190743174470217c316a17a8a96742d155f85/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f726573706f6e73652d646f776e6c6f61642f762f737461626c652e706e67)](https://packagist.org/packages/yiisoft/response-download)[![Total Downloads](https://camo.githubusercontent.com/cbebe48ef4923c6a8d52fe545b2d238959143c928d6c5758d06905185cb0434d/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f726573706f6e73652d646f776e6c6f61642f646f776e6c6f6164732e706e67)](https://packagist.org/packages/yiisoft/response-download)[![Build status](https://github.com/yiisoft/response-download/workflows/build/badge.svg)](https://github.com/yiisoft/response-download/actions?query=workflow%3Abuild)[![Code Coverage](https://camo.githubusercontent.com/bbeba61f0396f853ed32226ee77b50be47091588c1312540b81a52eba1f120f5/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f726573706f6e73652d646f776e6c6f61642f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/yiisoft/response-download)[![Mutation testing badge](https://camo.githubusercontent.com/258ba22e34262ca3159bbfc3b394ed5669683dcfeab7bd2840cb67f5551765d4/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f6674253246726573706f6e73652d646f776e6c6f61642532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/response-download/master)[![static analysis](https://github.com/yiisoft/response-download/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/response-download/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/14b23b36485222384cc6d66288209a1c0a2d7c1fe2ebfb6fd588daea2777d9a2/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f726573706f6e73652d646f776e6c6f61642f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/response-download)[![psalm-level](https://camo.githubusercontent.com/fcaddf09c94bad10d0fd0ef255d5c379c4ed446294b71fb5a1d758c2dcbc9d7d/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f726573706f6e73652d646f776e6c6f61642f6c6576656c2e737667)](https://shepherd.dev/github/yiisoft/response-download)

The package provides a factory to help forming file download PSR-7 response.

Requirements
------------

[](#requirements)

- PHP 8.1 or higher.

Installation
------------

[](#installation)

The package could be installed with [Composer](https://getcomposer.org):

```
composer require yiisoft/response-download
```

General usage
-------------

[](#general-usage)

Use the factory to form a response:

```
use Psr\Http\Message\ResponseInterface;
use Yiisoft\ResponseDownload\DownloadResponseFactory;

final class MyController
{
    public function __construct(
        private readonly DownloadResponseFactory $downloadResponseFactory,
    )
    {
    }

    public function sendMyContentAsFile(): ResponseInterface
    {
        return $this->downloadResponseFactory->sendContentAsFile('Hello!', 'message.txt');
    }

    public function sendMyFile(): ResponseInterface
    {
        return $this->downloadResponseFactory->sendFile('message.txt');
    }

    public function xSendMyFile(): ResponseInterface
    {
        return $this->downloadResponseFactory->xSendFile('message.txt');
    }

    public function sendMyStreamAsFile(): ResponseInterface
    {
        $stream = new MyStream();

        return $this->downloadResponseFactory->sendStreamAsFile($stream, 'message.txt');
    }
}
```

Note the `xSendFile()`. It is a special method that delegates the hard work to the web server instead of serving the file using PHP.

Optional arguments and defaults:

- If attachment name is not specified in `sendFile()` or `xSendFile()`, it will be taken from the name of the file served.
- Each file sending method could also be provided with optional mime type and optional content disposition.
- If mime type is omitted, for `sendContentAsFile()`, `sendFile()` and `xSendFile()` it will be determined based on the file content. For other methods or when unable to determine the mime type, "application/octet-stream" will be used.
- Content disposition is "attachment" by default. It will trigger browser's download dialog. If you want the content of the file to be displayed inline, set it to `Yiisoft\Http\ContentDispositionHeader\ContentDispositionHeader::INLINE`.

Documentation
-------------

[](#documentation)

- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

License
-------

[](#license)

The Yii PSR-7 Download Response Factory is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

Support the project
-------------------

[](#support-the-project)

[![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft)

Follow updates
--------------

[](#follow-updates)

[![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack)

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance45

Moderate activity, may be stable

Popularity33

Limited adoption so far

Community23

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1162d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark)

![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire)

![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol)

---

Top Contributors

[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (10 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (4 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (4 commits)")[![arogachev](https://avatars.githubusercontent.com/u/8326201?v=4)](https://github.com/arogachev "arogachev (3 commits)")[![Mister-42](https://avatars.githubusercontent.com/u/68641750?v=4)](https://github.com/Mister-42 "Mister-42 (2 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (2 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (1 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (1 commits)")

---

Tags

downloadfilehttppsr-7responseyii3httpresponsepsr-7filedownloadyii3

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm, Rector

Type Coverage Yes

### Embed Badge

![Health badge](/badges/yiisoft-response-download/health.svg)

```
[![Health](https://phpackages.com/badges/yiisoft-response-download/health.svg)](https://phpackages.com/packages/yiisoft-response-download)
```

###  Alternatives

[guzzlehttp/psr7

PSR-7 message implementation that also provides common utility methods

7.9k1.0B3.2k](/packages/guzzlehttp-psr7)[cakephp/cakephp

The CakePHP framework

8.8k18.5M1.6k](/packages/cakephp-cakephp)[slim/psr7

Strict PSR-7 implementation

14818.0M411](/packages/slim-psr7)[slim/http

Slim PSR-7 Object Decorators

1502.3M66](/packages/slim-http)[phpro/http-tools

HTTP tools for developing more consistent HTTP implementations.

28137.8k](/packages/phpro-http-tools)[yiisoft/data-response

Allows responding with data that is automatically converted into PSR-7 response

19287.0k14](/packages/yiisoft-data-response)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
