PHP ZipArchive class
The PHP ZipArchive class represents a file archive, compressed with Zip.
Class synopsis
class ZipArchive implements Countable { //Properties public readonly int $lastId; public readonly int $status; public readonly int $statusSys; public readonly int $numFiles; public readonly string $filename; public readonly string $comment; //Methods public addEmptyDir(string $dirname, int $flags = 0): bool public addFile(string $filepath, string $entryname = "", int $start = 0, int $length = 0, int $flags = ZipArchive::FL_OVERWRITE): bool public addFromString(string $name, string $content, int $flags = ZipArchive::FL_OVERWRITE): bool public addGlob(string $pattern, int $flags = 0, array $options = []): array|false public addPattern(string $pattern, string $path = ".", array $options = []): array|false public clearError(): void public close(): bool public count(): int public deleteIndex(int $index): bool public deleteName(string $name): bool public extractTo(string $pathto, array|string|null $files = null): bool public getArchiveComment(int $flags = 0): string|false public getCommentIndex(int $index, int $flags = 0): string|false public getCommentName(string $name, int $flags = 0): string|false public GetExternalAttributesIndex(int $index, int &$opsys, int &$attr, int $flags = ?): bool public getExternalAttributesName(string $name, int &$opsys, int &$attr, int $flags = 0): bool public getFromIndex(int $index, int $len = 0, int $flags = 0): string|false public getFromName(string $name, int $len = 0, int $flags = 0): string|false public getNameIndex(int $index, int $flags = 0): string|false public getStatusString(): string public getStream(string $name): resource|false public getStreamIndex(int $index, int $flags = 0): resource|false public getStreamName(string $name, int $flags = 0): resource|false public static isCompressionMethodSupported(int $method, bool $enc = true): bool public static isEncryptionMethodSupported(int $method, bool $enc = true): bool public locateName(string $name, int $flags = 0): int|false public open(string $filename, int $flags = 0): bool|int public registerCancelCallback(callable $callback): bool public registerProgressCallback(float $rate, callable $callback): bool public renameIndex(int $index, string $new_name): bool public renameName(string $name, string $new_name): bool public replaceFile(string $filepath, string $index, int $start = 0, int $length = 0, int $flags = 0 ): bool public setArchiveComment(string $comment): bool public setCommentIndex(int $index, string $comment): bool public setCommentName(string $name, string $comment): bool public setCompressionIndex(int $index, int $method, int $compflags = 0): bool public setCompressionName(string $name, int $method, int $compflags = 0): bool public setEncryptionIndex(int $index, int $method, ?string $password = null): bool public setEncryptionName(string $name, int $method, ?string $password = null): bool public setExternalAttributesIndex(int $index, int $opsys, int $attr, int $flags = 0): bool public setExternalAttributesName(string $name, int $opsys, int $attr, int $flags = 0 ): bool public setMtimeIndex(int $index, int $timestamp, int $flags = 0): bool public setMtimeName(string $name, int $timestamp, int $flags = 0): bool public setPassword(string $password): bool public statIndex(int $index, int $flags = 0): array|false public statName(string $name, int $flags = 0): array|false public unchangeAll(): bool public unchangeArchive(): bool public unchangeIndex(int $index): bool public unchangeName(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. |
❮ PHP Zip Reference