Download the PHP package yiisoft/response-download without Composer
On this page you can find all versions of the php package yiisoft/response-download. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package response-download
Yii PSR-7 Download Response Factory
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:
General usage
Use the factory to form a response:
Note the xSendFile(). It is a special method that delegates the hard work to the web server instead of serving the
file using PHP.
X-Sendfile and Nginx
Different web servers use different header names for the x-sendfile feature:
| Web server | Header name |
|---|---|
| Apache | X-Sendfile (default) |
| Lighttpd v1.4 | X-LIGHTTPD-send-file |
| Lighttpd v1.5 | X-Sendfile |
| Nginx | X-Accel-Redirect |
| Cherokee | X-Sendfile or X-Accel-Redirect |
| FrankenPHP | X-Accel-Redirect |
When using Nginx, pass 'X-Accel-Redirect' as the $xHeader argument. Nginx also requires an internal
location block in its configuration that maps to the directory where your files are stored:
Then call xSendFile() with the internal Nginx location path as the file path:
The internal directive ensures the location is only accessible internally by Nginx (not directly by clients),
while alias maps the internal path to the real file system path.
Optional arguments and defaults:
- If attachment name is not specified in
sendFile()orxSendFile(), 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()andxSendFile()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
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
The Yii PSR-7 Download Response Factory is free software. It is released under the terms of the BSD License.
Please see LICENSE for more information.
Maintained by Yii Software.
Support the project
Follow updates
All versions of response-download with dependencies
ext-fileinfo Version *
psr/http-message Version ^1.0|^2.0
psr/http-factory Version ^1.0
yiisoft/http Version ^1.2

