Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/response-download
The package provides a factory to help forming file download PSR-7 response
https://github.com/yiisoft/response-download
download file http psr-7 response yii3
Last synced: about 1 month ago
JSON representation
The package provides a factory to help forming file download PSR-7 response
- Host: GitHub
- URL: https://github.com/yiisoft/response-download
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2023-02-20T13:22:18.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-14T07:56:35.000Z (9 months ago)
- Last Synced: 2024-04-13T23:13:21.955Z (7 months ago)
- Topics: download, file, http, psr-7, response, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com
- Size: 39.1 KB
- Stars: 9
- Watchers: 14
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii PSR-7 Download Response Factory
[](https://packagist.org/packages/yiisoft/response-download)
[](https://packagist.org/packages/yiisoft/response-download)
[](https://github.com/yiisoft/response-download/actions?query=workflow%3Abuild)
[](https://codecov.io/gh/yiisoft/response-download)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/response-download/master)
[](https://github.com/yiisoft/response-download/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/response-download)
[](https://shepherd.dev/github/yiisoft/response-download)
The package provides a factory to help forming file download PSR-7 response.
## Requirements
- PHP 8.1 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/response-download
```
## General usage
Use the factory to form a response:
```php
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 `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
- [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
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
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)