ZipArchive::addGlob

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL zip >= 1.9.0)

ZipArchive::addGlobディレクトリから、glob パターンを使ってファイルを追加する

説明

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

ディレクトリから、glob pattern にマッチするファイルを追加します。

注意: ポータビリティを考慮して、ZIP ファイル名のディレクトリ区切り文字には常にスラッシュ (/) を使うことを推奨します。

パラメータ

pattern

glob() パターン。どのファイルを対象にするのかを指定します。

flags

glob() のフラグのビットマスク。

options

オプションの連想配列。次のオプションが使えます。

  • "add_path"

    アーカイブ内のファイルのローカルパスに変換するときにつけるプレフィックス。 これが適用されるのは、 "remove_path""remove_all_path" で定義された削除処理がすべて終わった後です。

  • "remove_path"

    マッチしたファイルをアーカイブに追加する前に削除するプレフィックス。

  • "remove_all_path"

    true にすると、ファイル名だけを使ってアーカイブのルートに追加します。

  • "flags"

    以下のビットマスクの組み合わせ: ZipArchive::FL_OVERWRITE, ZipArchive::FL_ENC_GUESS, ZipArchive::FL_ENC_UTF_8, ZipArchive::FL_ENC_CP437, ZipArchive::FL_OPEN_FILE_NOW。 これらの定数の振る舞いは、定義済みの定数 で説明しています。

  • "comp_method"

    圧縮メソッド。 ZipArchive::CM_* のうちのいずれかです。 定義済みの定数 も参照ください。

  • "comp_flags"

    圧縮レベル

  • "enc_method"

    暗号化メソッド。 ZipArchive::EM_* のうちのいずれかです。 定義済みの定数 も参照ください。

  • "enc_password"

    暗号化に使うパスワード

戻り値

成功した場合、追加されたファイルの array を返します。 失敗した場合に false を返します

変更履歴

バージョン 説明
8.0.0 / 1.18.0 options"flags" が追加されました。
8.0.0 / 1.18.1 options"comp_method", "comp_flags", "enc_method", "enc_password" が追加されました。
8.3.0 / 1.22.1 ZipArchive::FL_OPEN_FILE_NOW が追加されました。

例1 ZipArchive::addGlob() の例

現在の作業ディレクトリにある、すべての PHP スクリプトとテキストファイルを追加します。

<?php
$zip
= new ZipArchive();
$ret = $zip->open('application.zip', ZipArchive::CREATE | ZipArchive::OVERWRITE);
if (
$ret !== TRUE) {
printf('Failed with code %d', $ret);
} else {
$options = array('add_path' => 'sources/', 'remove_all_path' => TRUE);
$zip->addGlob('*.{php,txt}', GLOB_BRACE, $options);
$zip->close();
}
?>

参考