The ZipArchive class

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

Introduction

A file archive, compressed with Zip.

Class synopsis

classZipArchiveimplementsCountable {

publicconstintCREATE;

publicconstintEXCL;

publicconstintCHECKCONS;

publicconstintOVERWRITE;

publicconstintRDONLY;

publicconstintFL_NOCASE;

publicconstintFL_NODIR;

publicconstintFL_COMPRESSED;

publicconstintFL_UNCHANGED;

publicconstintFL_RECOMPRESS;

publicconstintFL_ENCRYPTED;

publicconstintFL_OVERWRITE;

publicconstintFL_LOCAL;

publicconstintFL_CENTRAL;

publicconstintFL_ENC_GUESS;

publicconstintFL_ENC_RAW;

publicconstintFL_ENC_STRICT;

publicconstintFL_ENC_UTF_8;

publicconstintFL_ENC_CP437;

publicconstintFL_OPEN_FILE_NOW;

publicconstintCM_DEFAULT;

publicconstintCM_STORE;

publicconstintCM_SHRINK;

publicconstintCM_REDUCE_1;

publicconstintCM_REDUCE_2;

publicconstintCM_REDUCE_3;

publicconstintCM_REDUCE_4;

publicconstintCM_IMPLODE;

publicconstintCM_DEFLATE;

publicconstintCM_DEFLATE64;

publicconstintCM_PKWARE_IMPLODE;

publicconstintCM_BZIP2;

publicconstintCM_LZMA;

publicconstintCM_LZMA2;

publicconstintCM_ZSTD;

publicconstintCM_XZ;

publicconstintCM_TERSE;

publicconstintCM_LZ77;

publicconstintCM_WAVPACK;

publicconstintCM_PPMD;

publicconstintER_OK;

publicconstintER_MULTIDISK;

publicconstintER_RENAME;

publicconstintER_CLOSE;

publicconstintER_SEEK;

publicconstintER_READ;

publicconstintER_WRITE;

publicconstintER_CRC;

publicconstintER_ZIPCLOSED;

publicconstintER_NOENT;

publicconstintER_EXISTS;

publicconstintER_OPEN;

publicconstintER_TMPOPEN;

publicconstintER_ZLIB;

publicconstintER_MEMORY;

publicconstintER_CHANGED;

publicconstintER_COMPNOTSUPP;

publicconstintER_EOF;

publicconstintER_INVAL;

publicconstintER_NOZIP;

publicconstintER_INTERNAL;

publicconstintER_INCONS;

publicconstintER_REMOVE;

publicconstintER_DELETED;

publicconstintER_ENCRNOTSUPP;

publicconstintER_RDONLY;

publicconstintER_NOPASSWD;

publicconstintER_WRONGPASSWD;

publicconstintER_OPNOTSUPP;

publicconstintER_INUSE;

publicconstintER_TELL;

publicconstintER_COMPRESSED_DATA;

publicconstintER_CANCELLED;

publicconstintER_DATA_LENGTH;

publicconstintER_NOT_ALLOWED;

publicconstintAFL_RDONLY;

publicconstintAFL_IS_TORRENTZIP;

publicconstintAFL_WANT_TORRENTZIP;

publicconstintAFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE;

publicconstintOPSYS_DOS;

publicconstintOPSYS_AMIGA;

publicconstintOPSYS_OPENVMS;

publicconstintOPSYS_UNIX;

publicconstintOPSYS_VM_CMS;

publicconstintOPSYS_ATARI_ST;

publicconstintOPSYS_OS_2;

publicconstintOPSYS_MACINTOSH;

publicconstintOPSYS_Z_SYSTEM;

publicconstintOPSYS_CPM;

publicconstintOPSYS_WINDOWS_NTFS;

publicconstintOPSYS_MVS;

publicconstintOPSYS_VSE;

publicconstintOPSYS_ACORN_RISC;

publicconstintOPSYS_VFAT;

publicconstintOPSYS_ALTERNATE_MVS;

publicconstintOPSYS_BEOS;

publicconstintOPSYS_TANDEM;

publicconstintOPSYS_OS_400;

publicconstintOPSYS_OS_X;

publicconstintOPSYS_DEFAULT;

publicconstintEM_NONE;

publicconstintEM_TRAD_PKWARE;

publicconstintEM_AES_128;

publicconstintEM_AES_192;

publicconstintEM_AES_256;

publicconstintEM_UNKNOWN;

publicconststringLIBZIP_VERSION;

publicconstintLENGTH_TO_END;

publicconstintLENGTH_UNCHECKED;

publicreadonlyint$lastId;

publicreadonlyint$status;

publicreadonlyint$statusSys;

publicreadonlyint$numFiles;

publicreadonlystring$filename;

publicreadonlystring$comment;

publicaddEmptyDir(string$dirname, int$flags = 0): bool

publicaddFile(
    string$filepath,
    string$entryname = "",
    int$start = 0,
    int$length = ZipArchive::LENGTH_TO_END,
    int$flags = ZipArchive::FL_OVERWRITE
): bool

publicaddFromString(string$name, string$content, int$flags = ZipArchive::FL_OVERWRITE): bool

publicaddGlob(string$pattern, int$flags = 0, array$options = []): array|false

publicaddPattern(string$pattern, string$path = ".", array$options = []): array|false

publicclearError(): void

publicclose(): bool

publiccount(): int

publicdeleteIndex(int$index): bool

publicdeleteName(string$name): bool

publicextractTo(string$pathto, array|string|null$files = null): bool

publicgetArchiveComment(int$flags = 0): string|false

publicgetArchiveFlag(int$flag, int$flags = 0): int

publicgetCommentIndex(int$index, int$flags = 0): string|false

publicgetCommentName(string$name, int$flags = 0): string|false

publicgetExternalAttributesIndex(
    int$index,
    int&$opsys,
    int&$attr,
    int$flags = 0
): bool

publicgetExternalAttributesName(
    string$name,
    int&$opsys,
    int&$attr,
    int$flags = 0
): bool

publicgetFromIndex(int$index, int$len = 0, int$flags = 0): string|false

publicgetFromName(string$name, int$len = 0, int$flags = 0): string|false

publicgetNameIndex(int$index, int$flags = 0): string|false

publicgetStatusString(): string

publicgetStream(string$name): resource|false

publicgetStreamIndex(int$index, int$flags = 0): resource|false

publicgetStreamName(string$name, int$flags = 0): resource|false

publicstaticisCompressionMethodSupported(int$method, bool$enc = true): bool

publicstaticisEncryptionMethodSupported(int$method, bool$enc = true): bool

publiclocateName(string$name, int$flags = 0): int|false

publicopen(string$filename, int$flags = 0): bool|int

publicregisterCancelCallback(callable$callback): bool

publicregisterProgressCallback(float$rate, callable$callback): bool

publicrenameIndex(int$index, string$new_name): bool

publicrenameName(string$name, string$new_name): bool

publicreplaceFile(
    string$filepath,
    int$index,
    int$start = 0,
    int$length = ZipArchive::LENGTH_TO_END,
    int$flags = 0
): bool

publicsetArchiveComment(string$comment): bool

publicsetArchiveFlag(int$flag, int$value): bool

publicsetCommentIndex(int$index, string$comment): bool

publicsetCommentName(string$name, string$comment): bool

publicsetCompressionIndex(int$index, int$method, int$compflags = 0): bool

publicsetCompressionName(string$name, int$method, int$compflags = 0): bool

publicsetEncryptionIndex(int$index, int$method, ?string$password = null): bool

publicsetEncryptionName(string$name, int$method, ?string$password = null): bool

publicsetExternalAttributesIndex(
    int$index,
    int$opsys,
    int$attr,
    int$flags = 0
): bool

publicsetExternalAttributesName(
    string$name,
    int$opsys,
    int$attr,
    int$flags = 0
): bool

publicsetMtimeIndex(int$index, int$timestamp, int$flags = 0): bool

publicsetMtimeName(string$name, int$timestamp, int$flags = 0): bool

publicsetPassword(string$password): bool

publicstatIndex(int$index, int$flags = 0): array|false

publicstatName(string$name, int$flags = 0): array|false

publicunchangeAll(): bool

publicunchangeArchive(): bool

publicunchangeIndex(int$index): bool

publicunchangeName(string$name): bool

}

Properties

lastId: Index value of last added entry (file or directory). Available as of PHP 8.0.0 and PECL zip 1.18.0.
status: Status of the Zip Archive. Available for closed archive, as of PHP 8.0.0 and PECL zip 1.18.0.
statusSys: System status of the Zip Archive. Available for closed archive, as of PHP 8.0.0 and PECL zip 1.18.0.
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::clearError — Clear the status error message, system and/or zip messages
ZipArchive::close — Close the active archive (opened or newly created)
ZipArchive::count — Counts the number of files in the archive
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::getArchiveFlag — Returns the value of a Zip archive global flag
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::getStreamIndex — Get a file handler to the entry defined by its index (read only)
ZipArchive::getStreamName — Get a file handler to the entry defined by its name (read only)
ZipArchive::isCompressionMethodSupported — Check if a compression method is supported by libzip
ZipArchive::isEncryptionMethodSupported — Check if a encryption method is supported by libzip
ZipArchive::locateName — Returns the index of the entry in the archive
ZipArchive::open — Open a ZIP file archive
ZipArchive::registerCancelCallback — Register a callback to allow cancellation during archive close.
ZipArchive::registerProgressCallback — Register a callback to provide updates during archive close.
ZipArchive::renameIndex — Renames an entry defined by its index
ZipArchive::renameName — Renames an entry defined by its name
ZipArchive::replaceFile — Replace file in ZIP archive with a given path
ZipArchive::setArchiveComment — Set the comment of a ZIP archive
ZipArchive::setArchiveFlag — Set a global flag 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::setCompressionIndex — Set the compression method of an entry defined by its index
ZipArchive::setCompressionName — Set the compression method of an entry defined by its name
ZipArchive::setEncryptionIndex — Set the encryption method of an entry defined by its index
ZipArchive::setEncryptionName — Set the encryption method 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::setMtimeIndex — Set the modification time of an entry defined by its index
ZipArchive::setMtimeName — Set the modification time of an entry defined by its name
ZipArchive::setPassword — Set the password for the active archive
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