ZipStream PHP

ZipStream-PHP

Instabiler Zweig

Der main ist nicht stabil. Eine stabile Version finden Sie in den Veröffentlichungen.

Überblick

Ein schneller und einfacher Streaming-Zip-Datei-Downloader für PHP. Die Verwendung dieser Bibliothek erspart Ihnen das Schreiben der Zip-Datei auf die Festplatte. Sie können es direkt an den Benutzer senden, was viel schneller ist. Es kann mit S3-Buckets oder jedem PSR7-Stream arbeiten.

Informationen zu Lizenz und Garantie finden Sie in der Datei LIZENZ.

Installation

Fügen Sie einfach eine Abhängigkeit von maennchen/zipstream-php zur Datei composer.json Ihres Projekts hinzu, wenn Sie Composer zum Verwalten der Abhängigkeiten Ihres Projekts verwenden. Verwenden Sie den folgenden Befehl, um das Paket zu den Abhängigkeiten Ihres Projekts hinzuzufügen:

composer require maennchen/zipstream-php

Verwendung

Detaillierte Anweisungen finden Sie in der Dokumentation.

 // 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 ();

Upgrade auf Version 3.0.0

Allgemein

• Mindestens PHP-Version: 8.1
• Es wird nur die 64-Bit-Architektur unterstützt.
• Die Klasse ZipStreamOptionMethod wurde durch die Enumeration ZipStreamCompressionMethod ersetzt.
• Die meisten Klassen wurden als @internal gekennzeichnet und sollten nicht von außen verwendet werden. Wenn Sie interne Ressourcen verwenden, um diese Bibliothek zu erweitern, öffnen Sie bitte ein Problem, damit eine saubere Schnittstelle hinzugefügt und veröffentlicht werden kann. Die extern verfügbaren Klassen und Aufzählungen sind:
  • ZipStreamCompressionMethod
  • ZipStreamException*
  • ZipStreamZipStream

Archivoptionen

• Die Klasse ZipStreamOptionArchive wurde durch benannte Argumente im ZipStreamZipStream Konstruktor ersetzt.
• Die Archivoptionen largeFileSize und largeFileMethod wurden entfernt. Wenn Sie basierend auf der Dateigröße unterschiedliche compressionMethods wünschen, müssen Sie dies selbst implementieren.
• Die Archivoption httpHeaderCallback hat den Typ von callable in Closure geändert.
• Die Archivoption zeroHeader wurde durch die Option defaultEnableZeroHeader ersetzt und kann für jede Datei überschrieben werden. Sein Standardwert wurde von false in true geändert.
• Die Archivoption statFiles wurde entfernt, da die Bibliothek die Dateigrößen nicht mehr auf diese Weise prüft.
• Die Archivoption deflateLevel wurde durch die Option defaultDeflateLevel ersetzt und kann für jede Datei überschrieben werden.
• Das erste Argument ( name ) des ZipStreamZipStream Konstruktors wurde durch das benannte Argument outputName ersetzt.
• Header werden jetzt auch gesendet, wenn der outputName leer ist. Wenn Sie nicht automatisch HTTP-Header senden möchten, legen Sie sendHttpHeaders auf false fest.

Dateioptionen

• Die Klasse ZipStreamOptionFile wurde durch benannte Argumente in den ZipStreamZipStream->addFile* -Funktionen ersetzt.
• Die method wurde in compressionMethod umbenannt.
• Die Dateioption time wurde in lastModificationDateTime umbenannt.
• Die size wurde in maxSize umbenannt.

Upgrade auf Version 2.0.0

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

Upgrade auf Version 1.0.0

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

Mitwirken

ZipStream-PHP ist ein Gemeinschaftsprojekt. Bitte werfen Sie einen Blick auf die Datei .github/CONTRIBUTING.md.

Versionsunterstützung

Die Versionen werden gemäß der folgenden Tabelle unterstützt.

Bitte öffnen Sie keine Pull-Requests, die im Widerspruch zum aktuellen Versions-Supportstatus stehen.

Achtung: Überprüfen Sie immer die README auf main um aktuelle Informationen zu erhalten.

Version	Neue Funktionen	Fehlerbehebungen	Sicherheit
3
2
1
0

Diese Bibliothek richtet sich nach der PHP-Kernunterstützung. Neue Funktionen und Bugfixes beziehen sich nur auf PHP-Versionen entsprechend ihrem aktuellen Status.

Siehe: https://www.php.net/supported-versions.php

Über die Autoren

• Paul Duncan [email protected] – https://pablotron.org/
• Jonatan Männchen [email protected] - https://maennchen.dev
• Jesse G. Donat [email protected] – https://donatstudios.com
• Nicolas CARPi [email protected] – https://www.deltablot.com
• Nik Barham [email protected] – https://www.brokencube.co.uk