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.

Замечание: Для максимальной переносимости, рекомендуется всегда пользоваться прямыми слешами / как разделителями директорий в именах файлов.

Список параметров

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. Поведение констант описывает страница «ZIP-константы».

  • "comp_method"

    Метод сжатия. Опция принимает одну из констант ZipArchive::CM_*.

  • "comp_flags"

    Уровень сжатия.

  • "enc_method"

    Метод шифрования. Опция принимает одну из констант ZipArchive::EM_*.

  • "enc_password"

    Пароль для шифрования.

Возвращаемые значения

В случае успешного выполнения метод возвращает массив (array) файлов, которые добавил в архив, или false, если возникла ошибка Функция возвращает true, если выполнилась успешно, или false, если возникла ошибка.

Список изменений

Версия Описание
8.0.0, PECL-модуль zip 1.18.0 Добавили опцию "flags" в параметр options.
8.0.0, PECL-модуль zip 1.18.1 Добавили опции "comp_method", "comp_flags", "enc_method" и "enc_password" в параметр options.
8.3.0, PECL-модуль zip 1.22.1 Добавили константу ZipArchive::FL_OPEN_FILE_NOW.

Примеры

Пример #1 Пример добавления файлав архив по glob-шаблону методом ZipArchive::addGlob()

Добавить в архив PHP-скрипты и текстовые файлы из текущей директории.

<?php

$zip = new ZipArchive();

$ret = $zip->open('application.zip', ZipArchive::CREATE | ZipArchive::OVERWRITE);

if ($ret !== TRUE) {
printf('Возникла ошибка с кодом %d', $ret);
} else {
$options = array('add_path' => 'sources/', 'remove_all_path' => TRUE);
$zip->addGlob('*.{php,txt}', GLOB_BRACE, $options);
$zip->close();
}

?>

Смотрите также

  • ZipArchive::addFile() - Добавляет в ZIP-архив файл по заданному пути
  • ZipArchive::addPattern() - Добавить файлы из директории в соответствии с шаблоном регулярного выражения PCRE