CLXXXVII. Zip File Functions

Introduction

This extension enables you to transparently read or write ZIP compressed archives and the files inside them.

Requirements

PHP 4

The bundled PHP 4 version requires ZZIPlib, by Guido Draheim, version 0.10.6 or later

PHP 5.2.0 or later

This extension uses the functions of zlib by Jean-loup Gailly and Mark Adler.

Installation

PHP 4

Note: Zip support before PHP 4.1.0 is experimental.

Warning

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

Information for installing this PECL extension may be found in the manual chapter titled Installation of PECL extensions. Additional information such as new releases, downloads, source files, maintainer information, and a CHANGELOG, can be located here: http://pecl.php.net/package/zip.

The DLL for this PECL extension may be downloaded from either the PHP Downloads page or from http://pecl4win.php.net/

In PHP 4 this DLL resides in the extensions/ directory within the PHP Windows binaries download.

Runtime Configuration

This extension has no configuration directives defined in php.ini.

Resource Types

There are two resource types used in the Zip module. The first one is the Zip directory for the Zip archive, the second Zip Entry for the archive entries.

Predefined Constants

The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime.

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

Examples

Example 1. Create a Zip archive

<?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. Dump the archive details and listing

<?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, read an OpenOffice meta info

<?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);
?>

This example uses the old API (PHP 4), it opens a ZIP file archive, reads each file in the archive and prints out its contents. The test2.zip archive used in this example is one of the test archives in the ZZIPlib source distribution.

Example 4. Zip Usage Example

<?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);

}
?>
Table of Contents
zip_close -- Close a ZIP file archive
zip_entry_close -- Close a directory entry
zip_entry_compressedsize -- Retrieve the compressed size of a directory entry
zip_entry_compressionmethod -- Retrieve the compression method of a directory entry
zip_entry_filesize -- Retrieve the actual file size of a directory entry
zip_entry_name -- Retrieve the name of a directory entry
zip_entry_open -- Open a directory entry for reading
zip_entry_read -- Read from an open directory entry
zip_open -- Open a ZIP file archive
zip_read -- Read next entry in a ZIP file archive
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.