Edit Report a Bug

    ZipArchive::addGlob

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

    ZipArchive::addGlob — Add files from a directory by glob pattern

    Description

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

    Add files from a directory which match the glob pattern.

    Note: For maximum portability, it is recommended to always use forward slashes (/) as directory separator in ZIP filenames.

    Parameters

    pattern

    A glob() pattern against which files will be matched.

    flags

    A bit mask of glob() flags.

    options

    An associative array of options. Available options are:

    • "add_path"

      Prefix to prepend when translating to the local path of the file within the archive. This is applied after any remove operations defined by the "remove_path" or "remove_all_path" options.

    • "remove_path"

      Prefix to remove from matching file paths before adding to the archive.

    • "remove_all_path"

      true to use the file name only and add to the root of the archive.

    • "flags"

      Bitmask consisting of ZipArchive::FL_OVERWRITE, ZipArchive::FL_ENC_GUESS, ZipArchive::FL_ENC_UTF_8, ZipArchive::FL_ENC_CP437, ZipArchive::FL_OPEN_FILE_NOW. The behaviour of these constants is described on the ZIP constants page.

    • "comp_method"

      Compression method, one of the ZipArchive::CM_* constants, see ZIP constants page.

    • "comp_flags"

      Compression level.

    • "enc_method"

      Encryption method, one of the ZipArchive::EM_* constants, see ZIP constants page.

    • "enc_password"

      Password used for encryption.

    Return Values

    An array of added files on success or false on failure

    Changelog

    Version Description
    8.0.0 / 1.18.0 "flags" in options was added.
    8.0.0 / 1.18.1 "comp_method", "comp_flags", "enc_method" and "enc_password" in options were added.
    8.3.0 / 1.22.1 ZipArchive::FL_OPEN_FILE_NOW was added.

    Examples

    Example #1 ZipArchive::addGlob() example

    Add all php scripts and text files from current working directory

    <?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();
    }
    ?>

    See Also

    add a note 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
    2
    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
    0
    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.
    add a note add a note
    To Top