ZipArchive クラス

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

はじめに

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

クラス概要

classZipArchiveimplementsCountable {

publicconstintCREATE;

publicconstintEXCL;

publicconstintCHECKCONS;

publicconstintOVERWRITE;

publicconstintRDONLY;

publicconstintFL_NOCASE;

publicconstintFL_NODIR;

publicconstintFL_COMPRESSED;

publicconstintFL_UNCHANGED;

publicconstintFL_RECOMPRESS;

publicconstintFL_ENCRYPTED;

publicconstintFL_OVERWRITE;

publicconstintFL_LOCAL;

publicconstintFL_CENTRAL;

publicconstintFL_ENC_GUESS;

publicconstintFL_ENC_RAW;

publicconstintFL_ENC_STRICT;

publicconstintFL_ENC_UTF_8;

publicconstintFL_ENC_CP437;

publicconstintFL_OPEN_FILE_NOW;

publicconstintCM_DEFAULT;

publicconstintCM_STORE;

publicconstintCM_SHRINK;

publicconstintCM_REDUCE_1;

publicconstintCM_REDUCE_2;

publicconstintCM_REDUCE_3;

publicconstintCM_REDUCE_4;

publicconstintCM_IMPLODE;

publicconstintCM_DEFLATE;

publicconstintCM_DEFLATE64;

publicconstintCM_PKWARE_IMPLODE;

publicconstintCM_BZIP2;

publicconstintCM_LZMA;

publicconstintCM_LZMA2;

publicconstintCM_ZSTD;

publicconstintCM_XZ;

publicconstintCM_TERSE;

publicconstintCM_LZ77;

publicconstintCM_WAVPACK;

publicconstintCM_PPMD;

publicconstintER_OK;

publicconstintER_MULTIDISK;

publicconstintER_RENAME;

publicconstintER_CLOSE;

publicconstintER_SEEK;

publicconstintER_READ;

publicconstintER_WRITE;

publicconstintER_CRC;

publicconstintER_ZIPCLOSED;

publicconstintER_NOENT;

publicconstintER_EXISTS;

publicconstintER_OPEN;

publicconstintER_TMPOPEN;

publicconstintER_ZLIB;

publicconstintER_MEMORY;

publicconstintER_CHANGED;

publicconstintER_COMPNOTSUPP;

publicconstintER_EOF;

publicconstintER_INVAL;

publicconstintER_NOZIP;

publicconstintER_INTERNAL;

publicconstintER_INCONS;

publicconstintER_REMOVE;

publicconstintER_DELETED;

publicconstintER_ENCRNOTSUPP;

publicconstintER_RDONLY;

publicconstintER_NOPASSWD;

publicconstintER_WRONGPASSWD;

publicconstintER_OPNOTSUPP;

publicconstintER_INUSE;

publicconstintER_TELL;

publicconstintER_COMPRESSED_DATA;

publicconstintER_CANCELLED;

publicconstintER_DATA_LENGTH;

publicconstintER_NOT_ALLOWED;

publicconstintAFL_RDONLY;

publicconstintAFL_IS_TORRENTZIP;

publicconstintAFL_WANT_TORRENTZIP;

publicconstintAFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE;

publicconstintOPSYS_DOS;

publicconstintOPSYS_AMIGA;

publicconstintOPSYS_OPENVMS;

publicconstintOPSYS_UNIX;

publicconstintOPSYS_VM_CMS;

publicconstintOPSYS_ATARI_ST;

publicconstintOPSYS_OS_2;

publicconstintOPSYS_MACINTOSH;

publicconstintOPSYS_Z_SYSTEM;

publicconstintOPSYS_CPM;

publicconstintOPSYS_WINDOWS_NTFS;

publicconstintOPSYS_MVS;

publicconstintOPSYS_VSE;

publicconstintOPSYS_ACORN_RISC;

publicconstintOPSYS_VFAT;

publicconstintOPSYS_ALTERNATE_MVS;

publicconstintOPSYS_BEOS;

publicconstintOPSYS_TANDEM;

publicconstintOPSYS_OS_400;

publicconstintOPSYS_OS_X;

publicconstintOPSYS_DEFAULT;

publicconstintEM_NONE;

publicconstintEM_TRAD_PKWARE;

publicconstintEM_AES_128;

publicconstintEM_AES_192;

publicconstintEM_AES_256;

publicconstintEM_UNKNOWN;

publicconststringLIBZIP_VERSION;

publicconstintLENGTH_TO_END;

publicconstintLENGTH_UNCHECKED;

publicreadonlyint$lastId;

publicreadonlyint$status;

publicreadonlyint$statusSys;

publicreadonlyint$numFiles;

publicreadonlystring$filename;

publicreadonlystring$comment;

publicaddEmptyDir(string$dirname, int$flags = 0): bool

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

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

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

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

publicclearError(): void

publicclose(): bool

publiccount(): int

publicdeleteIndex(int$index): bool

publicdeleteName(string$name): bool

publicextractTo(string$pathto, array|string|null$files = null): bool

publicgetArchiveComment(int$flags = 0): string|false

publicgetArchiveFlag(int$flag = 0, int$flags = 0): int

publicgetCommentIndex(int$index, int$flags = 0): string|false

publicgetCommentName(string$name, int$flags = 0): string|false

publicgetExternalAttributesIndex(
    int$index,
    int&$opsys,
    int&$attr,
    int$flags = 0
): bool

publicgetExternalAttributesName(
    string$name,
    int&$opsys,
    int&$attr,
    int$flags = 0
): bool

publicgetFromIndex(int$index, int$len = 0, int$flags = 0): string|false

publicgetFromName(string$name, int$len = 0, int$flags = 0): string|false

publicgetNameIndex(int$index, int$flags = 0): string|false

publicgetStatusString(): string

publicgetStream(string$name): resource|false

publicgetStreamIndex(int$index, int$flags = 0): resource|false

publicgetStreamName(string$name, int$flags = 0): resource|false

publicstaticisCompressionMethodSupported(int$method, bool$enc = true): bool

publicstaticisEncryptionMethodSupported(int$method, bool$enc = true): bool

publiclocateName(string$name, int$flags = 0): int|false

publicopen(string$filename, int$flags = 0): bool|int

publicregisterCancelCallback(callable$callback): bool

publicregisterProgressCallback(float$rate, callable$callback): bool

publicrenameIndex(int$index, string$new_name): bool

publicrenameName(string$name, string$new_name): bool

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

publicsetArchiveComment(string$comment): bool

publicsetArchiveFlag(int$flag, int$value): bool

publicsetCommentIndex(int$index, string$comment): bool

publicsetCommentName(string$name, string$comment): bool

publicsetCompressionIndex(int$index, int$method, int$compflags = 0): bool

publicsetCompressionName(string$name, int$method, int$compflags = 0): bool

publicsetEncryptionIndex(int$index, int$method, ?string$password = null): bool

publicsetEncryptionName(string$name, int$method, ?string$password = null): bool

publicsetExternalAttributesIndex(
    int$index,
    int$opsys,
    int$attr,
    int$flags = 0
): bool

publicsetExternalAttributesName(
    string$name,
    int$opsys,
    int$attr,
    int$flags = 0
): bool

publicsetMtimeIndex(int$index, int$timestamp, int$flags = 0): bool

publicsetMtimeName(string$name, int$timestamp, int$flags = 0): bool

publicsetPassword(string$password): bool

publicstatIndex(int$index, int$flags = 0): array|false

publicstatName(string$name, int$flags = 0): array|false

publicunchangeAll(): bool

publicunchangeArchive(): bool

publicunchangeIndex(int$index): bool

publicunchangeName(string$name): bool

}

プロパティ

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 — 指定した名前のエントリに対するすべての変更を取り消す

ZipArchive クラス

はじめに

クラス概要

プロパティ

目次