php_zip.stub.php

Go to the documentation of this file.

<?php


#[\Deprecated(since: '8.0', message: 'use ZipArchive::open() instead')]
function zip_open(string $filename) {}

#[\Deprecated(since: '8.0', message: 'use ZipArchive::close() instead')]
function zip_close($zip): void {}

#[\Deprecated(since: '8.0', message: 'use ZipArchive::statIndex() instead')]
function zip_read($zip) {}

#[\Deprecated(since: '8.0')]
function zip_entry_open($zip_dp, $zip_entry, string $mode = "rb"): bool {}

#[\Deprecated(since: '8.0')]
function zip_entry_close($zip_entry): bool {}

#[\Deprecated(since: '8.0', message: 'use ZipArchive::getFromIndex() instead')]
function zip_entry_read($zip_entry, int $len = 1024): string|false {}

#[\Deprecated(since: '8.0', message: 'use ZipArchive::statIndex() instead')]
function zip_entry_name($zip_entry): string|false {}

#[\Deprecated(since: '8.0', message: 'use ZipArchive::statIndex() instead')]
function zip_entry_compressedsize($zip_entry): int|false {}

#[\Deprecated(since: '8.0', message: 'use ZipArchive::statIndex() instead')]
function zip_entry_filesize($zip_entry): int|false {}

#[\Deprecated(since: '8.0', message: 'use ZipArchive::statIndex() instead')]
function zip_entry_compressionmethod($zip_entry): string|false {}
 
class ZipArchive implements Countable
{
    public const int CREATE = UNKNOWN;
    public const int EXCL = UNKNOWN;
    public const int CHECKCONS = UNKNOWN;
    public const int OVERWRITE = UNKNOWN;
#ifdef ZIP_RDONLY
    public const int RDONLY = UNKNOWN;
#endif

    public const int FL_NOCASE = UNKNOWN;
    public const int FL_NODIR = UNKNOWN;
    public const int FL_COMPRESSED = UNKNOWN;
    public const int FL_UNCHANGED = UNKNOWN;
/* deprecated in libzip 1.10.0 */
#ifdef ZIP_FL_RECOMPRESS
    #[\Deprecated(since: '8.3')]
    public const int FL_RECOMPRESS = UNKNOWN;
#endif
    public const int FL_ENCRYPTED = UNKNOWN;
    public const int FL_OVERWRITE = UNKNOWN;
    public const int FL_LOCAL = UNKNOWN;
    public const int FL_CENTRAL = UNKNOWN;
 
    /* Default filename encoding policy. */

    public const int FL_ENC_GUESS = UNKNOWN;
    public const int FL_ENC_RAW = UNKNOWN;
    public const int FL_ENC_STRICT = UNKNOWN;
    public const int FL_ENC_UTF_8 = UNKNOWN;
    public const int FL_ENC_CP437 = UNKNOWN;

    public const int FL_OPEN_FILE_NOW = UNKNOWN;

    public const int CM_DEFAULT = UNKNOWN;
    public const int CM_STORE = UNKNOWN;
    public const int CM_SHRINK = UNKNOWN;
    public const int CM_REDUCE_1 = UNKNOWN;
    public const int CM_REDUCE_2 = UNKNOWN;
    public const int CM_REDUCE_3 = UNKNOWN;
    public const int CM_REDUCE_4 = UNKNOWN;
    public const int CM_IMPLODE = UNKNOWN;
    public const int CM_DEFLATE = UNKNOWN;
    public const int CM_DEFLATE64 = UNKNOWN;
    public const int CM_PKWARE_IMPLODE = UNKNOWN;
    public const int CM_BZIP2 = UNKNOWN;
    public const int CM_LZMA = UNKNOWN;
#ifdef ZIP_CM_LZMA2
    public const int CM_LZMA2 = UNKNOWN;
#endif
 
#ifdef ZIP_CM_ZSTD
    public const int CM_ZSTD = UNKNOWN;
#endif
#ifdef ZIP_CM_XZ
    public const int CM_XZ = UNKNOWN;
#endif
    public const int CM_TERSE = UNKNOWN;
    public const int CM_LZ77 = UNKNOWN;
    public const int CM_WAVPACK = UNKNOWN;
    public const int CM_PPMD = UNKNOWN;
 
    /* Error code */

    public const int ER_OK = UNKNOWN;
    public const int ER_MULTIDISK = UNKNOWN;
    public const int ER_RENAME = UNKNOWN;
    public const int ER_CLOSE = UNKNOWN;
    public const int ER_SEEK = UNKNOWN;
    public const int ER_READ = UNKNOWN;
    public const int ER_WRITE = UNKNOWN;
    public const int ER_CRC = UNKNOWN;
    public const int ER_ZIPCLOSED = UNKNOWN;
    public const int ER_NOENT = UNKNOWN;
    public const int ER_EXISTS = UNKNOWN;
    public const int ER_OPEN = UNKNOWN;
    public const int ER_TMPOPEN = UNKNOWN;
    public const int ER_ZLIB = UNKNOWN;
    public const int ER_MEMORY = UNKNOWN;
    public const int ER_CHANGED = UNKNOWN;
    public const int ER_COMPNOTSUPP = UNKNOWN;
    public const int ER_EOF = UNKNOWN;
    public const int ER_INVAL = UNKNOWN;
    public const int ER_NOZIP = UNKNOWN;
    public const int ER_INTERNAL = UNKNOWN;
    public const int ER_INCONS = UNKNOWN;
    public const int ER_REMOVE = UNKNOWN;
    public const int ER_DELETED = UNKNOWN;
    public const int ER_ENCRNOTSUPP = UNKNOWN;
    public const int ER_RDONLY = UNKNOWN;
    public const int ER_NOPASSWD = UNKNOWN;
    public const int ER_WRONGPASSWD = UNKNOWN;
 
    /* since 1.0.0 */
#ifdef ZIP_ER_OPNOTSUPP
    public const int ER_OPNOTSUPP = UNKNOWN;
#endif
#ifdef ZIP_ER_INUSE
    public const int ER_INUSE = UNKNOWN;
#endif
#ifdef ZIP_ER_TELL
    public const int ER_TELL = UNKNOWN;
#endif
 
    /* since 1.6.0 */
#ifdef ZIP_ER_COMPRESSED_DATA
    public const int ER_COMPRESSED_DATA = UNKNOWN;
#endif
#ifdef ZIP_ER_CANCELLED
    public const int ER_CANCELLED = UNKNOWN;
#endif
 
    /* since 1.10.0 */
#ifdef ZIP_ER_DATA_LENGTH
    public const int ER_DATA_LENGTH = UNKNOWN;
#endif
#ifdef ZIP_ER_NOT_ALLOWED
    public const int ER_NOT_ALLOWED = UNKNOWN;
#endif
#ifdef ZIP_ER_TRUNCATED_ZIP
    public const int ER_TRUNCATED_ZIP = UNKNOWN;
#endif
#ifdef ZIP_AFL_RDONLY
    public const int AFL_RDONLY = UNKNOWN;
#endif
#ifdef ZIP_AFL_IS_TORRENTZIP
    public const int AFL_IS_TORRENTZIP = UNKNOWN;
#endif
#ifdef ZIP_AFL_WANT_TORRENTZIP
    public const int AFL_WANT_TORRENTZIP = UNKNOWN;
#endif
#ifdef ZIP_AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE
    public const int AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE = UNKNOWN;
#endif
 
#ifdef ZIP_OPSYS_DEFAULT
    public const int OPSYS_DOS = UNKNOWN;
    public const int OPSYS_AMIGA = UNKNOWN;
    public const int OPSYS_OPENVMS = UNKNOWN;
    public const int OPSYS_UNIX = UNKNOWN;
    public const int OPSYS_VM_CMS = UNKNOWN;
    public const int OPSYS_ATARI_ST = UNKNOWN;
    public const int OPSYS_OS_2 = UNKNOWN;
    public const int OPSYS_MACINTOSH = UNKNOWN;
    public const int OPSYS_Z_SYSTEM = UNKNOWN;
    public const int OPSYS_CPM = UNKNOWN;
    public const int OPSYS_WINDOWS_NTFS = UNKNOWN;
    public const int OPSYS_MVS = UNKNOWN;
    public const int OPSYS_VSE = UNKNOWN;
    public const int OPSYS_ACORN_RISC = UNKNOWN;
    public const int OPSYS_VFAT = UNKNOWN;
    public const int OPSYS_ALTERNATE_MVS = UNKNOWN;
    public const int OPSYS_BEOS = UNKNOWN;
    public const int OPSYS_TANDEM = UNKNOWN;
    public const int OPSYS_OS_400 = UNKNOWN;
    public const int OPSYS_OS_X = UNKNOWN;
    public const int OPSYS_DEFAULT = UNKNOWN;
#endif

    public const int EM_NONE = UNKNOWN;
    public const int EM_TRAD_PKWARE = UNKNOWN;
#ifdef HAVE_ENCRYPTION
    public const int EM_AES_128 = UNKNOWN;
    public const int EM_AES_192 = UNKNOWN;
    public const int EM_AES_256 = UNKNOWN;
#endif
    public const int EM_UNKNOWN = UNKNOWN;

    public const string LIBZIP_VERSION = UNKNOWN;

    public const int LENGTH_TO_END = UNKNOWN;
    /* since 1.10.1 */
#ifdef ZIP_LENGTH_UNCHECKED
    public const int LENGTH_UNCHECKED = UNKNOWN;
#endif

    public int $lastId;
    public int $status;
    public int $statusSys;
    public int $numFiles;
    public string $filename;
    public string $comment;

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

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

    public function close(): bool {}

    public function count(): int {}

    public function getStatusString(): string {}
 
    public function clearError(): void {}

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

    public function addFromString(string $name, string $content, int $flags = ZipArchive::FL_OVERWRITE): 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 replaceFile(string $filepath, int $index, int $start = 0, int $length = ZipArchive::LENGTH_TO_END, int $flags = 0): 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 renameIndex(int $index, string $new_name): bool {}

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

    public function setArchiveComment(string $comment): bool {}

    public function getArchiveComment(int $flags = 0): string|false {}
 
    public function setArchiveFlag(int $flag, int $value): bool {}
 
    public function getArchiveFlag(int $flag, int $flags = 0): int {}

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

    public function setCommentName(string $name, string $comment): bool {}
 
#ifdef HAVE_SET_MTIME
    public function setMtimeIndex(int $index, int $timestamp, int $flags = 0): bool {}

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

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

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

    public function deleteIndex(int $index): bool {}

    public function deleteName(string $name): bool {}

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

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

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

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

    public function unchangeArchive(): bool {}

    public function unchangeAll(): bool {}

    public function unchangeIndex(int $index): bool {}

    public function unchangeName(string $name): bool {}

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

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

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

    public function getStreamIndex(int $index, int $flags = 0) {}

    public function getStreamName(string $name, int $flags = 0) {}

    public function getStream(string $name) {}
 
#ifdef ZIP_OPSYS_DEFAULT
    public function setExternalAttributesName(string $name, int $opsys, int $attr, int $flags = 0): bool {}

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

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

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

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

    public function setCompressionIndex(int $index, int $method, int $compflags = 0): bool {}
 
#ifdef HAVE_ENCRYPTION
    public function setEncryptionName(string $name, int $method, #[\SensitiveParameter] ?string $password = null): bool {}

    public function setEncryptionIndex(int $index, int $method, #[\SensitiveParameter] ?string $password = null): bool {}
#endif
 
#ifdef HAVE_PROGRESS_CALLBACK
    public function registerProgressCallback(float $rate, callable $callback): bool {}
#endif
 
#ifdef HAVE_CANCEL_CALLBACK
    public function registerCancelCallback(callable $callback): bool {}
#endif
 
#ifdef HAVE_METHOD_SUPPORTED
    public static function isCompressionMethodSupported(int $method, bool $enc = true): bool {}
 
    public static function isEncryptionMethodSupported(int $method, bool $enc = true): bool {}
#endif
}