Get support for yiisoft/response-download

If you need help reviewing implementation, debugging, understanding undocumented features or anything in general with yiisoft/response-download, you can see the list of people available to help below. Save yourself timme by talking directly to the owner, maintainers and contributors of yiisoft/response-download. Who is better qualified to help you? You also get the added benefit of providing additional revenue to the projects you use, helping them remain sustainable.

Save yourself timme by talking directly to the owner, maintainers and contributors of yiisoft/response-download. Who is better qualified to help you? You also get the added benefit of providing additional revenue to the projects you use, helping them remain sustainable.

If you're new to LTH, please see our FAQ for more information on what it is we do.

Support Options

Unfortunately, there are currently no active helpers for this repository on the platform. Until they become available, we reccomend the following actions:

View Open Issues

Take a look to see if anyone else has experienced the same issue as you and if they managed to solve it.

Open an Issue

Make sure to read any relevant guidelines for opening issues on this repo before posting a new issue.

Sponsor directly

Check out the page and see if there are any options to sponsor this project or it's developers directly.

yiisoft/response-download

View on github

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:

composer require yiisoft/response-download

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 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

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.