ZipStream PHP

ZipStream-PHP

不安定なブランチ

mainブランチは安定していません。安定バージョンについてはリリースを参照してください。

概要

PHP 用の高速かつシンプルなストリーミング zip ファイル ダウンローダー。このライブラリを使用すると、Zip をディスクに書き込む手間が省けます。ユーザーに直接送信できるので、はるかに高速です。 S3 バケットまたは任意の PSR7 ストリームで動作します。

ライセンスおよび保証情報については、LICENSE ファイルを参照してください。

インストール

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
• Nicolas CARPi [email protected] - https://www.deltablot.com
• ニック・バーハム [email protected] - https://www.brokencube.co.uk