PHP Conference Nagoya 2025

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, PECL zip 1.18.0 options"flags" が追加されました。
8.0.0, PECL zip 1.18.1 options"comp_method", "comp_flags", "enc_method", "enc_password" が追加されました。
8.3.0, PECL zip 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();
}
?>

参考

add a note

User Contributed Notes 6 notes

up
6
johnsmith at na dot com
9 years ago
Neither 'remove_all_path' or 'remove_path' options seem to be workng
up
1
Francesc Pineda Segarra
7 years ago
For me the better way seems to be:

$options = array('add_path' => DIRECTORY_SEPARATOR, 'remove_all_path' => TRUE);

On Windows uses \, on others /
up
1
sunbinzzzzz at gmail dot com
7 years ago
Yes!! neither 'remove_all_path' or 'remove_path' be working,if you want the right result,you should like this, $option = array( 'add_path' => '/', 'remove_all_path' => 'your path' ); 'add_path' just give a '/', then you will (; 。
up
1
hkn06tr at gmail dot com
9 months ago
The following all works:
---------
Ex-1:
Nearly all files for 5 level recursively are zipped:
$zip->addGlob("*.*");
$zip->addGlob("*/*.*");
$zip->addGlob("*/*/*.*");
$zip->addGlob("*/*/*/*.*");
$zip->addGlob("*/*/*/*/*.*");
$zip->addGlob("*/*/*/*/*/*.*"); // 5th
---------
Ex-2:
$zip->addGlob("library/*.*");
all files under library
---------
Ex-3:
$zip->addGlob("*/*.[cpj]*");
Means all files starting with cpj
So they all included
css
php
js
---------
Ex-4:
$zip->addGlob("*/*.[cpj][sh]*");
Take guarantee:
css
php
js
---------
Ex-5 Bonus:
More complicated:
$zip->addGlob("[ab]*/c*/*.[cpjth][shxt]*");
All folder starting with a or b and then in subfolder must start with c but only those files:
css php txt js html
up
0
zckernel at gmail dot com
9 years ago
Doesn't work with the following options:
$options = array('remove_all_path' => TRUE);
$zipArchive->addGlob($path."/*", GLOB_BRACE, $options);

The full path to file is adding to the archive.

Works well if:
$options = array('add_path' => './','remove_all_path' => TRUE);
up
-1
sumariva at gmail dot com
9 years ago
As others suggested, to remove all paths, use the space as basepath.
Zip opened with builtin utility on a Windows XP and WinRAR.

$options = array('add_path' => ' ','remove_all_path' => TRUE);

Thanks for all contributers.
To Top