The ZipArchive class

(PHP 5 >= 5.2.0, PECL zip >= 1.1.0)

Introduction

A file archive, compressed with Zip.

Class synopsis

ZipArchive {

/* Properties */

int $status;

int $statusSys;

int $numFiles;

string $filename;

string $comment;

/* Methods */

bool addEmptyDir ( string $dirname )

bool addFile ( string $filename [, string $localname = NULL [, int $start = 0 [, int $length = 0 ]]] )

bool addFromString ( string $localname , string $contents )

bool addGlob ( string $pattern [, int $flags = 0 [, array $options = array() ]] )

bool addPattern ( string $pattern [, string $path = '.' [, array $options = array() ]] )

bool close ( void )

bool deleteIndex ( int $index )

bool deleteName ( string $name )

bool extractTo ( string $destination [, mixed $entries ] )

string getArchiveComment ([ int $flags ] )

string getCommentIndex ( int $index [, int $flags ] )

string getCommentName ( string $name [, int $flags ] )

bool GetExternalAttributesIndex ( int $index , int &$opsys , int &$attr [, int $flags ] )

bool getExternalAttributesName ( string $name , int &$opsys , int &$attr [, int $flags ] )

string getFromIndex ( int $index [, int $length = 0 [, int $flags ]] )

string getFromName ( string $name [, int $length = 0 [, int $flags ]] )

string getNameIndex ( int $index [, int $flags ] )

string getStatusString ( void )

resource getStream ( string $name )

int locateName ( string $name [, int $flags ] )

mixed open ( string $filename [, int $flags ] )

bool renameIndex ( int $index , string $newname )

bool renameName ( string $name , string $newname )

bool setArchiveComment ( string $comment )

bool setCommentIndex ( int $index , string $comment )

bool setCommentName ( string $name , string $comment )

bool setExternalAttributesIndex ( int $index , int $opsys , int $attr [, int $flags ] )

bool setExternalAttributesName ( string $name , int $opsys , int $attr [, int $flags ] )

array statIndex ( int $index [, int $flags ] )

array statName ( string $name [, int $flags ] )

bool unchangeAll ( void )

bool unchangeArchive ( void )

bool unchangeIndex ( int $index )

bool unchangeName ( string $name )

}

Properties

status: Status of the Zip Archive
statusSys: System status of the Zip Archive
numFiles: Number of files in archive
filename: File name in the file system
comment: Comment for the archive

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::addGlob — Add files from a directory by glob pattern
ZipArchive::addPattern — Add files from a directory by PCRE pattern
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::getExternalAttributesIndex — Retrieve the external attributes of an entry defined by its index
ZipArchive::getExternalAttributesName — Retrieve the external attributes of an entry defined by its 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::getStatusString — Returns the status error message, system and/or zip messages
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::setExternalAttributesIndex — Set the external attributes of an entry defined by its index
ZipArchive::setExternalAttributesName — Set the external attributes 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.

The ZipArchive class

Introduction

Class synopsis

Properties

Table of Contents