定義済み定数
以下の定数が定義されています。
この関数の拡張モジュールが PHP 組み込みでコンパイルされているか、
実行時に動的にロードされている場合のみ使用可能です。
ZipArchive はクラス定数を使用します。
定数には様々なタイプがありますが、主なものは以下です:
フラグ (接頭辞 FL_
)、
グローバルフラグ(接頭辞 AFL_
)、
エラー (接頭辞 ER_
)、
モード (接頭辞なし)。
アーカイブのオープンモード
-
ZipArchive::CREATE
(int)
-
アーカイブが存在しない場合に、作成します。
-
ZipArchive::OVERWRITE
(int)
-
常に新しいアーカイブを開始します。このモードは、
ファイルが既に存在する場合にはそれを上書きします。
-
ZipArchive::EXCL
(int)
-
アーカイブが既に存在する場合はエラーとします。
-
ZipArchive::RDONLY
(int)
-
アーカイブを読み取り専用で開きます。
libzip ≥ 1.0.0 でビルドした場合、
PHP 7.4.3 以降、PECL zip 1.17.1 以降で利用可能です。
-
ZipArchive::CHECKCONS
(int)
-
アーカイブの一貫性チェックを別途行い、
失敗した場合はエラーとします。
アーカイブのグローバルフラグ
-
ZipArchive::AFL_RDONLY
(int)
-
アーカイブが読み取り専用であることを示します。
クリアできません。
PHP 8.3.0 以降、PECL zip 1.22.0 以降で利用可能です。
それぞれ、libzip ≥ 1.10.0 以降でビルドした場合に利用できます。
-
ZipArchive::AFL_IS_TORRENTZIP
(int)
-
アーカイブが torrentzip フォーマットであることを示します。
PHP 8.3.0 以降、PECL zip 1.22.0 以降で利用可能です。
それぞれ、libzip ≥ 1.10.0 以降でビルドした場合に利用できます。
-
ZipArchive::AFL_WANT_TORRENTZIP
(int)
-
書き込みアーカイブが torrentzip フォーマットであることを示します。
PHP 8.3.0 以降、PECL zip 1.22.0 以降で利用可能です。
それぞれ、libzip ≥ 1.10.0 以降でビルドした場合に利用できます。
-
ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE
(int)
-
アーカイブが空の場合に、ファイルを削除しません。
PHP 8.3.0 以降、PECL zip 1.22.0 以降で利用可能です。
それぞれ、libzip ≥ 1.10.0 以降でビルドした場合に利用できます。
アーカイブのフラグ
-
ZipArchive::FL_NOCASE
(int)
-
名前で検索する際に大文字小文字を区別しません。
-
ZipArchive::FL_NODIR
(int)
-
ディレクトリ要素を無視します。
-
ZipArchive::FL_COMPRESSED
(int)
-
圧縮されたデータを読み込みます。
-
ZipArchive::FL_UNCHANGED
(int)
-
元のデータを使用し、変更内容を無視します。
-
ZipArchive::FL_RECOMPRESS
(int)
-
データを強制的に再び圧縮します。
PHP 8.0.0 以降、PECL zip 1.18.0 以降で利用可能です。
PHP 8.3.0 以降、PECL zip 1.22.1 以降では推奨されなくなりました。
libzip の将来のバージョンで削除予定です。
-
ZipArchive::FL_ENCRYPTED
(int)
-
暗号化されたデータを読み込みます(FL_COMPRESSED が有効な場合)。
PHP 8.0.0 以降、PECL zip 1.18.0 以降で利用可能です。
-
ZipArchive::FL_OVERWRITE
(int)
-
ファイル名が存在する場合、上書き(置き換え)します。
PHP 8.0.0 以降、PECL zip 1.18.0 以降で利用可能です。
-
ZipArchive::FL_LOCAL
(int)
-
ローカルファイルヘッダ。
PHP 8.0.0 以降、PECL zip 1.18.0 以降で利用可能です。
-
ZipArchive::FL_CENTRAL
(int)
-
セントラルディレクトリ。
PHP 8.0.0 以降、PECL zip 1.18.0 以降で利用可能です。
-
ZipArchive::FL_ENC_GUESS
(int)
-
文字エンコーディングを推測します (デフォルト)。PHP 7.0.8 以降で利用可能です。
-
ZipArchive::FL_ENC_RAW
(int)
-
何も手を加えない文字列を取得します。PHP 7.0.8 以降で利用可能です。
-
ZipArchive::FL_ENC_STRICT
(int)
-
指示に厳格に従います。PHP 7.0.8 以降で利用可能です。
-
ZipArchive::FL_ENC_UTF_8
(int)
-
文字列のエンコーディングは UTF-8 です。PHP 7.0.8 以降で利用可能です。
-
ZipArchive::FL_ENC_CP437
(int)
-
文字列のエンコーディングは CP437 です。PHP 7.0.8 以降で利用可能です。
-
ZipArchive::FL_OPEN_FILE_NOW
(int)
-
ファイルが追加された際に、アーカイブがクローズされるのを待つ代わりに、
ファイルをオープンします。
ファイルディスクリプタが消費されることに注意してください。
PHP 8.3.0 以降、PECL zip 1.22.0 以降で利用可能です。
圧縮モード
-
ZipArchive::CM_DEFAULT
(int)
-
圧縮あるいは保存のどちらか有効なほうを実行します。
-
ZipArchive::CM_STORE
(int)
-
保存します (圧縮しません)。
-
ZipArchive::CM_SHRINK
(int)
-
圧縮します。
-
ZipArchive::CM_REDUCE_1
(int)
-
Reduced 方式(compression factor 1)
-
ZipArchive::CM_REDUCE_2
(int)
-
Reduced 方式(compression factor 2)
-
ZipArchive::CM_REDUCE_3
(int)
-
Reduced 方式(compression factor 3)
-
ZipArchive::CM_REDUCE_4
(int)
-
Reduced 方式(compression factor 4)
-
ZipArchive::CM_IMPLODE
(int)
-
Imploded 方式
-
ZipArchive::CM_DEFLATE
(int)
-
Deflated 方式
-
ZipArchive::CM_DEFLATE64
(int)
-
Deflate64 方式
-
ZipArchive::CM_PKWARE_IMPLODE
(int)
-
PKWARE 方式。
-
ZipArchive::CM_BZIP2
(int)
-
BZIP2 アルゴリズム。
-
ZipArchive::CM_LZMA
(int)
-
LZMA アルゴリズム
-
ZipArchive::CM_LZMA2
(int)
-
LZMA2 アルゴリズム。
libzip ≥ 1.6.0 でビルドした場合、
PHP 7.4.3 以降、PECL zip 1.16.0 以降で利用可能です。
-
ZipArchive::CM_ZSTD
(int)
-
Zstandard アルゴリズム。
libzip ≥ 1.8.0 でビルドした場合、
PHP 8.0.0 以降、PECL zip 1.19.0 以降で利用可能です。
-
ZipArchive::CM_XZ
(int)
-
XZ アルゴリズム。
libzip ≥ 1.6.0 でビルドした場合、
PHP 7.4.3 以降、PECL zip 1.16.1 以降で利用可能です。
-
ZipArchive::CM_TERSE
(int)
-
-
ZipArchive::CM_LZ77
(int)
-
-
ZipArchive::CM_WAVPACK
(int)
-
-
ZipArchive::CM_PPMD
(int)
-
エラー
-
ZipArchive::ER_OK
(int)
-
エラーはありません。
-
ZipArchive::ER_MULTIDISK
(int)
-
複数ディスクの zip アーカイブはサポートされません。
-
ZipArchive::ER_RENAME
(int)
-
一時ファイルの名前変更に失敗しました。
-
ZipArchive::ER_CLOSE
(int)
-
zip アーカイブのクローズに失敗しました。
-
ZipArchive::ER_SEEK
(int)
-
シークエラー。
-
ZipArchive::ER_READ
(int)
-
読み込みエラー。
-
ZipArchive::ER_WRITE
(int)
-
書き込みエラー。
-
ZipArchive::ER_CRC
(int)
-
CRC エラー。
-
ZipArchive::ER_ZIPCLOSED
(int)
-
zip アーカイブはクローズされました。
-
ZipArchive::ER_NOENT
(int)
-
そのファイルはありません。
-
ZipArchive::ER_EXISTS
(int)
-
ファイルが既に存在します。
-
ZipArchive::ER_OPEN
(int)
-
ファイルをオープンできません。
-
ZipArchive::ER_TMPOPEN
(int)
-
一時ファイルの作成に失敗しました。
-
ZipArchive::ER_ZLIB
(int)
-
Zlib エラー。
-
ZipArchive::ER_MEMORY
(int)
-
メモリの確保に失敗しました。
-
ZipArchive::ER_CHANGED
(int)
-
エントリが変更されました。
-
ZipArchive::ER_COMPNOTSUPP
(int)
-
圧縮方式がサポートされていません。
-
ZipArchive::ER_EOF
(int)
-
予期せぬ EOF です。
-
ZipArchive::ER_INVAL
(int)
-
無効な引数です。
-
ZipArchive::ER_NOZIP
(int)
-
zip アーカイブではありません。
-
ZipArchive::ER_INTERNAL
(int)
-
内部エラー。
-
ZipArchive::ER_INCONS
(int)
-
矛盾した Zip アーカイブです。
-
ZipArchive::ER_REMOVE
(int)
-
ファイルを削除できません。
-
ZipArchive::ER_DELETED
(int)
-
エントリが削除されました。
-
ZipArchive::ER_ENCRNOTSUPP
(int)
-
暗号化メソッドはサポートされていません。
PHP 7.4.3 以降、PECL zip 1.16.1 以降で利用可能です。
-
ZipArchive::ER_RDONLY
(int)
-
読み取り専用のアーカイブです。
PHP 7.4.3 以降、PECL zip 1.16.1 以降で利用可能です。
-
ZipArchive::ER_NOPASSWD
(int)
-
パスワードが指定されていません。
PHP 7.4.3 以降、PECL zip 1.16.1 以降で利用可能です。
-
ZipArchive::ER_WRONGPASSWD
(int)
-
間違ったパスワードが指定されました。
PHP 7.4.3 以降、PECL zip 1.16.1 以降で利用可能です。
-
ZipArchive::ER_OPNOTSUPP
(int)
-
操作はサポートされていません。
libzip ≥ 1.0.0 でビルドした場合、
PHP 7.4.3 以降、PECL zip 1.16.1 以降で利用可能です。
-
ZipArchive::ER_INUSE
(int)
-
リソースがまだ使用中です。
libzip ≥ 1.0.0 でビルドした場合、
PHP 7.4.3 以降、PECL zip 1.16.1 以降で利用可能です。
-
ZipArchive::ER_TELL
(int)
-
ストリームの位置変更エラー。
libzip ≥ 1.0.0 でビルドした場合、
PHP 7.4.3 以降、PECL zip 1.16.1 以降で利用可能です。
-
ZipArchive::ER_COMPRESSED_DATA
(int)
-
圧縮データが不正です。
libzip ≥ 1.6.0 でビルドした場合、
PHP 7.4.3 以降、PECL zip 1.16.1 以降で利用可能です。
-
ZipArchive::ER_CANCELLED
(int)
-
操作がキャンセルされました。
libzip ≥ 1.6.0 でビルドした場合、
PHP 7.4.3 以降、PECL zip 1.16.1 以降で利用可能です。
-
ZipArchive::ER_DATA_LENGTH
(int)
-
データの長さが想定外です。
PHP 8.3.0 以降、PECL zip 1.22.0 以降で利用可能です。
それぞれ、libzip ≥ 1.10.0 以降でビルドした場合に利用できます。
-
ZipArchive::ER_NOT_ALLOWED
(int)
-
torrentzip では許可されません。
PHP 8.3.0 以降、PECL zip 1.22.0 以降で利用可能です。
それぞれ、libzip ≥ 1.10.0 以降でビルドした場合に利用できます。
-
ZipArchive::ER_TRUNCATED_ZIP
(int)
-
zip アーカイブが切り詰められているか破損している可能性があります。
PHP 8.4.0 以降、 PECL zip 1.22.4 以降で利用可能です。
それぞれ、libzip ≥ 1.11.1 以降でビルドした場合に利用できます。
暗号化モード
-
ZipArchive::EM_NONE
(int)
-
暗号化しません。libzip ≥ 1.2.0 でビルドした場合、
PHP 7.2.0 以降、PECL zip 1.14.0 以降で利用可能です。
-
ZipArchive::EM_TRAD_PKWARE
(int)
-
伝統的な PKWARE 仕様の暗号化を行います。
PHP 8.0.0 以降、PECL zip 1.19.0 以降で利用可能です。
-
ZipArchive::EM_AES_128
(int)
-
AES 128 ビットで暗号化します。
libzip ≥ 1.2.0 でビルドした場合、
PHP 7.2.0 以降、PECL zip 1.14.0 以降で利用可能です。
-
ZipArchive::EM_AES_192
(int)
-
AES 192 ビットで暗号化します。
libzip ≥ 1.2.0 でビルドした場合、
PHP 7.2.0 以降、PECL zip 1.14.0 以降で利用可能です。
-
ZipArchive::EM_AES_256
(int)
-
AES 256 ビットで暗号化します。
libzip ≥ 1.2.0 でビルドした場合、
PHP 7.2.0 以降、PECL zip 1.14.0 以降で利用可能です。
-
ZipArchive::EM_UNKNOWN
(int)
-
不明な暗号化アルゴリズムです。
PHP 8.0.0 以降、PECL zip 1.19.0 以降で利用可能です。
Length parameter constants
-
ZipArchive::LENGTH_TO_END
(int)
-
ファイルサイズを使います。
ファイルサイズが増えた場合、追加のデータは無視されます。
ファイルサイズが小さくなった場合、エラー
(
ZipArchive::ER_DATA_LENGTH
)
が発生します。
PHP 8.3.0 以降、PECL zip 1.22.2 以降で利用可能です。
-
ZipArchive::LENGTH_UNCHECKED
(int)
-
利用可能なデータを全て使います。
libzip ≥ 1.10.1 でビルドした場合、
PHP 8.3.0 以降、PECL zip 1.22.2 以降で利用可能です。
その他の定数
-
ZipArchive::LIBZIP_VERSION
(string)
-
Zip ライブラリのバージョン。
PHP 7.4.3 以降、PECL zip 1.16.0 以降で利用可能です。
外部属性用の、オペレーティングシステム定数
-
ZipArchive::OPSYS_DOS
(int)
-
-
ZipArchive::OPSYS_AMIGA
(int)
-
-
ZipArchive::OPSYS_OPENVMS
(int)
-
-
ZipArchive::OPSYS_UNIX
(int)
-
-
ZipArchive::OPSYS_VM_CMS
(int)
-
-
ZipArchive::OPSYS_ATARI_ST
(int)
-
-
ZipArchive::OPSYS_OS_2
(int)
-
-
ZipArchive::OPSYS_MACINTOSH
(int)
-
-
ZipArchive::OPSYS_Z_SYSTEM
(int)
-
-
ZipArchive::OPSYS_CPM
(int)
-
-
ZipArchive::OPSYS_WINDOWS_NTFS
(int)
-
-
ZipArchive::OPSYS_MVS
(int)
-
-
ZipArchive::OPSYS_VSE
(int)
-
-
ZipArchive::OPSYS_ACORN_RISC
(int)
-
-
ZipArchive::OPSYS_VFAT
(int)
-
-
ZipArchive::OPSYS_ALTERNATE_MVS
(int)
-
-
ZipArchive::OPSYS_BEOS
(int)
-
-
ZipArchive::OPSYS_TANDEM
(int)
-
-
ZipArchive::OPSYS_OS_400
(int)
-
-
ZipArchive::OPSYS_OS_X
(int)
-
-
ZipArchive::OPSYS_DEFAULT
(int)
-
PECL zip 1.12.4 以降で使用可能です。