Zip File Functionen
Einführung
Diese Extension ermöglicht den transparenten Lese- und Schreibzugriff auf ZIP-komprimierte Archive und die darin enthaltenen Dateien.
Anforderungen
PHP 4
Die mit PHP 4 ausgelieferte Version der Extension benötigt die » ZZIPlib Bibliothek von Guido Draheim ab Version 0.10.6
PHP 5.2.0 und später
Die Extension nutzt nun Funktionalität der » zlib von Jean-loup Gailly und Mark Adler.
Installation
PHP 4
Hinweis: Zip support before PHP 4.1.0 is experimental.
Because the PHP 4 zip extension is unmaintained we recommend that the PECL extension is used rather than the bundled one.
Linux systems
In order to use these functions you must compile PHP with zip support by using the --with-zip[=DIR] configure option, where [DIR] is the prefix of the » ZZIPlib library install.
Windows
Windows users need to enable php_zip.dll inside of php.ini in order to use these functions.
PHP 5.2.0 and later
Linux systems
In order to use these functions you must compile PHP with zip support by using the --enable-zip configure option.
Windows
Windows users need to enable php_zip.dll inside of php.ini in order to use these functions.
Installation via PECL
Zusätzliche Informationen, wie neue Releases, Downloads Quelldateien, Maintainerinformation und ein CHANGELOG finden Sie hier: » https://pecl.php.net/package/zip.
Sie können die DLL für diese PECL Erweiterung entweder von » PHP Downloads oder von » https://snaps.php.net/ herunterladen.
Für PHP 4 finden Sie die DLL im extensions/ Verzeichnis der PHP Windows Binärdistribution.
Laufzeit Konfiguration
Diese Erweiterung definiert keine Konfigurationseinstellungen in der php.ini.
Resource Typen
Die Zip Extension benutzt zwei Resourcetypen, einen für Verzeichnisse innerhalb eines Zip-Archivs und einen für die eigentlichen Dateieinträge innerhalb des Archivs.
Vordefinierte Konstanten
Folgende Konstanten werden von dieser Erweiterung definiert und stehen nur zur Verfügung, wenn die Erweiterung entweder statisch in PHP kompiliert oder dynamisch zur Laufzeit geladen wurde.
ZipArchive uses class constants. There is three types of constants, Flags (FL_) errors (ER_) or mode (no prefix).
- ZIPARCHIVE::CREATE (integer)
- Create the archive if it does not exist.
- ZIPARCHIVE::OVERWRITE (integer)
- Always start a new archive, this mode will overwrite the file if it already exists.
- ZIPARCHIVE::EXCL (integer)
- Error if archive already exists.
- ZIPARCHIVE::CHECKCONS (integer)
- Perform additional consistency checks on the archive, and error if they fail.
- ZIPARCHIVE::FL_NOCASE (integer)
- Ignore case on name lookup
- ZIPARCHIVE::FL_NODIR (integer)
- Ignore directory component
- ZIPARCHIVE::FL_COMPRESSED (integer)
- Read compressed data
- ZIPARCHIVE::FL_UNCHANGED (integer)
- Use original data, ignoring changes.
- ZIPARCHIVE::CM_DEFAULT (integer)
- better of deflate or store.
- ZIPARCHIVE::CM_STORE (integer)
- stored (uncompressed).
- ZIPARCHIVE::CM_SHRINK (integer)
- shrunk
- ZIPARCHIVE::CM_REDUCE_1 (integer)
- reduced with factor 1
- ZIPARCHIVE::CM_REDUCE_2 (integer)
- reduced with factor 2
- ZIPARCHIVE::CM_REDUCE_3 (integer)
- reduced with factor 3
- ZIPARCHIVE::CM_REDUCE_4 (integer)
- reduced with factor 4
- ZIPARCHIVE::CM_IMPLODE (integer)
- imploded
- ZIPARCHIVE::CM_DEFLATE (integer)
- deflated
- ZIPARCHIVE::CM_DEFLATE64 (integer)
- deflate64
- ZIPARCHIVE::CM_PKWARE_IMPLODE (integer)
- PKWARE imploding
- ZIPARCHIVE::CM_BZIP2 (integer)
- BZIP2 algorithm
- ZIPARCHIVE::ER_OK (integer)
- No error.
- ZIPARCHIVE::ER_MULTIDISK (integer)
- Multi-disk zip archives not supported.
- ZIPARCHIVE::ER_RENAME (integer)
- Renaming temporary file failed.
- ZIPARCHIVE::ER_CLOSE (integer)
- Closing zip archive failed
- ZIPARCHIVE::ER_SEEK (integer)
- Seek error
- ZIPARCHIVE::ER_READ (integer)
- Read error
- ZIPARCHIVE::ER_WRITE (integer)
- Write error
- ZIPARCHIVE::ER_CRC (integer)
- CRC error
- ZIPARCHIVE::ER_ZIPCLOSED (integer)
- Containing zip archive was closed
- ZIPARCHIVE::ER_NOENT (integer)
- No such file.
- ZIPARCHIVE::ER_EXISTS (integer)
- File already exists
- ZIPARCHIVE::ER_OPEN (integer)
- Can't open file
- ZIPARCHIVE::ER_TMPOPEN (integer)
- Failure to create temporary file.
- ZIPARCHIVE::ER_ZLIB (integer)
- Zlib error
- ZIPARCHIVE::ER_MEMORY (integer)
- Memory allocation failure
- ZIPARCHIVE::ER_CHANGED (string)
- Entry has been changed
- ZIPARCHIVE::ER_COMPNOTSUPP (integer)
- Compression method not supported.
- ZIPARCHIVE::ER_EOF (integer)
- Premature EOF
- ZIPARCHIVE::ER_INVAL (integer)
- Invalid argument
- ZIPARCHIVE::ER_NOZIP (integer)
- Not a zip archive
- ZIPARCHIVE::ER_INTERNAL (integer)
- Internal error
- ZIPARCHIVE::ER_INCONS (integer)
- Zip archive inconsistent
- ZIPARCHIVE::ER_REMOVE (integer)
- Can't remove file
- ZIPARCHIVE::ER_DELETED (integer)
- Entry has been deleted
Beispiele
Example#1 Erstellen eines Zip-Archivs
<?php
$zip = new ZipArchive();
$filename = "./test112.zip";
if ($zip->open($filename, ZIPARCHIVE::CREATE)!==TRUE) {
exit("cannot open <$filename>\n");
}
$zip->addFromString("testfilephp.txt" . time(), "#1 This is a test string added as testfilephp.txt.\n");
$zip->addFromString("testfilephp2.txt" . time(), "#2 This is a test string added as testfilephp2.txt.\n");
$zip->addFile($thisdir . "/too.php","/testfromfile.php");
echo "numfiles: " . $zip->numFiles . "\n";
echo "status:" . $zip->status . "\n";
$zip->close();
?>
Example#2 Ausgabe eines detailierten Archivlistings
<?php
$za = new ZipArchive();
$za->open('test_with_comment.zip');
print_r($za);
var_dump($za);
echo "numFiles: " . $za->numFiles . "\n";
echo "status: " . $za->status . "\n";
echo "statusSys: " . $za->statusSys . "\n";
echo "filename: " . $za->filename . "\n";
echo "comment: " . $za->comment . "\n";
for ($i=0; $i<$za->numFiles;$i++) {
echo "index: $i\n";
print_r($za->statIndex($i));
}
echo "numFile:" . $za->numFiles . "\n";
?>
Example#3 Zip Stream Wrapper, Auslesen von OpenOffice Metainformationen
<?php
$reader = new XMLReader();
$reader->open('zip://' . dirname(__FILE__) . '/test.odt#meta.xml');
$odt_meta = array();
while ($reader->read()) {
if ($reader->nodeType == XMLREADER::ELEMENT) {
$elm = $reader->name;
} else {
if ($reader->nodeType == XMLREADER::END_ELEMENT && $reader->name == 'office:meta') {
break;
}
if (!trim($reader->value)) {
continue;
}
$odt_meta[$elm] = $reader->value;
}
}
print_r($odt_meta);
?>
Das folgende Beispiel benutzt das alte PHP 4 API, es öffnet eine Zip-Datei, liest jede einzelne Datei im Archiv und gibt deren Inhalt aus. Die in diesem Beispiel genutzte test2.zip Datei ist Teil des Testarchivs des ZZIPlib Quellcodes.
Example#4 Zip Beispiel
<?php
$zip = zip_open("/tmp/test2.zip");
if ($zip) {
while ($zip_entry = zip_read($zip)) {
echo "Name: " . zip_entry_name($zip_entry) . "\n";
echo "Actual Filesize: " . zip_entry_filesize($zip_entry) . "\n";
echo "Compressed Size: " . zip_entry_compressedsize($zip_entry) . "\n";
echo "Compression Method: " . zip_entry_compressionmethod($zip_entry) . "\n";
if (zip_entry_open($zip, $zip_entry, "r")) {
echo "File Contents:\n";
$buf = zip_entry_read($zip_entry, zip_entry_filesize($zip_entry));
echo "$buf\n";
zip_entry_close($zip_entry);
}
echo "\n";
}
zip_close($zip);
}
?>
Inhaltsverzeichnis
- zip_close — Schließt ein ZIP Archiv
- zip_entry_close — Schließt einen Verzeichniseintrag
- zip_entry_compressedsize — Ermittelt die komprimierte Größe eines Verzeichniseintrages
- zip_entry_compressionmethod — Gibt die Komprimierungsmethode eines Verzeichniseintrages zurück.
- zip_entry_filesize — Gibt die Größe eines Verzeichniseintrages zurück
- zip_entry_name — Gibt den Namen eines Verzeichniseintrages zurück
- zip_entry_open — Öffnet einen Verzeichniseintrag für den Lesezugriff
- zip_entry_read — Liest einen geöffneten Verzeichniseintrag aus
- zip_open — Öffnet ein ZIP Archiv
- zip_read — Liest den nächsten Eintrag innerhalb des ZIP Archivs
- ZipArchive::addEmptyDir — Add a new directory
- ZipArchive::addFile — Adds a file to a ZIP archive from the given path
- ZipArchive::addFromString — Add a file to a ZIP archive using its contents
- ZipArchive::close — Close the active archive (opened or newly created)
- ZipArchive::deleteIndex — delete an entry in the archive using its index
- ZipArchive::deleteName — delete an entry in the archive using its name
- ZipArchive::extractTo — Extract the archive contents
- ZipArchive::getArchiveComment — Returns the Zip archive comment
- ZipArchive::getCommentIndex — Returns the comment of an entry using the entry index
- ZipArchive::getCommentName — Returns the comment of an entry using the entry name
- ZipArchive::getFromIndex — Returns the entry contents using its index.
- ZipArchive::getFromName — Returns the entry contents using its name.
- ZipArchive::getNameIndex — Returns the name of an entry using its index
- ZipArchive::getStream — Get a file handler to the entry defined by its name (read only).
- ZipArchive::locateName — Returns the index of the entry in the archive
- ZipArchive::open — Open a ZIP file archive
- ZipArchive::renameIndex — Renames an entry defined by its index
- ZipArchive::renameName — Renames an entry defined by its name
- ZipArchive::setArchiveComment — Set the comment of a ZIP archive
- ZipArchive::setCommentIndex — Set the comment of an entry defined by its index
- ZipArchive::setCommentName — Set the comment of an entry defined by its name
- ZipArchive::statIndex — Get the details of an entry defined by its index.
- ZipArchive::statName — Get the details of an entry defined by its name.
- ZipArchive::unchangeAll — Undo all changes done in the archive.
- ZipArchive::unchangeArchive — Revert all global changes done in the archive.
- ZipArchive::unchangeIndex — Revert all changes done to an entry at the given index.
- ZipArchive::unchangeName — Revert all changes done to an entry with the given name.