PHP Manual»Zip»ZipArchive

A classe ZipArchive

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

Um arquivo compactado com Zip.

class ZipArchive implements Countable {

/* Constantes */

public const int CREATE;

public const int EXCL;

public const int CHECKCONS;

public const int OVERWRITE;

public const int RDONLY;

public const int FL_NOCASE;

public const int FL_NODIR;

public const int FL_COMPRESSED;

public const int FL_UNCHANGED;

public const int FL_RECOMPRESS;

public const int FL_ENCRYPTED;

public const int FL_OVERWRITE;

public const int FL_LOCAL;

public const int FL_CENTRAL;

public const int FL_ENC_GUESS;

public const int FL_ENC_RAW;

public const int FL_ENC_STRICT;

public const int FL_ENC_UTF_8;

public const int FL_ENC_CP437;

public const int FL_OPEN_FILE_NOW;

public const int CM_DEFAULT;

public const int CM_STORE;

public const int CM_SHRINK;

public const int CM_REDUCE_1;

public const int CM_REDUCE_2;

public const int CM_REDUCE_3;

public const int CM_REDUCE_4;

public const int CM_IMPLODE;

public const int CM_DEFLATE;

public const int CM_DEFLATE64;

public const int CM_PKWARE_IMPLODE;

public const int CM_BZIP2;

public const int CM_LZMA;

public const int CM_LZMA2;

public const int CM_ZSTD;

public const int CM_XZ;

public const int CM_TERSE;

public const int CM_LZ77;

public const int CM_WAVPACK;

public const int CM_PPMD;

public const int ER_OK;

public const int ER_MULTIDISK;

public const int ER_RENAME;

public const int ER_CLOSE;

public const int ER_SEEK;

public const int ER_READ;

public const int ER_WRITE;

public const int ER_CRC;

public const int ER_ZIPCLOSED;

public const int ER_NOENT;

public const int ER_EXISTS;

public const int ER_OPEN;

public const int ER_TMPOPEN;

public const int ER_ZLIB;

public const int ER_MEMORY;

public const int ER_CHANGED;

public const int ER_COMPNOTSUPP;

public const int ER_EOF;

public const int ER_INVAL;

public const int ER_NOZIP;

public const int ER_INTERNAL;

public const int ER_INCONS;

public const int ER_REMOVE;

public const int ER_DELETED;

public const int ER_ENCRNOTSUPP;

public const int ER_RDONLY;

public const int ER_NOPASSWD;

public const int ER_WRONGPASSWD;

public const int ER_OPNOTSUPP;

public const int ER_INUSE;

public const int ER_TELL;

public const int ER_COMPRESSED_DATA;

public const int ER_CANCELLED;

public const int ER_DATA_LENGTH;

public const int ER_NOT_ALLOWED;

public const int ER_TRUNCATED_ZIP;

public const int AFL_RDONLY;

public const int AFL_IS_TORRENTZIP;

public const int AFL_WANT_TORRENTZIP;

public const int AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE;

public const int OPSYS_DOS;

public const int OPSYS_AMIGA;

public const int OPSYS_OPENVMS;

public const int OPSYS_UNIX;

public const int OPSYS_VM_CMS;

public const int OPSYS_ATARI_ST;

public const int OPSYS_OS_2;

public const int OPSYS_MACINTOSH;

public const int OPSYS_Z_SYSTEM;

public const int OPSYS_CPM;

public const int OPSYS_WINDOWS_NTFS;

public const int OPSYS_MVS;

public const int OPSYS_VSE;

public const int OPSYS_ACORN_RISC;

public const int OPSYS_VFAT;

public const int OPSYS_ALTERNATE_MVS;

public const int OPSYS_BEOS;

public const int OPSYS_TANDEM;

public const int OPSYS_OS_400;

public const int OPSYS_OS_X;

public const int OPSYS_DEFAULT;

public const int EM_NONE;

public const int EM_TRAD_PKWARE;

public const int EM_AES_128;

public const int EM_AES_192;

public const int EM_AES_256;

public const int EM_UNKNOWN;

public const string LIBZIP_VERSION;

public const int LENGTH_TO_END;

public const int LENGTH_UNCHECKED;

/* Propriedades */

public readonly int $lastId;

public readonly int $status;

public readonly int $statusSys;

public readonly int $numFiles;

public readonly string $filename;

public readonly string $comment;

/* Métodos */

public function addEmptyDir(string $dirname, int $flags = 0): bool

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

public function addFromString(string $name, string $content, int $flags = ZipArchive::FL_OVERWRITE): bool

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

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

public function clearError(): void

public function close(): bool

public function count(): int

public function deleteIndex(int $index): bool

public function deleteName(string $name): bool

public function extractTo(string $pathto, array|string|null $files = null): bool

public function getArchiveComment(int $flags = 0): string|false

public function getArchiveFlag(int $flag, int $flags = 0): int

public function getCommentIndex(int $index, int $flags = 0): string|false

public function getCommentName(string $name, int $flags = 0): string|false

public function getExternalAttributesIndex(
    int $index,
    int &$opsys,
    int &$attr,
    int $flags = 0
): bool

public function getExternalAttributesName(
    string $name,
    int &$opsys,
    int &$attr,
    int $flags = 0
): bool

public function getFromIndex(int $index, int $len = 0, int $flags = 0): string|false

public function getFromName(string $name, int $len = 0, int $flags = 0): string|false

public function getNameIndex(int $index, int $flags = 0): string|false

public function getStatusString(): string

public function getStream(string $name): resource|false

public function getStreamIndex(int $index, int $flags = 0): resource|false

public function getStreamName(string $name, int $flags = 0): resource|false

public static function isCompressionMethodSupported(int $method, bool $enc = true): bool

public static function isEncryptionMethodSupported(int $method, bool $enc = true): bool

public function locateName(string $name, int $flags = 0): int|false

public function open(string $filename, int $flags = 0): bool|int

public function registerCancelCallback(callable $callback): bool

public function registerProgressCallback(float $rate, callable $callback): bool

public function renameIndex(int $index, string $new_name): bool

public function renameName(string $name, string $new_name): bool

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

public function setArchiveComment(string $comment): bool

public function setArchiveFlag(int $flag, int $value): bool

public function setCommentIndex(int $index, string $comment): bool

public function setCommentName(string $name, string $comment): bool

public function setCompressionIndex(int $index, int $method, int $compflags = 0): bool

public function setCompressionName(string $name, int $method, int $compflags = 0): bool

public function setEncryptionIndex(int $index, int $method, #[\SensitiveParameter] ?string $password = null): bool

public function setEncryptionName(string $name, int $method, #[\SensitiveParameter] ?string $password = null): bool

public function setExternalAttributesIndex(
    int $index,
    int $opsys,
    int $attr,
    int $flags = 0
): bool

public function setExternalAttributesName(
    string $name,
    int $opsys,
    int $attr,
    int $flags = 0
): bool

public function setMtimeIndex(int $index, int $timestamp, int $flags = 0): bool

public function setMtimeName(string $name, int $timestamp, int $flags = 0): bool

public function setPassword(#[\SensitiveParameter] string $password): bool

public function statIndex(int $index, int $flags = 0): array|false

public function statName(string $name, int $flags = 0): array|false

public function unchangeAll(): bool

public function unchangeArchive(): bool

public function unchangeIndex(int $index): bool

public function unchangeName(string $name): bool

}

lastId: Valor do índice da última entrada adicionada (arquivo ou diretório). Disponível a partir do PHP 8.0.0 e PECL zip 1.18.0.
status: Status do arquivo Zip. Disponível para arquivos fechados, a partir do PHP 8.0.0 e PECL zip 1.18.0.
statusSys: Status do sistema do arquivo Zip. Disponível para arquivos fechados, a partir do PHP 8.0.0 e PECL zip 1.18.0.
numFiles: Número de arquivos no arquivo Zip
filename: Nome do arquivo no sistema de arquivos
comment: Comentário para o arquivo Zip

Índice

ZipArchive::addEmptyDir — Adiciona um novo diretório
ZipArchive::addFile — Adiciona um arquivo a um arquivo ZIP a partir do caminho fornecido
ZipArchive::addFromString — Adiciona um arquivo a um arquivo ZIP usando seu conteúdo
ZipArchive::addGlob — Adicionar arquivos de um diretório por padrão glob
ZipArchive::addPattern — Adiciona arquivos de um diretório por padrão PCRE
ZipArchive::clearError — Limpa a mensagem de erro de status, mensagens do sistema e/ou do zip
ZipArchive::close — Fecha o arquivo de arquivo ativo (aberto ou recém-criado)
ZipArchive::count — Conta o número de arquivos no arquivo
ZipArchive::deleteIndex — Exclui uma entrada no arquivo usando seu índice
ZipArchive::deleteName — Exclui uma entrada no arquivo usando seu nome
ZipArchive::extractTo — Extrai o conteúdo do arquivo
ZipArchive::getArchiveComment — Retorna o comentário do arquivo Zip
ZipArchive::getArchiveFlag — Retorna o valor de uma opção global do arquivo Zip
ZipArchive::getCommentIndex — Retorna o comentário de uma entrada usando o índice da entrada
ZipArchive::getCommentName — Retorna o comentário de uma entrada usando o nome da entrada
ZipArchive::getExternalAttributesIndex — Recupera os atributos externos de uma entrada definida pelo seu índice
ZipArchive::getExternalAttributesName — Recupera os atributos externos de uma entrada definida pelo seu nome
ZipArchive::getFromIndex — Retorna o conteúdo da entrada usando seu índice
ZipArchive::getFromName — Retorna o conteúdo da entrada usando seu nome
ZipArchive::getNameIndex — Retorna o nome de uma entrada usando seu índice
ZipArchive::getStatusString — Retorna a mensagem de erro de status, mensagens do sistema e/ou zip
ZipArchive::getStream — Obtém um manipulador de arquivo para a entrada definida pelo seu nome (somente leitura)
ZipArchive::getStreamIndex — Obtém um manipulador de arquivo para a entrada definida pelo seu índice (somente leitura)
ZipArchive::getStreamName — Obtém um manipulador de arquivo para a entrada definida pelo seu nome (somente leitura)
ZipArchive::isCompressionMethodSupported — Verifica se um método de compressão é suportado pelo libzip
ZipArchive::isEncryptionMethodSupported — Verifica se um método de criptografia é suportado pelo libzip
ZipArchive::locateName — Retorna o índice da entrada no arquivo compactado
ZipArchive::open — Abre um arquivo compactado ZIP
ZipArchive::registerCancelCallback — Registra um callback para permitir o cancelamento durante o fechamento do arquivo compactado.
ZipArchive::registerProgressCallback — Registrar um callback para fornecer atualizações durante o fechamento do arquivo compactado.
ZipArchive::renameIndex — Renomeia uma entrada definida pelo seu índice
ZipArchive::renameName — Renomeia uma entrada definida pelo seu nome
ZipArchive::replaceFile — Substitui um arquivo no arquivo ZIP por um caminho fornecido
ZipArchive::setArchiveComment — Define o comentário de um arquivo ZIP
ZipArchive::setArchiveFlag — Define uma opção global de um arquivo ZIP
ZipArchive::setCommentIndex — Define o comentário de uma entrada definida pelo seu índice
ZipArchive::setCommentName — Define o comentário de uma entrada definida pelo seu nome
ZipArchive::setCompressionIndex — Define o método de compressão de uma entrada definida pelo seu índice
ZipArchive::setCompressionName — Define o método de compressão de uma entrada definida pelo seu nome
ZipArchive::setEncryptionIndex — Define o método de criptografia de uma entrada definida pelo seu índice
ZipArchive::setEncryptionName — Define o método de criptografia de uma entrada definida pelo seu nome
ZipArchive::setExternalAttributesIndex — Define os atributos externos de uma entrada definida pelo seu índice
ZipArchive::setExternalAttributesName — Define os atributos externos de uma entrada definida pelo seu nome
ZipArchive::setMtimeIndex — Define o tempo de modificação de uma entrada definida pelo seu índice
ZipArchive::setMtimeName — Define o tempo de modificação de uma entrada definida pelo seu nome
ZipArchive::setPassword — Define a senha para o arquivo ZIP ativo
ZipArchive::statIndex — Obtenha os detalhes de uma entrada definida pelo seu índice
ZipArchive::statName — Obtém os detalhes de uma entrada definida pelo seu nome
ZipArchive::unchangeAll — Desfaz todas as alterações feitas no arquivo
ZipArchive::unchangeArchive — Reverte todas as alterações globais feitas no arquivo
ZipArchive::unchangeIndex — Reverte todas as alterações feitas a uma entrada no índice fornecido
ZipArchive::unchangeName — Reverte todas as alterações feitas a uma entrada com o nome fornecido