ZipStream PHP

ZipStream-PHP

不稳定分支

main分支不稳定。请参阅稳定版本的发行版。

概述

一个快速简单的 PHP 流式 zip 文件下载器。使用此库将使您不必将 Zip 写入磁盘。可以直接发送给用户，这样会快很多。它可以与 S3 存储桶或任何 PSR7 流配合使用。

请参阅许可证文件以获取许可和保修信息。

安装

如果您使用 Composer 来管理项目的依赖项，只需将 maennchen/zipstream-php 的依赖项添加到项目的composer.json文件中即可。使用以下命令将包添加到项目的依赖项中：

composer require maennchen/zipstream-php

用法

有关详细说明，请查看文档。

 // Autoload the dependencies
require ' vendor/autoload.php ' ;

// create a new zipstream object
$ zip = new ZipStream  ZipStream (
    outputName: ' example.zip ' ,

    // enable output of HTTP headers
    sendHttpHeaders: true ,
);

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

// add a file named 'some_image.jpg' from a local file 'path/to/image.jpg'
$ zip -> addFileFromPath (
    fileName: ' some_image.jpg ' ,
    path: ' path/to/image.jpg ' ,
);

// finish the zip stream
$ zip -> finish ();

升级至3.0.0版本

一般的

• 最低 PHP 版本： 8.1
• 仅支持 64 位架构。
• 类ZipStreamOptionMethod已替换为枚举ZipStreamCompressionMethod 。
• 大多数类已被标记为@internal ，不应从外部使用。如果您使用内部资源来扩展此库，请打开一个问题，以便可以添加和发布一个干净的界面。外部可用的类和枚举是：
  • ZipStreamCompressionMethod
  • ZipStreamException*
  • ZipStreamZipStream

存档选项

• 类ZipStreamOptionArchive已被替换为支持ZipStreamZipStream构造函数中的命名参数。
• 存档选项largeFileSize和largeFileMethod已被删除。如果您想要根据文件大小使用不同的compressionMethods ，则必须自己实现。
• 归档选项httpHeaderCallback将类型从callable更改为Closure 。
• 存档选项zeroHeader已替换为选项defaultEnableZeroHeader ，并且可以为每个文件覆盖。它的默认值从false更改为true 。
• 存档选项statFiles已被删除，因为库不再以这种方式检查文件大小。
• 存档选项deflateLevel已替换为选项defaultDeflateLevel ，并且可以为每个文件覆盖。
• ZipStreamZipStream构造函数的第一个参数 ( name ) 已替换为命名参数outputName 。
• 如果outputName为空，现在也会发送标头。如果您不想自动发送 http 标头，请将sendHttpHeaders设置为false 。

文件选项

• ZipStreamOptionFile类已被替换为ZipStreamZipStream->addFile*函数中的命名参数。
• 文件选项method已重命名为compressionMethod 。
• 文件选项time已重命名为lastModificationDateTime 。
• 文件选项size已重命名为maxSize 。

升级至2.0.0版本

https://github.com/maennchen/ZipStream-PHP/tree/2.0.0#upgrade-to-version-200

升级至1.0.0版本

https://github.com/maennchen/ZipStream-PHP/tree/2.0.0#upgrade-to-version-100

贡献

ZipStream-PHP 是一个协作项目。请查看 .github/CONTRIBUTING.md 文件。

版本支持

支持的版本如下表所示。

请不要打开任何与当前版本支持状态相矛盾的拉取请求。

小心：请务必检查main上的README以获取最新信息。

版本	新功能	错误修正	安全
3
2
1
0

该库与 PHP 核心支持保持一致。新功能和错误修复将仅根据当前状态针对 PHP 版本。

请参阅：https://www.php.net/supported-versions.php

关于作者

• 保罗·邓肯 [email protected] - https://pablotron.org/
• 乔纳坦·曼辰 [email protected] - https://maennchen.dev
• 杰西·G·多纳特 [email protected] - https://donatstudios.com
• 尼古拉斯·卡皮 [email protected] - https://www.deltablot.com
• 尼克·巴勒姆 [email protected] - https://www.brokencube.co.uk