ZipArchive クラス

はじめに

Zip で圧縮されたファイルアーカイブです。

クラス概要

ZipArchive

implements Countable

/* 定数 */

public const int ZipArchive::CREATE;

public const int ZipArchive::EXCL;

public const int ZipArchive::CHECKCONS;

public const int ZipArchive::OVERWRITE;

public const int ZipArchive::RDONLY;

public const int ZipArchive::FL_NOCASE;

public const int ZipArchive::FL_NODIR;

public const int ZipArchive::FL_COMPRESSED;

public const int ZipArchive::FL_UNCHANGED;

public const int ZipArchive::FL_RECOMPRESS;

public const int ZipArchive::FL_ENCRYPTED;

public const int ZipArchive::FL_OVERWRITE;

public const int ZipArchive::FL_LOCAL;

public const int ZipArchive::FL_CENTRAL;

public const int ZipArchive::FL_ENC_GUESS;

public const int ZipArchive::FL_ENC_RAW;

public const int ZipArchive::FL_ENC_STRICT;

public const int ZipArchive::FL_ENC_UTF_8;

public const int ZipArchive::FL_ENC_CP437;

public const int ZipArchive::FL_OPEN_FILE_NOW;

public const int ZipArchive::CM_DEFAULT;

public const int ZipArchive::CM_STORE;

public const int ZipArchive::CM_SHRINK;

public const int ZipArchive::CM_REDUCE_1;

public const int ZipArchive::CM_REDUCE_2;

public const int ZipArchive::CM_REDUCE_3;

public const int ZipArchive::CM_REDUCE_4;

public const int ZipArchive::CM_IMPLODE;

public const int ZipArchive::CM_DEFLATE;

public const int ZipArchive::CM_DEFLATE64;

public const int ZipArchive::CM_PKWARE_IMPLODE;

public const int ZipArchive::CM_BZIP2;

public const int ZipArchive::CM_LZMA;

public const int ZipArchive::CM_LZMA2;

public const int ZipArchive::CM_ZSTD;

public const int ZipArchive::CM_XZ;

public const int ZipArchive::CM_TERSE;

public const int ZipArchive::CM_LZ77;

public const int ZipArchive::CM_WAVPACK;

public const int ZipArchive::CM_PPMD;

public const int ZipArchive::ER_OK;

public const int ZipArchive::ER_MULTIDISK;

public const int ZipArchive::ER_RENAME;

public const int ZipArchive::ER_CLOSE;

public const int ZipArchive::ER_SEEK;

public const int ZipArchive::ER_READ;

public const int ZipArchive::ER_WRITE;

public const int ZipArchive::ER_CRC;

public const int ZipArchive::ER_ZIPCLOSED;

public const int ZipArchive::ER_NOENT;

public const int ZipArchive::ER_EXISTS;

public const int ZipArchive::ER_OPEN;

public const int ZipArchive::ER_TMPOPEN;

public const int ZipArchive::ER_ZLIB;

public const int ZipArchive::ER_MEMORY;

public const int ZipArchive::ER_CHANGED;

public const int ZipArchive::ER_COMPNOTSUPP;

public const int ZipArchive::ER_EOF;

public const int ZipArchive::ER_INVAL;

public const int ZipArchive::ER_NOZIP;

public const int ZipArchive::ER_INTERNAL;

public const int ZipArchive::ER_INCONS;

public const int ZipArchive::ER_REMOVE;

public const int ZipArchive::ER_DELETED;

public const int ZipArchive::ER_ENCRNOTSUPP;

public const int ZipArchive::ER_RDONLY;

public const int ZipArchive::ER_NOPASSWD;

public const int ZipArchive::ER_WRONGPASSWD;

public const int ZipArchive::ER_OPNOTSUPP;

public const int ZipArchive::ER_INUSE;

public const int ZipArchive::ER_TELL;

public const int ZipArchive::ER_COMPRESSED_DATA;

public const int ZipArchive::ER_CANCELLED;

public const int ZipArchive::ER_DATA_LENGTH;

public const int ZipArchive::ER_NOT_ALLOWED;

public const int ZipArchive::ER_TRUNCATED_ZIP;

public const int ZipArchive::AFL_RDONLY;

public const int ZipArchive::AFL_IS_TORRENTZIP;

public const int ZipArchive::AFL_WANT_TORRENTZIP;

public const int ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE;

public const int ZipArchive::OPSYS_DOS;

public const int ZipArchive::OPSYS_AMIGA;

public const int ZipArchive::OPSYS_OPENVMS;

public const int ZipArchive::OPSYS_UNIX;

public const int ZipArchive::OPSYS_VM_CMS;

public const int ZipArchive::OPSYS_ATARI_ST;

public const int ZipArchive::OPSYS_OS_2;

public const int ZipArchive::OPSYS_MACINTOSH;

public const int ZipArchive::OPSYS_Z_SYSTEM;

public const int ZipArchive::OPSYS_CPM;

public const int ZipArchive::OPSYS_WINDOWS_NTFS;

public const int ZipArchive::OPSYS_MVS;

public const int ZipArchive::OPSYS_VSE;

public const int ZipArchive::OPSYS_ACORN_RISC;

public const int ZipArchive::OPSYS_VFAT;

public const int ZipArchive::OPSYS_ALTERNATE_MVS;

public const int ZipArchive::OPSYS_BEOS;

public const int ZipArchive::OPSYS_TANDEM;

public const int ZipArchive::OPSYS_OS_400;

public const int ZipArchive::OPSYS_OS_X;

public const int ZipArchive::OPSYS_DEFAULT;

public const int ZipArchive::EM_NONE;

public const int ZipArchive::EM_TRAD_PKWARE;

public const int ZipArchive::EM_AES_128;

public const int ZipArchive::EM_AES_192;

public const int ZipArchive::EM_AES_256;

public const int ZipArchive::EM_UNKNOWN;

public const string ZipArchive::LIBZIP_VERSION;

public const int ZipArchive::LENGTH_TO_END;

public const int ZipArchive::LENGTH_UNCHECKED;

/* プロパティ */

public readonly int $lastId;

public readonly int $status;

public readonly int $statusSys;

public readonly int $numFiles;

public readonly string $filename;

public readonly string $comment;

/* メソッド */

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

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

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

public arrayfalse addGlob(string $pattern, int $flags = 0, array $options = [])

public arrayfalse addPattern(string $pattern, string $path = ".", array $options = [])

public void clearError()

public bool close()

public int count()

public bool deleteIndex(int $index)

public bool deleteName(string $name)

public bool extractTo(string $pathto, arraystringnull $files = null)

public stringfalse getArchiveComment(int $flags = 0)

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

public stringfalse getCommentIndex(int $index, int $flags = 0)

public stringfalse getCommentName(string $name, int $flags = 0)

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

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

public stringfalse getFromIndex(int $index, int $len = 0, int $flags = 0)

public stringfalse getFromName(string $name, int $len = 0, int $flags = 0)

public stringfalse getNameIndex(int $index, int $flags = 0)

public string getStatusString()

public resourcefalse getStream(string $name)

public resourcefalse getStreamIndex(int $index, int $flags = 0)

public resourcefalse getStreamName(string $name, int $flags = 0)

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

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

public intfalse locateName(string $name, int $flags = 0)

public boolint open(string $filename, int $flags = 0)

public bool registerCancelCallback(callable $callback)

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

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

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

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

public bool setArchiveComment(string $comment)

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

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

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

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

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

public bool setEncryptionIndex(int $index, int $method, #[\SensitiveParameter]stringnull $password = null)

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

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

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

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

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

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

public arrayfalse statIndex(int $index, int $flags = 0)

public arrayfalse statName(string $name, int $flags = 0)

public bool unchangeAll()

public bool unchangeArchive()

public bool unchangeIndex(int $index)

public bool unchangeName(string $name)

プロパティ

lastId: 最後に追加されたエントリのインデックス(ファイルまたはディレクトリ)。 PHP 8.0.0 以降および PECL 1.18.0 以降で利用可能です。
status: Zip アーカイブの状態。 PHP 8.0.0 以降および PECL 1.18.0 以降では、閉じられたアーカイブでも利用可能です。
statusSys: Zip アーカイブのシステム状態。 PHP 8.0.0 以降および PECL 1.18.0 以降では、閉じられたアーカイブでも利用可能です。
numFiles: アーカイブ内のファイル数
filename: ファイルシステム上のファイル名
comment: アーカイブのコメント

ZipArchive::addEmptyDir — 新しいディレクトリを追加する
ZipArchive::addFile — 指定したパスからファイルを ZIP アーカイブに追加する
ZipArchive::addFromString — 内容を指定して、ファイルを ZIP アーカイブに追加する
ZipArchive::addGlob — ディレクトリから、glob パターンを使ってファイルを追加する
ZipArchive::addPattern — ディレクトリから、PCRE パターンを使ってファイルを追加する
ZipArchive::clearError — ステータスエラーメッセージか、システムエラー/ zip メッセージをクリアする
ZipArchive::close — アクティブな (オープンされた、あるいは新しく作成された) アーカイブを閉じる
ZipArchive::count — アーカイブにあるファイルの数を数える
ZipArchive::deleteIndex — インデックスを使用して、アーカイブ内のエントリを削除する
ZipArchive::deleteName — 名前を使用して、アーカイブからエントリを削除する
ZipArchive::extractTo — アーカイブの内容を展開する
ZipArchive::getArchiveComment — ZIP アーカイブのコメントを返す
ZipArchive::getArchiveFlag — Zip アーカイブのグローバルフラグの値を返す
ZipArchive::getCommentIndex — エントリのインデックスを使用して、エントリのコメントを返す
ZipArchive::getCommentName — エントリ名を使用して、エントリのコメントを返す
ZipArchive::getExternalAttributesIndex — インデックスで定義されたエントリの外部属性を取得する
ZipArchive::getExternalAttributesName — 名前で定義されたエントリの外部属性を取得する
ZipArchive::getFromIndex — インデックスを使用して、エントリの内容を返す
ZipArchive::getFromName — 名前を使用して、エントリの内容を返す
ZipArchive::getNameIndex — インデックスを使用して、エントリの名前を返す
ZipArchive::getStatusString — システムエラー、または ZIP メッセージに関するエラー情報を返す
ZipArchive::getStream — 名前を使用して、エントリのファイルハンドラ (読み込み専用) を取得する
ZipArchive::getStreamIndex — インデックスで指定されたエントリへの、ファイルハンドラを取得する(読み取り専用)
ZipArchive::getStreamName — 名前で指定されたエントリへの、ファイルハンドラを取得する(読み取り専用)
ZipArchive::isCompressionMethodSupported — 圧縮方式を libzip がサポートしているかをチェックする
ZipArchive::isEncryptionMethodSupported — 暗号化方式を libzip がサポートしているかどうかをチェックする
ZipArchive::locateName — アーカイブ内のエントリのインデックスを返す
ZipArchive::open — ZIP ファイルアーカイブをオープンする
ZipArchive::registerCancelCallback — アーカイブを閉じている間にキャンセルできるようにコールバックを登録する
ZipArchive::registerProgressCallback — アーカイブを閉じている間に更新できるようにコールバックを登録する
ZipArchive::renameIndex — インデックスを使用してエントリ名を変更する
ZipArchive::renameName — 名前を使用してエントリ名を変更する
ZipArchive::replaceFile — 指定されたパスのファイルにアーカイブの一部を置き換える
ZipArchive::setArchiveComment — ZIP アーカイブのコメントを設定する
ZipArchive::setArchiveFlag — Zip アーカイブのグローバルフラグを設定する
ZipArchive::setCommentIndex — インデックスを使用してエントリのコメントを設定する
ZipArchive::setCommentName — 名前を使用してエントリのコメントを設定する
ZipArchive::setCompressionIndex — インデックスで定義されたエントリの圧縮方法を設定する
ZipArchive::setCompressionName — 名前で定義されたエントリの圧縮メソッドを設定する
ZipArchive::setEncryptionIndex — index で定義されたエントリの暗号化方法を指定する
ZipArchive::setEncryptionName — 名前で定義されたエントリの暗号化方式を設定する
ZipArchive::setExternalAttributesIndex — インデックスで定義されたエントリの外部属性を設定する
ZipArchive::setExternalAttributesName — 名前で定義されたエントリの外部属性を設定する
ZipArchive::setMtimeIndex — インデックスを使用してエントリの変更時間を設定する
ZipArchive::setMtimeName — 名前を使ってエントリの変更時間を設定する
ZipArchive::setPassword — アクティブなアーカイブにパスワードを設定する
ZipArchive::statIndex — インデックスを使用してエントリの詳細を取得する
ZipArchive::statName — 名前を使用してエントリの詳細を取得する
ZipArchive::unchangeAll — アーカイブに対するすべての変更を取り消す
ZipArchive::unchangeArchive — アーカイブ全体に対して行われたすべての変更を取り消す
ZipArchive::unchangeIndex — 指定したインデックスのエントリに対するすべての変更を取り消す
ZipArchive::unchangeName — 指定した名前のエントリに対するすべての変更を取り消す