maennchen / ZipStream-PHP

ZipStream-PHP Unstable Branch The branch is not stable. Please see the releases for a stable version. Overview A fast and simple streaming zip file downloader for PHP. Using this library will save you from having to write the Zip to disk. You can directly send it to the user, which is much faster. It can work with S3 buckets or any PSR7 Stream. Please see the LICENSE file for licensing and warranty information. Installation Simply add a dependency on maennchen/zipstream-php to your project's file if you use Composer to manage the dependencies of your project. Use following command to add the package to your project's dependencies: Usage For detailed instructions, please check the Documentation. Callback Output You can stream ZIP data to a custom callback function instead of directly to the browser: Questions **💬 Questions? Please Read This First!** If you have a question about using this library, please *do not email the authors directly*. Instead, head over to the GitHub Discussions page — your question might already be answered there! Using Discussions helps build a shared knowledge base, so others can also benefit from the answers. If you need dedicated 1:1 support, check out the options available on @maennchen's sponsorship page. Upgrade to version 3.1.2 • Minimum PHP Version: Upgrade to version 3.0.0 General • Minimum PHP Version: • Only 64bit Architecture is supported. • The class has been replaced with the enum . • Most classes have been flagged as and should not be used from the outside. If you're using internal resources to extend this library, please open an issue so that a clean interface can be added & published. The externally available classes & enums are: • - • Archive Options • The class has been replaced in favor of named arguments in the constructor. • The archive options & has been removed. If you want different based on the file size, you'll have to implement this yourself. • The archive option changed the type from to . • The archive option has been replaced with the option and can be overridden for every file. Its default value changed from to . • The archive option was removed since the library no longer checks filesizes this way. • The archive option has been replaced with the option and can be overridden for every file. • The first argument ( ) of the constructor has been replaced with the named argument . • Headers are now also sent if the is empty. If you do not want to automatically send http headers, set to . File Options • The class has been replaced in favor of named arguments in the functions. • The file option has been renamed to . • The file option has been renamed to . • The file option has been renamed to . Upgrade to version 2.0.0 https://github.com/maennchen/ZipStream-PHP/tree/2.0.0#upgrade-to-version-200 Upgrade to version 1.0.0 https://github.com/maennchen/ZipStream-PHP/tree/2.0.0#upgrade-to-version-100 Contributing ZipStream-PHP is a collaborative project. Please take a look at the .github/CONTRIBUTING.md file. Version Support Versions are supported according to the table below. Please do not open any pull requests contradicting the current version support status. Careful: Always check the on for up-to-date information. | Version | New Features | Bugfixes | Security | |---------|--------------|----------|----------| | *3* | ✓ | ✓ | ✓ | | *2* | ✗ | ✗ | ✓ | | *1* | ✗ | ✗ | ✗ | | *0* | ✗ | ✗ | ✗ | This library aligns itself with the PHP core support. New features and bugfixes will only target PHP versions according to their current status. See: https://www.php.net/supported-versions.php About the Authors • Paul Duncan - https://pablotron.org/ • Jonatan Männchen - https://maennchen.dev • Jesse G. Donat - https://donatstudios.com • Nicolas CARPi - https://www.deltablot.com • Nik Barham - https://www.brokencube.co.uk