下载Mezzio框架中的CSV (Zend/Laminas)

Question

在Mezzion框架中，我有下一个处理程序：

 <?php

namespace Bgc\Handler;

use App\Service\GenerateReportToCSV;
use Bgc\Queue\BGCQueueManager;
use Laminas\Diactoros\Response\TextResponse;
use League\Csv\Writer;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;

class DownloadBgcReportHandler implements RequestHandlerInterface
{
    protected $bgcQManager;
    protected $reportToCSV;

    public function __construct(BGCQueueManager $bgcQManager, $reportToCSV)
    {
        $this->bgcQManager = $bgcQManager;
        $this->reportToCSV = $reportToCSV;
    }

    public function handle(ServerRequestInterface $request): TextResponse
    {
        $queryParams = $request->getQueryParams();
        $params = [];

        if (isset($queryParams['startDate'])) {
            $starDate = new \DateTime($queryParams['startDate']);
            $params['startDate'] = $starDate->modify('midnight');
        }

        if (isset($queryParams['startDate'])) {
            $endDate = new \DateTime($queryParams['endDate']);
            $params['endDate'] = $endDate->modify('tomorrow');
        }

        $itemsBGC = $this->bgcQManager->getDataToDownload($params);
        $time = time();
        $fileName = "bgc-report-$time.csv";

        $csv = Writer::createFromFileObject(new \SplFileObject());
        $csv->insertOne($this->reportToCSV->getHeadingsBGC());

        foreach ($itemsBGC as $item) {
            $csv->insertOne($item);
        }

        return new TextResponse($csv->getContent(), 200, [
            'Content-Type' => 'text/csv',
            'Content-Transfer-Encoding' => 'binary',
            'Content-Disposition' => "attachment; filename='$fileName'"
        ]);
    }
}

我有以下错误：

Whoops\Exception\ErrorException: Declaration of Bgc\Handler\DownloadBgcReportHandler::handle(Psr\Http\Message\ServerRequestInterface $request): Laminas\Diactoros\Response\TextResponse must be compatible with Psr\Http\Server\RequestHandlerInterface::handle(Psr\Http\Message\ServerRequestInterface $request): Psr\Http\Message\ResponseInterface in file /home/peter/proyectos/revelations-thena-api/src/Bgc/src/Handler/DownloadBgcReportHandler.php on line 20

我不知道，创建一个可下载的文件。hadbler与Json一起工作得很好。我尝试从ResponseInterface更改为TextResponse。

如何下载文件CSV？谢谢

Answer 1

您收到的错误提示您的方法签名与接口的方法签名不兼容。

RequestHandlerInterface：

interface RequestHandlerInterface
{
    public function handle(ServerRequestInterface $request): ResponseInterface;
}

如您所见，签名声明返回了一个ResponseInterface类型的对象。

您修改了签名：

class DownloadBgcReportHandler implements RequestHandlerInterface
{
    public function handle(ServerRequestInterface $request): TextResponse;
}

签名必须与相同，但这样您就可以毫无问题地返回TextResponse (因为它扩展了实现Psr\Http\Message\ResponseInterface的Laminas\Diactoros\Response )

只要改变这一点，它就会起作用:)

Answer 2

您已经修改了处理方法，所以现在还不能满足RequestHandlerInterface的要求

Answer 3

将处理程序的返回值替换为接口中强制执行的ResponseInterface：RequestHandlerInterface

所以我认为最好的帮助是：

<?php

namespace Bgc\Handler;

use App\Service\GenerateReportToCSV;
use Bgc\Queue\BGCQueueManager;
use Laminas\Diactoros\Response;
use Laminas\Diactoros\Stream;
use League\Csv\Writer;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;

class DownloadBgcReportHandler implements RequestHandlerInterface
{
    protected $bgcQManager;
    protected $reportToCSV;

    public function __construct(BGCQueueManager $bgcQManager, $reportToCSV)
    {
        $this->bgcQManager = $bgcQManager;
        $this->reportToCSV = $reportToCSV;
    }

    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $queryParams = $request->getQueryParams();
        $params = [];

        if (isset($queryParams['startDate'])) {
            $starDate = new \DateTime($queryParams['startDate']);
            $params['startDate'] = $starDate->modify('midnight');
        }

        if (isset($queryParams['startDate'])) {
            $endDate = new \DateTime($queryParams['endDate']);
            $params['endDate'] = $endDate->modify('tomorrow');
        }

        $itemsBGC = $this->bgcQManager->getDataToDownload($params);
        $time = time();
        $fileName = "bgc-report-$time.csv";

        // $csv = Writer::createFromFileObject(new \SplFileObject());
        // $csv->insertOne($this->reportToCSV->getHeadingsBGC());
        $csv = Writer::createFromString($this->reportToCSV->getHeadingsBGC());

        foreach ($itemsBGC as $item) {
            $csv->insertOne($item);
        }

        $body = new Stream($csv->getContent());

        return new Response($body, 200, [
            'Cache-Control' => 'must-revalidate',
            'Content-Disposition' => 'attachment; filename=' . $fileName,
            'Content-Length' => strval($body->getSize()),
            'Content-Type' => 'text/csv',
            'Content-Transfer-Encoding' => 'binary',
            'Expires' => '0',
            'Pragma' => 'public',
        ]);
    }
}

PS:我已经注释了使用空new \SplFileObject()的两行，因为所需的参数$filename是空的(我不想在这里做决定)，并添加了一行Writer::createFromString()。