# Zip

# Introduction

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

- Installing/Configuring
  - Requirements
  - Installation
  - Resource Types
- Predefined Constants
- Examples
- ZipArchive — The ZipArchive class
  - 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
- Zip Functions
  - 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

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open