README

ZIP 响应器（PSR-7）。

目录

• 要求
• 安装
• 使用
  • 发送 ZIP 文件
  • 从字符串发送 ZIP 文件
  • 发送 ZIP 流
  • 发送 ZipArchive 文件
  • 发送 ZipStream-PHP 存档
  • 发送 PhpZip 存档
• Slim 4 集成

要求

• PHP 7.3+ 或 8.0+
• PSR-7 StreamFactory 实现，例如 nyholm/psr7

安装

composer require selective/zip-responder

使用

使用 nyholm/psr7 Psr17Factory 创建新的 ZipResponder 实例

use Selective\Http\Zip\ZipResponder;
use Nyholm\Psr7\Factory\Psr17Factory;

$zipResponder = new ZipResponder(new Psr17Factory());

使用 slim/psr7 StreamFactory 创建新的 ZipResponder 实例

use Selective\Http\Zip\ZipResponder;
use Slim\Psr7\Factory\StreamFactory;

$zipResponder = new ZipResponder(new StreamFactory());

发送 ZIP 文件

将 ZIP 文件发送到浏览器，强制直接下载

return $zipResponder->withZipFile($response, 'source.zip', 'output.zip');

从字符串发送 ZIP 文件

return $zipResponder->withZipString($response, file_get_contents('example.zip'), 'output.zip');

发送 ZIP 流

将 ZIP 流发送到浏览器，强制直接下载

$stream = fopen('test.zip', 'r');
 
return $zipResponder->withZipStream($response, $stream, 'output.zip');

动态发送 ZIP 流

根据 PSR-7 规范，直接向客户端发送文件是不推荐的，但可以通过 CallbackStream 实现。

use Selective\Http\Zip\Stream\CallbackStream;

$callbackStream = new CallbackStream(function () {
    echo 'my binary zip content';
}

$response = $zipResponder->withZipHeaders($response, $outputName, true);

return $response->withBody($callbackStream);

发送 ZipArchive 文件

ZIP 扩展允许您透明地读取或写入 ZIP 压缩存档及其中的文件。与 PHP 流不同，ZipArchive 不支持 "内存映射文件"。您只能使用 ZipArchive 访问本地文件。为此，您可以创建一个临时文件，或者可以使用文件系统中的现有文件。

use ZipArchive;
// ...

// Create temporary filename
$filename = tempnam(sys_get_temp_dir(), 'zip');

// Add files to temporary ZIP file
$zip = new ZipArchive();
$zip->open($filename, ZipArchive::CREATE | ZipArchive::OVERWRITE);
$zip->addFromString('test.txt', 'my content');
$zip->close();

// Render ZIP file into the response as stream
return $zipResponder->withZipStream($response, fopen($filename, 'r'), 'download.zip');

发送 ZipStream-PHP 存档

ZipStream-PHP 是一个用于流式传输动态 ZIP 文件的库，无需写入磁盘。您可以直接将文件发送给用户，这要快得多，并提高了可测试性。

安装

composer require maennchen/zipstream-php

创建并发送ZIP文件（仅内存）到浏览器

use ZipStream\ZipStream;

// ...

// Create ZIP file, only in-memory
$stream = fopen('php://memory', 'w+b');

$zip = new ZipStream(
    outputStream: $stream,
    // disable output of HTTP headers
    sendHttpHeaders: false,
);

// create a file named 'hello.txt'
$zip->addFile(
    fileName: 'hello.txt',
    data: 'This is the contents of hello.txt',
);

$zip->finish();

$response = $zipResponder->withZipStream($response, $stream, 'download.zip');

动态发送 ZIP 流

use Selective\Http\Zip\Stream\CallbackStream;
use ZipStream\ZipStream;
//...

$callbackStream = new CallbackStream(function () {
    // Flush ZIP file directly to output stream (php://output)
    $zip = new ZipStream(
        flushOutput: true,
        sendHttpHeaders: false,
    );

    // Add files to ZIP file and stream it directly
    $zip->addFile('test.txt', 'my file content');
    $zip->addFile('test2.txt', 'my file content 2');
    $zip->addFile('test3.txt', 'my file content 4');
    $zip->finish();
});

$response = $zipResponder->withZipHeaders($response, $outputName, true);

return $response->withBody($callbackStream);

发送 PhpZip 存档

PhpZip 是一个用于扩展 ZIP 存档工作的库。

安装

composer require nelexa/zip

注意，当您使用 nelexa/zip 组件时，可能不需要 selective/zip-responder 组件，因为 nelexa/zip 已经提供了自己的 PSR-7 响应器。

示例

use PhpZip\ZipFile;

// ...

$zipFile = new ZipFile();
$zipFile->addFromString('test.txt', 'File content');

return $zipFile->outputAsResponse($response, 'download.zip');

如果您想保持您的架构更干净（SRP），您可以使用 selective/zip-responder 响应器创建并发送 ZIP 文件到浏览器，如下所示

use PhpZip\ZipFile;

// ...

// Create new archive
$zipFile = new ZipFile();

// Add entry from string
$zipFile->addFromString('test.txt', 'File content');
     
return $zipResponder->withZipString($response, $zipFile->outputAsString(), 'download.zip');

Slim 4 集成

为 StreamFactoryInterface::class 和 ZipResponder::class 创建 DI 容器定义

一个 nyholm/psr7 和 PHP-DI 的示例

<?php

use Nyholm\Psr7\Factory\Psr17Factory;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Selective\Http\Zip\ZipResponder;

return [
    // ...

    StreamFactoryInterface::class => function (ContainerInterface $container) {
        return $container->get(Psr17Factory::class);
    },

    ZipResponder::class => function (ContainerInterface $container) {
        return new ZipResponder($container->get(StreamFactoryInterface::class));
    },
];

一个 slim/psr7 和 PHP-DI 的示例

<?php

use Psr\Container\ContainerInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Slim\Psr7\Factory\StreamFactory;
use Selective\Http\Zip\ZipResponder;

return [
    // ...
    
    StreamFactoryInterface::class => function () {
        return new StreamFactory();
    },
    
    ZipResponder::class => function (ContainerInterface $container) {
        return new ZipResponder($container->get(StreamFactoryInterface::class));
    },
];

响应器应仅用于操作处理器或中间件中。

使用依赖注入的动作类示例

<?php

namespace App\Action;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Selective\Http\Zip\ZipResponder;
use ZipArchive;

final class ZipDemoAction
{
    /**
     * @var ZipResponder
     */
    private $zipResponder;

    public function __construct(ZipResponder $zipResponder)
    {
        $this->zipResponder = $zipResponder;
    }

    public function __invoke(
        ServerRequestInterface $request, 
        ResponseInterface $response
    ): ResponseInterface {
        $filename = tempnam(sys_get_temp_dir(), 'zip');

        $zip = new ZipArchive();
        $zip->open($filename, ZipArchive::CREATE | ZipArchive::OVERWRITE);
        $zip->addFromString('test.txt', 'my content');
        $zip->close();

        return $this->zipResponder->withZipFile($response, $filename, 'filename.zip');
    }
}

许可证

MIT 许可证（MIT）。有关更多信息，请参阅许可证文件。