Загрузка php zip - Загрузка исходного кода php zip

PhpZip — php-библиотека для расширенной работы с ZIP-архивами.

Русская документация

Версии и зависимости

Версия	PHP	Документация
^ 4.0 (мастер)	^7,4\|^8,0	текущий
^ 3,0	^5,5\|^7,0	Документы v3.3

Функции
Требования
Установка
Примеры
Глоссарий
Документация
- Обзор методов класса PhpZipZipFile
- Создание/Открытие ZIP-архива
- Чтение записей из архива
- Итерация записей
- Получение информации о записях
- Добавление записей в архив
- Удаление записей из архива
- Работа с записями и архивом
- Работа с паролями
- Отменить изменения
- Сохранение файла или вывод в браузер
- Закрытие архива
Запуск тестов
Журнал изменений
Обновление
- Обновите версию 3 до версии 4
- Обновите версию 2 до версии 3

Функции

Открытие и распаковка zip-файлов.
Создание ZIP-архивов.
Модификация ZIP-архивов.
Чистый PHP (не требуется расширение php-zip и класс ZipArchive ).
Он поддерживает сохранение архива в файл, вывод архива в браузер или вывод его в виде строки без сохранения в файл.
Поддерживаются архивные комментарии и комментарии отдельных записей.
Получите информацию о каждой записи в архиве.
Поддерживаются только следующие методы сжатия:
- Без сжатия (сохранено).
- Выкачать компрессию.
- Сжатие BZIP2 с расширением php-bz2 .
Поддержка ZIP64 (размер файла более 4 ГБ или количество записей в архиве более 65535).
Работа с паролями
Внимание!
Для 32-битных систем метод шифрования Traditional PKWARE Encryption (ZipCrypto) в настоящее время не поддерживается. По возможности используйте метод шифрования WinZIP AES Encryption .
- Установите пароль на чтение архива для всех записей или только для некоторых.
- Сменить пароль на архив, в том числе и на отдельные записи.
- Удалите пароль архива для всех или отдельных записей.
- Установите пароль и/или метод шифрования как для всех, так и для отдельных записей в архиве.
- Установите разные пароли и методы шифрования для разных записей.
- Удалите пароль для всех или некоторых записей.
- Поддержка Traditional PKWARE Encryption (ZipCrypto) и WinZIP AES Encryption .
- Установите метод шифрования для всех или отдельных записей в архиве.

Требования

PHP >= 7.4 или PHP >= 8.0 (предпочтительно 64-разрядная версия).
Дополнительное php-расширение bzip2 для сжатия BZIP2.
Дополнительное php-расширение openssl для поддержки WinZip Aes Encryption .

Установка

composer require nelexa/zip

Последняя стабильная версия:

Примеры

 // create new archive
$ zipFile = new  PhpZip  ZipFile ();
try {
    $ zipFile
        -> addFromString ( ' zip/entry/filename ' , ' Is file content ' ) // add an entry from the string
        -> addFile ( ' /path/to/file ' , ' data/tofile ' ) // add an entry from the file
        -> addDir ( __DIR__ , ' to/path/ ' ) // add files from the directory
        -> saveAsFile ( $ outputFilename ) // save the archive to a file
        -> close (); // close archive
            
    // open archive, extract, add files, set password and output to browser.
    $ zipFile
        -> openFile ( $ outputFilename ) // open archive from file
        -> extractTo ( $ outputDirExtract ) // extract files to the specified directory
        -> deleteFromRegex ( ' ~^.~ ' ) // delete all hidden (Unix) files
        -> addFromString ( ' dir/file.txt ' , ' Test file ' ) // add a new entry from the string
        -> setPassword ( ' password ' ) // set password for all entries
        -> outputAsAttachment ( ' library.jar ' ); // output to the browser without saving to a file
}
catch (  PhpZip  Exception  ZipException $ e ){
    // handle exception
}
finally {
    $ zipFile -> close ();
}

Остальные примеры можно найти в папкеtests tests/ .

Глоссарий

Zip Entry — файл или папка в ZIP-архиве. Каждая запись в архиве имеет определенные свойства, например: имя файла, метод сжатия, метод шифрования, размер файла до сжатия, размер файла после сжатия, CRC32 и другие.

Документация:

Обзор методов класса `PhpZipZipFile`

ZipFile::__construct — инициализирует ZIP-архив.
ZipFile::addAll — добавляет все записи из массива.
ZipFile::addDir — добавляет в архив файлы из каталога по указанному пути без подкаталогов.
ZipFile::addDirRecursive — добавляет в архив файлы из каталога по указанному пути с подкаталогами.
ZipFile::addEmptyDir — добавить новый каталог.
ZipFile::addFile — добавляет файл в ZIP-архив по заданному пути.
ZipFile::addSplFile — добавляет SplFileInfo в ZIP-архив.
ZipFile::addFromFinder — добавляет файлы из SymfonyComponentFinderFinder в ZIP-архив.
ZipFile::addFilesFromIterator — добавляет файлы из итератора каталогов.
ZipFile::addFilesFromGlob — добавляет файлы из каталога по шаблону без подкаталогов.
ZipFile::addFilesFromGlobRecursive — добавляет файлы из каталога по шаблону glob с подкаталогами.
ZipFile::addFilesFromRegex — добавляет файлы из каталога по шаблону PCRE без подкаталогов.
ZipFile::addFilesFromRegexRecursive — добавляет файлы из каталога по шаблону PCRE с подкаталогами.
ZipFile::addFromStream — добавляет запись из потока в ZIP-архив.
ZipFile::addFromString — добавляет файл в ZIP-архив, используя его содержимое.
ZipFile::close — закрыть архив.
ZipFile::count - возвращает количество записей в архиве.
ZipFile::deleteFromName — удаляет запись в архиве по ее имени.
ZipFile::deleteFromGlob — удаляет записи в архиве, используя шаблон glob.
ZipFile::deleteFromRegex — удаляет записи в архиве по шаблону PCRE.
ZipFile::deleteAll — удаляет все записи в ZIP-архиве.
ZipFile::disableEncryption — отключить шифрование для всех записей, которые уже есть в архиве.
ZipFile::disableEncryptionEntry — отключить шифрование записи, определенной ее именем.
ZipFile::extractTo — извлечь содержимое архива.
ZipFile::getArchiveComment — возвращает комментарий Zip-архива.
ZipFile::getEntryComment — возвращает комментарий к записи, используя имя записи.
ZipFile::getEntryContent — возвращает содержимое записи, используя ее имя.
ZipFile::getListFiles - возвращает список файлов архива.
ZipFile::hasEntry — проверяет, есть ли запись в архиве.
ZipFile::isDirectory — проверяет, что запись в архиве является каталогом.
ZipFile::matcher - выбор записей в архиве для выполнения над ними операций.
ZipFile::openFile - открывает zip-архив из файла.
ZipFile::openFromString — открывает zip-архив из строки.
ZipFile::openFromStream — открывает zip-архив из потока.
ZipFile::outputAsAttachment — выводит ZIP-архив в браузер.
ZipFile::outputAsPsr7Response — выводит ZIP-архив как ответ PSR-7.
ZipFile::outputAsSymfonyResponse — выводит ZIP-архив как ответ Symfony.
ZipFile::outputAsString — выводит ZIP-архив в виде строки.
ZipFile::rename — переименовывает запись, определенную ее именем.
ZipFile::rewrite — сохранить изменения и заново открыть измененный архив.
ZipFile::saveAsFile — сохраняет архив в файл.
ZipFile::saveAsStream — записывает архив в поток.
ZipFile::setArchiveComment - установить комментарий ZIP-архива.
ZipFile::setCompressionLevel - устанавливает уровень сжатия для всех файлов в архиве.
ZipFile::setCompressionLevelEntry — устанавливает уровень сжатия записи по ее имени.
ZipFile::setCompressionMethodEntry — устанавливает метод сжатия записи по ее имени.
ZipFile::setEntryComment — устанавливает комментарий к записи, определяемой ее именем.
ZipFile::setReadPassword - установить пароль на открытый архив.
ZipFile::setReadPasswordEntry — устанавливает пароль для чтения записи, определяемой ее именем.
ZipFile::setPassword — устанавливает новый пароль для всех файлов в архиве.
ZipFile::setPasswordEntry — устанавливает новый пароль записи, определяемый ее именем.
ZipFile::unchangeAll — отменить все изменения, сделанные в архиве.
ZipFile::unchangeArchiveComment — отменить изменения комментария к архиву.
ZipFile::unchangeEntry — отменить изменения записи, определенной ее именем.

Создание/Открытие ZIP-архива

ZipFile::__construct**

Инициализирует ZIP-архив

 $ zipFile = new  PhpZip  ZipFile ();

ZipFile::openFile

Открывает zip-архив из файла.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> openFile ( ' file.zip ' );

ZipFile::openFromString

Открывает zip-архив из строки.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> openFromString ( $ stringContents );

ZipFile::openFromStream

Открывает zip-архив из потока.

 $ stream = fopen ( ' file.zip ' , ' rb ' );

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> openFromStream ( $ stream );

Чтение записей из архива

ZipFile::count

Возвращает количество записей в архиве.

 $ zipFile = new  PhpZip  ZipFile ();

$ count = count ( $ zipFile );
// or
$ count = $ zipFile -> count ();

ZipFile::getListFiles

Возвращает список файлов архива.

 $ zipFile = new  PhpZip  ZipFile ();
$ listFiles = $ zipFile -> getListFiles ();

// example array contents:
// array (
//   0 => 'info.txt',
//   1 => 'path/to/file.jpg',
//   2 => 'another path/',
//   3 => '0',
// )

ZipFile::getEntryContent

Возвращает содержимое записи, используя ее имя.

 // $entryName = 'path/to/example-entry-name.txt';
$ zipFile = new  PhpZip  ZipFile ();

$ contents = $ zipFile [ $ entryName ];
// or
$ contents = $ zipFile -> getEntryContents ( $ entryName );

ZipFile::hasEntry

Проверяет, есть ли запись в архиве.

 // $entryName = 'path/to/example-entry-name.txt';
$ zipFile = new  PhpZip  ZipFile ();

$ hasEntry = isset ( $ zipFile [ $ entryName ]);
// or
$ hasEntry = $ zipFile -> hasEntry ( $ entryName );

ZipFile::isDirectory

Проверяет, что запись в архиве является каталогом.

 // $entryName = 'path/to/';
$ zipFile = new  PhpZip  ZipFile ();

$ isDirectory = $ zipFile -> isDirectory ( $ entryName );

ZipFile::extractTo

Извлеките содержимое архива. Каталог должен существовать.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> extractTo ( $ directory );

Извлеките несколько файлов в каталог. Каталог должен существовать.

 // $toDirectory = '/tmp';
$ extractOnlyFiles = [
    ' filename1 ' , 
    ' filename2 ' , 
    ' dir/dir/dir/ '
];
$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> extractTo ( $ toDirectory , $ extractOnlyFiles );

Итерация записей

ZipFile — это итератор. Может перебирать все записи в цикле foreach .

 foreach ( $ zipFile as $ entryName => $ contents ){
    echo " Filename: $ entryName " . PHP_EOL ;
    echo " Contents: $ contents " . PHP_EOL ;
    echo ' ----------------------------- ' . PHP_EOL ;
}

Может перебирать Iterator .

 $ iterator = new  ArrayIterator ( $ zipFile );
while ( $ iterator -> valid ())
{
    $ entryName = $ iterator -> key ();
    $ contents = $ iterator -> current ();

    echo " Filename: $ entryName " . PHP_EOL ;
    echo " Contents: $ contents " . PHP_EOL ;
    echo ' ----------------------------- ' . PHP_EOL ;

    $ iterator -> next ();
}

Получение информации о записях

ZipFile::getArchiveComment

Возвращает комментарий к ZIP-архиву.

 $ zipFile = new  PhpZip  ZipFile ();
$ commentArchive = $ zipFile -> getArchiveComment ();

ZipFile::getEntryComment

Возвращает комментарий к записи, используя имя записи.

 $ zipFile = new  PhpZip  ZipFile ();
$ commentEntry = $ zipFile -> getEntryComment ( $ entryName );

Добавление записей в архив

Все способы добавления записей в ZIP-архив позволяют указать метод сжатия содержимого.

Доступны следующие методы сжатия:

PhpZipConstantsZipCompressionMethod::STORED — без сжатия
PhpZipConstantsZipCompressionMethod::DEFLATED — выключить сжатие
PhpZipConstantsZipCompressionMethod::BZIP2 — сжатие Bzip2 с расширением ext-bz2

ZipFile::addFile

Добавляет файл в ZIP-архив по заданному пути.

 $ zipFile = new  PhpZip  ZipFile ();
// $file = '...../file.ext'; 
// $entryName = 'file2.ext'
$ zipFile -> addFile ( $ file );

// you can specify the name of the entry in the archive (if null, then the last component from the file name is used)
$ zipFile -> addFile ( $ file , $ entryName );

// you can specify a compression method
$ zipFile -> addFile ( $ file , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFile ( $ file , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFile ( $ file , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

ZipFile::addSplFile

Добавляет SplFileInfo в ZIP-архив.

 // $file = '...../file.ext'; 
// $entryName = 'file2.ext'
$ zipFile = new  PhpZip  ZipFile ();

$ splFile = new  SplFileInfo ( ' README.md ' );

$ zipFile -> addSplFile ( $ splFile );
$ zipFile -> addSplFile ( $ splFile , $ entryName );
// or
$ zipFile [ $ entryName ] = new  SplFileInfo ( $ file );

// set compression method
$ zipFile -> addSplFile ( $ splFile , $ entryName , $ options = [
     PhpZip  Constants ZipOptions:: COMPRESSION_METHOD =>  PhpZip  Constants ZipCompressionMethod:: DEFLATED ,
]);

ZipFile::addFromFinder

Добавляет файлы из SymfonyComponentFinderFinder в ZIP-архив.

 $ finder = new  Symfony  Component  Finder  Finder ();
$ finder
    -> files ()
    -> name ( ' *.{jpg,jpeg,gif,png} ' )
    -> name ( ' /^[0-9a-f]./ ' )
    -> contains ( ' /lorems+ipsum$/i ' )
    -> in ( ' path ' );

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFromFinder ( $ finder , $ options = [
     PhpZip  Constants ZipOptions:: COMPRESSION_METHOD =>  PhpZip  Constants ZipCompressionMethod:: DEFLATED ,
     PhpZip  Constants ZipOptions:: MODIFIED_TIME => new  DateTimeImmutable ( ' -1 day 5 min ' )
]);

ZipFile::addFromString

Добавляет файл в ZIP-архив, используя его содержимое.

 $ zipFile = new  PhpZip  ZipFile ();

$ zipFile [ $ entryName ] = $ contents ;
// or
$ zipFile -> addFromString ( $ entryName , $ contents );

// you can specify a compression method
$ zipFile -> addFromString ( $ entryName , $ contents ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFromString ( $ entryName , $ contents ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFromString ( $ entryName , $ contents ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

ZipFile::addFromStream

Добавляет запись из потока в ZIP-архив.

 $ zipFile = new  PhpZip  ZipFile ();
// $stream = fopen(..., 'rb');

$ zipFile -> addFromStream ( $ stream , $ entryName );
// or
$ zipFile [ $ entryName ] = $ stream ;

// you can specify a compression method
$ zipFile -> addFromStream ( $ stream , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFromStream ( $ stream , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFromStream ( $ stream , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

ZipFile::addEmptyDir

Добавьте новый каталог.

 $ zipFile = new  PhpZip  ZipFile ();
// $path = "path/to/";
$ zipFile -> addEmptyDir ( $ path );
// or
$ zipFile [ $ path ] = null ;

ZipFile::addAll

Добавляет все записи из массива.

 $ entries = [
    ' file.txt ' => ' file contents ' , // add an entry from the string contents
    ' empty dir/ ' => null , // add empty directory
    ' path/to/file.jpg ' => fopen ( ' ..../filename ' , ' rb ' ), // add an entry from the stream
    ' path/to/file.dat ' => new  SplFileInfo ( ' ..../filename ' ), // add an entry from the file
];

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addAll ( $ entries );

ZipFile::addDir

Добавляет в архив файлы из каталога по указанному пути без подкаталогов.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addDir ( $ dirName );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addDir ( $ dirName , $ localPath );

// you can specify a compression method
$ zipFile -> addDir ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addDir ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addDir ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

ZipFile::addDirRecursive

Добавляет в архив файлы из каталога по указанному пути с подкаталогами.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addDirRecursive ( $ dirName );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addDirRecursive ( $ dirName , $ localPath );

// you can specify a compression method
$ zipFile -> addDirRecursive ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addDirRecursive ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addDirRecursive ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

ZipFile::addFilesFromIterator

Добавляет файлы из итератора каталогов.

 // $directoryIterator = new DirectoryIterator($dir); // without subdirectories
// $directoryIterator = new RecursiveDirectoryIterator($dir); // with subdirectories
$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromIterator ( $ directoryIterator );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath );
// or
$ zipFile [ $ localPath ] = $ directoryIterator ;

// you can specify a compression method
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

Пример с игнорированием некоторых файлов:

 $ ignoreFiles = [
    ' file_ignore.txt ' , 
    ' dir_ignore/sub dir ignore/ '
];

// $directoryIterator = new DirectoryIterator($dir); // without subdirectories
// $directoryIterator = new RecursiveDirectoryIterator($dir); // with subdirectories
// use PhpZipUtilIteratorIgnoreFilesFilterIterator for non-recursive search
 
$ zipFile = new  PhpZip  ZipFile ();
$ ignoreIterator = new  PhpZip  Util  Iterator  IgnoreFilesRecursiveFilterIterator (
    $ directoryIterator , 
    $ ignoreFiles
);

$ zipFile -> addFilesFromIterator ( $ ignoreIterator );

ZipFile::addFilesFromGlob

Добавляет файлы из каталога по шаблону без подкаталогов.

 $ globPattern = ' **.{jpg,jpeg,png,gif} ' ; // example glob pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

ZipFile::addFilesFromGlobRecursive

Добавляет файлы из каталога по шаблону glob с подкаталогами.

 $ globPattern = ' **.{jpg,jpeg,png,gif} ' ; // example glob pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

ZipFile::addFilesFromRegex

Добавляет файлы из каталога по шаблону PCRE без подкаталогов.

 $ regexPattern = ' /.(jpe?g|png|gif)$/si ' ; // example regex pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

ZipFile::addFilesFromRegexRecursive

Добавляет файлы из каталога по шаблону PCRE с подкаталогами.

 $ regexPattern = ' /.(jpe?g|png|gif)$/si ' ; // example regex pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

Удаление записей из архива

ZipFile::deleteFromName

Удаляет запись в архиве по ее имени.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteFromName ( $ entryName );

ZipFile::deleteFromGlob

Удаляет записи в архиве, используя шаблон glob.

 $ globPattern = ' **.{jpg,jpeg,png,gif} ' ; // example glob pattern -> delete all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteFromGlob ( $ globPattern );

ZipFile::deleteFromRegex

Удаляет записи в архиве по шаблону PCRE.

 $ regexPattern = ' /.(jpe?g|png|gif)$/si ' ; // example regex pattern -> delete all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteFromRegex ( $ regexPattern );

ZipFile::deleteAll

Удаляет все записи в ZIP-архиве.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteAll ();

Работа с записями и архивом

ZipFile::переименовать

Переименовывает запись, определенную ее именем.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> rename ( $ oldName , $ newName );

ZipFile::setCompressionLevel

Установите уровень сжатия для всех файлов в архиве.

Обратите внимание, что этот метод не применяется к записям, добавленным после запуска этого метода.

По умолчанию уровень сжатия равен 5 ( PhpZipConstantsZipCompressionLevel::NORMAL ) или уровню сжатия, указанному в архиве для сжатия Deflate.

Поддерживаются значения в диапазоне от 1 ( PhpZipConstantsZipCompressionLevel::SUPER_FAST ) до 9 ( PhpZipConstantsZipCompressionLevel::MAXIMUM ). Чем выше число, тем лучше и дольше сжатие.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setCompressionLevel ( PhpZip  Constants ZipCompressionLevel:: MAXIMUM );

ZipFile::setCompressionLevelEntry

Устанавливает уровень сжатия записи по ее имени.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setCompressionLevelEntry ( $ entryName ,  PhpZip  Constants ZipCompressionLevel:: FAST );

ZipFile::setCompressionMethodEntry

Устанавливает метод сжатия записи по ее имени.

Доступны следующие методы сжатия:

PhpZipConstantsZipCompressionMethod::STORED — без сжатия
PhpZipConstantsZipCompressionMethod::DEFLATED — выключить сжатие
PhpZipConstantsZipCompressionMethod::BZIP2 — сжатие Bzip2 с расширением ext-bz2

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setCompressionMethodEntry ( $ entryName ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED );

ZipFile::setArchiveComment

Установите комментарий ZIP-архива.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setArchiveComment ( $ commentArchive );

ZipFile::setEntryComment

Установите комментарий к записи, определяемый ее именем.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setEntryComment ( $ entryName , $ comment );

ZipFile::сопоставитель

Выбор записей в архиве для выполнения над ними операций.

 $ zipFile = new  PhpZip  ZipFile ();
$ matcher = $ zipFile -> matcher ();

Выбор файлов из архива по одному:

 $ matcher
    -> add ( ' entry name ' )
    -> add ( ' another entry ' );

Выберите несколько файлов в архиве:

 $ matcher -> add ([
    ' entry name ' ,
    ' another entry name ' ,
    ' path/ '
]);

Выбор файлов по регулярному выражению:

 $ matcher -> match ( ' ~.jpe?g$~i ' );

Выбрать все файлы в архиве:

 $ matcher -> all ();

count() — получает количество выбранных записей:

 $ count = count ( $ matcher );
// or
$ count = $ matcher -> count ();

getMatches() — возвращает список выбранных записей:

 $ entries = $ matcher -> getMatches ();
// example array contents: ['entry name', 'another entry name'];

вызвать() — вызвать вызываемую функцию для выбранных записей:

 // example
$ matcher -> invoke ( static function ( $ entryName ) use ( $ zipFile ) {
    $ newName = preg_replace ( ' ~.(jpe?g)$~i ' , ' .no_optimize.$1 ' , $ entryName );
    $ zipFile -> rename ( $ entryName , $ newName );
});

Функции для работы с выбранными записями:

 $ matcher -> delete (); // remove selected entries from a ZIP archive
$ matcher -> setPassword ( $ password ); // sets a new password for the selected entries
$ matcher -> setPassword ( $ password , $ encryptionMethod ); // sets a new password and encryption method to selected entries
$ matcher -> setEncryptionMethod ( $ encryptionMethod ); // sets the encryption method to the selected entries
$ matcher -> disableEncryption (); // disables encryption for selected entries

Работа с паролями

Реализована поддержка методов шифрования:

PhpZipConstantsZipEncryptionMethod::PKWARE — традиционное шифрование PKWARE (устаревшее)
PhpZipConstantsZipEncryptionMethod::WINZIP_AES_256 — 256-битное шифрование WinZip AES (рекомендуется)
PhpZipConstantsZipEncryptionMethod::WINZIP_AES_192 — 192-битное шифрование WinZip AES.
PhpZipConstantsZipEncryptionMethod::WINZIP_AES_128 — 128-битное шифрование WinZip AES.

ZipFile::setReadPassword

Установите пароль для открытого архива.

Установка пароля не требуется для добавления новых записей или удаления существующих, но если вы хотите извлечь контент или изменить метод/уровень сжатия, метод шифрования или сменить пароль, в этом случае пароль необходимо указать.

 $ zipFile -> setReadPassword ( $ password );

ZipFile::setReadPasswordEntry

Получает пароль для чтения записи, определенной ее именем.

 $ zipFile -> setReadPasswordEntry ( $ entryName , $ password );

ZipFile::setPassword

Устанавливает новый пароль для всех файлов в архиве.

Обратите внимание, что этот метод не применяется к записям, добавленным после запуска этого метода.

 $ zipFile -> setPassword ( $ password );

Вы можете установить метод шифрования:

 $ encryptionMethod =  PhpZip  Constants ZipEncryptionMethod:: WINZIP_AES_256 ;
$ zipFile -> setPassword ( $ password , $ encryptionMethod );

ZipFile::setPasswordEntry

Устанавливает новый пароль для записи, определяемой ее именем.

 $ zipFile -> setPasswordEntry ( $ entryName , $ password );

Вы можете установить метод шифрования:

 $ encryptionMethod =  PhpZip  Constants ZipEncryptionMethod:: WINZIP_AES_256 ;
$ zipFile -> setPasswordEntry ( $ entryName , $ password , $ encryptionMethod );

ZipFile::disableEncryption

Отключите шифрование для всех записей, которые уже есть в архиве.

Обратите внимание, что этот метод не применяется к записям, добавленным после запуска этого метода.

 $ zipFile -> disableEncryption ();

ZipFile::disableEncryptionEntry

Отключить шифрование записи, определяемой ее именем.

 $ zipFile -> disableEncryptionEntry ( $ entryName );

Отменить изменения

ZipFile::unchangeAll

Отменить все изменения, сделанные в архиве.

 $ zipFile -> unchangeAll ();

ZipFile::unchangeArchiveComment

Отменить изменения в архивном комментарии.

 $ zipFile -> unchangeArchiveComment ();

ZipFile::unchangeEntry

Отменить изменения записи, определенной ее именем.

 $ zipFile -> unchangeEntry ( $ entryName );

Сохранение файла или вывод в браузер

ZipFile::saveAsFile

Сохраняет архив в файл.

 $ zipFile -> saveAsFile ( $ filename );

ZipFile::saveAsStream

Записывает архив в поток.

 // $fp = fopen($filename, 'w+b');

$ zipFile -> saveAsStream ( $ fp );

ZipFile::outputAsString

Выводит ZIP-архив в виде строки.

 $ rawZipArchiveBytes = $ zipFile -> outputAsString ();

ZipFile::outputAsAttachment

Выводит ZIP-архив в браузер.

 $ zipFile -> outputAsAttachment ( $ outputFilename );

Вы можете установить Mime-Type:

 $ mimeType = ' application/zip ' ;
$ zipFile -> outputAsAttachment ( $ outputFilename , $ mimeType );

ZipFile::outputAsPsr7Response

Выводит ZIP-архив как ответ PSR-7.

Метод вывода можно использовать в любой платформе, совместимой с PSR-7.

 // $response = ....; // instance PsrHttpMessageResponseInterface
$ zipFile -> outputAsPsr7Response ( $ response , $ outputFilename );

Вы можете установить Mime-Type:

 $ mimeType = ' application/zip ' ;
$ zipFile -> outputAsPsr7Response ( $ response , $ outputFilename , $ mimeType );

ZipFile::outputAsSymfonyResponse

Выводит ZIP-архив как ответ Symfony.

Метод вывода можно использовать в среде Symfony.

 $ response = $ zipFile -> outputAsSymfonyResponse ( $ outputFilename );

Вы можете установить Mime-Type:

 $ mimeType = ' application/zip ' ;
$ response = $ zipFile -> outputAsSymfonyResponse ( $ outputFilename , $ mimeType );

Пример использования в Symfony Controller:

 <?php

namespace App  Controller ;

use PhpZip  ZipFile ;
use Symfony  Component  HttpFoundation  Response ;
use Symfony  Component  Routing  Annotation  Route ;

class DownloadZipController
{
    /**
     * @Route("/downloads/{id}")
     *
     * @throws PhpZipExceptionZipException
     */
    public function __invoke ( string $ id ): Response
    {
        $ zipFile = new ZipFile ();
        $ zipFile [ ' file ' ] = ' contents ' ;

        $ outputFilename = $ id . ' .zip ' ;
        return $ zipFile -> outputAsSymfonyResponse ( $ outputFilename );
    }
}

ZipFile::rewrite

Сохраните изменения и заново откройте измененный архив.

 $ zipFile -> rewrite ();

Закрытие архива

ZipFile::закрыть

Закройте архив.

 $ zipFile -> close ();

Запуск тестов

Установите зависимости для разработки:

composer install --dev

Запустите тесты:

vendor/bin/phpunit

Журнал изменений

Изменения документированы на странице релизов.

Обновление

Обновите версию 3 до версии 4

Обновите основную версию файла composer.json до ^4.0 .

{
    "require" : {
        "nelexa/zip" : " ^4.0 "
    }
}

Затем установите обновления с помощью Composer :

composer update nelexa/zip

Обновите свой код для работы с новой версией: BC.

удалены устаревшие классы и методы.
удален функционал zipalign . Эта функциональность будет помещена в отдельный пакет nelexa/apkfile .

Обновите версию 2 до версии 3

Обновите основную версию файла composer.json до ^3.0 .

{
    "require" : {
        "nelexa/zip" : " ^3.0 "
    }
}

Затем установите обновления с помощью Composer :

composer update nelexa/zip

Обновите свой код для работы с новой версией:

Класс ZipOutputFile объединен с ZipFile и удален.
- new PhpZipZipOutputFile() в new PhpZipZipFile()
Статические методы инициализации теперь не являются статическими.
- PhpZipZipFile::openFromFile($filename); to (new PhpZipZipFile())->openFile($filename);
- PhpZipZipOutputFile::openFromFile($filename); to (new PhpZipZipFile())->openFile($filename);
- PhpZipZipFile::openFromString($contents); to (new PhpZipZipFile())->openFromString($contents);
- PhpZipZipFile::openFromStream($stream); to (new PhpZipZipFile())->openFromStream($stream);
- PhpZipZipOutputFile::create() в new PhpZipZipFile()
- PhpZipZipOutputFile::openFromZipFile(PhpZipZipFile $zipFile) > (new PhpZipZipFile())->openFile($filename);
Переименование методов:
- addFromFile в addFile
- setLevel для setCompressionLevel
- ZipFile::setPassword в ZipFile::withReadPassword
- ZipOutputFile::setPassword в ZipFile::withNewPassword
- ZipOutputFile::disableEncryptionAllEntries в ZipFile::withoutPassword
- ZipOutputFile::setComment в ZipFile::setArchiveComment
- ZipFile::getComment в ZipFile::getArchiveComment
Изменена сигнатура методов addDir , addFilesFromGlob , addFilesFromRegex .
Удалить методы:
- getLevel
- setCompressionMethod
- setEntryPassword

Расширять

php zip

Версии и зависимости

Оглавление

Функции

Требования

Установка

Примеры

Глоссарий

Документация:

Обзор методов класса PhpZipZipFile

Создание/Открытие ZIP-архива

ZipFile::__construct**

ZipFile::openFile

ZipFile::openFromString

ZipFile::openFromStream

Чтение записей из архива

ZipFile::count

ZipFile::getListFiles

ZipFile::getEntryContent

ZipFile::hasEntry

ZipFile::isDirectory

ZipFile::extractTo

Итерация записей

Получение информации о записях

ZipFile::getArchiveComment

ZipFile::getEntryComment

Добавление записей в архив

ZipFile::addFile

ZipFile::addSplFile

ZipFile::addFromFinder

ZipFile::addFromString

ZipFile::addFromStream

ZipFile::addEmptyDir

ZipFile::addAll

ZipFile::addDir

ZipFile::addDirRecursive

ZipFile::addFilesFromIterator

ZipFile::addFilesFromGlob

ZipFile::addFilesFromGlobRecursive

ZipFile::addFilesFromRegex

ZipFile::addFilesFromRegexRecursive

Удаление записей из архива

ZipFile::deleteFromName

ZipFile::deleteFromGlob

ZipFile::deleteFromRegex

ZipFile::deleteAll

Работа с записями и архивом

ZipFile::переименовать

ZipFile::setCompressionLevel

ZipFile::setCompressionLevelEntry

ZipFile::setCompressionMethodEntry

ZipFile::setArchiveComment

ZipFile::setEntryComment

ZipFile::сопоставитель

Работа с паролями

ZipFile::setReadPassword

ZipFile::setReadPasswordEntry

ZipFile::setPassword

ZipFile::setPasswordEntry

ZipFile::disableEncryption

ZipFile::disableEncryptionEntry

Отменить изменения

ZipFile::unchangeAll

ZipFile::unchangeArchiveComment

ZipFile::unchangeEntry

Сохранение файла или вывод в браузер

ZipFile::saveAsFile

ZipFile::saveAsStream

ZipFile::outputAsString

ZipFile::outputAsAttachment

ZipFile::outputAsPsr7Response

ZipFile::outputAsSymfonyResponse

ZipFile::rewrite

Закрытие архива

ZipFile::закрыть

Запуск тестов

Журнал изменений

Обновление

Обновите версию 3 до версии 4

Обновите версию 2 до версии 3

Обзор методов класса `PhpZipZipFile`