lizhen_gitee d2cd22c475 加上忽略掉的 | пре 3 година | |
---|---|---|
.. | ||
src | пре 3 година | |
.phpstorm.meta.php | пре 3 година | |
LICENSE | пре 3 година | |
README.RU.md | пре 3 година | |
README.md | пре 3 година | |
composer.json | пре 3 година |
PhpZip
PhpZip
- php библиотека для продвинутой работы с ZIP-архивами.
\PhpZip\ZipFile
php-zip
и класс \ZipArchive
).php-bz2
.ZIP64
(размер файла более 4 GB или количество записей в архиве более 65535).zipalign
.Traditional PKWARE Encryption (ZipCrypto)
.
> Используйте метод шифрования WinZIP AES Encryption
, когда это возможно.
Traditional PKWARE Encryption (ZipCrypto)
и WinZIP AES Encryption (128, 192 или 256 bit)
.PHP
>= 5.5 (предпочтительно 64-bit).bzip2
для поддержки BZIP2 компрессии.openssl
или mcrypt
для WinZip Aes Encryption
шифрования.composer require nelexa/zip
// создание нового архива
$zipFile = new \PhpZip\ZipFile();
try{
$zipFile
->addFromString('zip/entry/filename', "Is file content") // добавить запись из строки
->addFile('/path/to/file', 'data/tofile') // добавить запись из файла
->addDir(__DIR__, 'to/path/') // добавить файлы из директории
->saveAsFile($outputFilename) // сохранить архив в файл
->close(); // закрыть архив
// открытие архива, извлечение файлов, удаление файлов, добавление файлов, установка пароля и вывод архива в браузер.
$zipFile
->openFile($outputFilename) // открыть архив из файла
->extractTo($outputDirExtract) // извлечь файлы в заданную директорию
->deleteFromRegex('~^\.~') // удалить все скрытые (Unix) файлы
->addFromString('dir/file.txt', 'Test file') // добавить новую запись из строки
->setPassword('password') // установить пароль на все записи
->outputAsAttachment('library.jar'); // вывести в браузер без сохранения в файл
}
catch(\PhpZip\Exception\ZipException $e){
// обработка исключения
}
finally{
$zipFile->close();
}
Другие примеры можно посмотреть в папке tests/
.
Запись в ZIP-архиве (Zip Entry) - файл или папка в ZIP-архиве. У каждой записи в архиве есть определённые свойства, например: имя файла, метод сжатия, метод шифрования, размер файла до сжатия, размер файла после сжатия, CRC32 и другие.
\PhpZip\ZipFile
\SplFileInfo
в zip-архив.Symfony\Component\Finder\Finder
в 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);
// или
$count = $zipFile->count();
ZipFile::getListFiles - возвращает список файлов архива.
$zipFile = new \PhpZip\ZipFile();
$listFiles = $zipFile->getListFiles();
// Пример содержимого массива:
// array (
// 0 => 'info.txt',
// 1 => 'path/to/file.jpg',
// 2 => 'another path/',
// )
ZipFile::getEntryContent - возвращает содержимое записи.
// $entryName = 'path/to/example-entry-name.txt';
$zipFile = new \PhpZip\ZipFile();
$contents = $zipFile[$entryName];
// или
$contents = $zipFile->getEntryContents($entryName);
ZipFile::hasEntry - проверяет, присутствует ли запись в архиве.
// $entryName = 'path/to/example-entry-name.txt';
$zipFile = new \PhpZip\ZipFile();
$hasEntry = isset($zipFile[$entryName]);
// или
$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);
Можно извлечь только некоторые записи в заданную директорию. Директория должна существовать.
$extractOnlyFiles = [
'filename1',
'filename2',
'dir/dir/dir/'
];
$zipFile = new \PhpZip\ZipFile();
$zipFile->extractTo($toDirectory, $extractOnlyFiles);
ZipFile
является итератором.
Можно перебрать все записи, через цикл foreach
.
foreach($zipFile as $entryName => $contents){
echo "Файл: $entryName" . PHP_EOL;
echo "Содержимое: $contents" . PHP_EOL;
echo '-----------------------------' . PHP_EOL;
}
Можно использовать паттерн Iterator
.
$iterator = new \ArrayIterator($zipFile);
while ($iterator->valid())
{
$entryName = $iterator->key();
$contents = $iterator->current();
echo "Файл: $entryName" . PHP_EOL;
echo "Содержимое: $contents" . PHP_EOL;
echo '-----------------------------' . PHP_EOL;
$iterator->next();
}
ZipFile::getArchiveComment - возвращает комментарий ZIP-архива.
$commentArchive = $zipFile->getArchiveComment();
ZipFile::getEntryComment - возвращает комментарий к записи, используя её имя.
$commentEntry = $zipFile->getEntryComment($entryName);
ZipFile::getEntryInfo - возвращает подробную информацию о записи в архиве.
$zipFile = new \PhpZip\ZipFile();
$zipInfo = $zipFile->getEntryInfo('file.txt');
ZipFile::getAllInfo - возвращает подробную информацию обо всех записях в архиве.
$zipAllInfo = $zipFile->getAllInfo();
Все методы добавления записей в ZIP-архив позволяют указать метод сжатия содержимого.
Доступны следующие методы сжатия:
\PhpZip\Constants\ZipCompressionMethod::STORED
- без сжатия\PhpZip\Constants\ZipCompressionMethod::DEFLATED
- Deflate сжатие\PhpZip\Constants\ZipCompressionMethod::BZIP2
- Bzip2 сжатие при наличии расширения ext-bz2
ZipFile::addFile - добавляет в ZIP-архив файл по указанному пути из файловой системы.
$zipFile = new \PhpZip\ZipFile();
// $file = '...../file.ext';
$zipFile->addFile($file);
// можно указать имя записи в архиве (если null, то используется последний компонент из имени файла)
$zipFile->addFile($file, $entryName);
// можно указать метод сжатия
$zipFile->addFile($file, $entryName, \PhpZip\Constants\ZipCompressionMethod::STORED); // Без сжатия
$zipFile->addFile($file, $entryName, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate сжатие
$zipFile->addFile($file, $entryName, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 сжатие
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);
// установить метод сжатия
$zipFile->addSplFile($splFile, $entryName, $options = [
\PhpZip\Constants\ZipOptions::COMPRESSION_METHOD => \PhpZip\Constants\ZipCompressionMethod::DEFLATED,
]);
ZipFile::addFromFinder" - добавляет файлы из Symfony\Component\Finder\Finder
в zip архив.
https://symfony.com/doc/current/components/finder.html
$finder = new \Symfony\Component\Finder\Finder();
$finder
->files()
->name('*.{jpg,jpeg,gif,png}')
->name('/^[0-9a-f]\./')
->contains('/lorem\s+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;
// или
$zipFile->addFromString($entryName, $contents);
// можно указать метод сжатия
$zipFile->addFromString($entryName, $contents, \PhpZip\Constants\ZipCompressionMethod::STORED); // Без сжатия
$zipFile->addFromString($entryName, $contents, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate сжатие
$zipFile->addFromString($entryName, $contents, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 сжатие
ZipFile::addFromStream - добавляет в ZIP-архив запись из потока.
// $stream = fopen(..., 'rb');
$zipFile->addFromStream($stream, $entryName);
// можно указать метод сжатия
$zipFile->addFromStream($stream, $entryName, \PhpZip\Constants\ZipCompressionMethod::STORED); // Без сжатия
$zipFile->addFromStream($stream, $entryName, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate сжатие
$zipFile->addFromStream($stream, $entryName, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 сжатие
ZipFile::addEmptyDir - добавляет в ZIP-архив новую (пустую) директорию.
// $path = "path/to/";
$zipFile->addEmptyDir($path);
// или
$zipFile[$path] = null;
ZipFile::addAll - добавляет все записи из массива.
$entries = [
'file.txt' => 'file contents', // запись из строки данных
'empty dir/' => null, // пустой каталог
'path/to/file.jpg' => fopen('..../filename', 'r'), // запись из потока
'path/to/file.dat' => new \SplFileInfo('..../filename'), // запись из файла
];
$zipFile->addAll($entries);
ZipFile::addDir - добавляет файлы из директории по указанному пути без вложенных директорий.
$zipFile->addDir($dirName);
// можно указать путь в архиве в который необходимо поместить записи
$localPath = "to/path/";
$zipFile->addDir($dirName, $localPath);
// можно указать метод сжатия
$zipFile->addDir($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::STORED); // Без сжатия
$zipFile->addDir($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate сжатие
$zipFile->addDir($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 сжатие
ZipFile::addDirRecursive - добавляет файлы из директории по указанному пути c вложенными директориями.
$zipFile->addDirRecursive($dirName);
// можно указать путь в архиве в который необходимо поместить записи
$localPath = "to/path/";
$zipFile->addDirRecursive($dirName, $localPath);
// можно указать метод сжатия
$zipFile->addDirRecursive($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::STORED); // Без сжатия
$zipFile->addDirRecursive($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate сжатие
$zipFile->addDirRecursive($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 сжатие
ZipFile::addFilesFromIterator - добавляет файлы из итератора директорий.
// $directoryIterator = new \DirectoryIterator($dir); // без вложенных директорий
// $directoryIterator = new \RecursiveDirectoryIterator($dir); // с вложенными директориями
$zipFile->addFilesFromIterator($directoryIterator);
// можно указать путь в архиве в который необходимо поместить записи
$localPath = "to/path/";
$zipFile->addFilesFromIterator($directoryIterator, $localPath);
// или
$zipFile[$localPath] = $directoryIterator;
// можно указать метод сжатия
$zipFile->addFilesFromIterator($directoryIterator, $localPath, \PhpZip\Constants\ZipCompressionMethod::STORED); // Без сжатия
$zipFile->addFilesFromIterator($directoryIterator, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate сжатие
$zipFile->addFilesFromIterator($directoryIterator, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 сжатие
Пример добавления файлов из директории в архив с игнорированием некоторых файлов при помощи итератора директорий.
$ignoreFiles = [
"file_ignore.txt",
"dir_ignore/sub dir ignore/"
];
// $directoryIterator = new \DirectoryIterator($dir); // без вложенных директорий
// $directoryIterator = new \RecursiveDirectoryIterator($dir); // с вложенными директориями
// используйте \PhpZip\Util\Iterator\IgnoreFilesFilterIterator для не рекурсивного поиска
$ignoreIterator = new \PhpZip\Util\Iterator\IgnoreFilesRecursiveFilterIterator(
$directoryIterator,
$ignoreFiles
);
$zipFile->addFilesFromIterator($ignoreIterator);
ZipFile::addFilesFromGlob - добавляет файлы из директории в соответствии с glob шаблоном без вложенных директорий.
$globPattern = '**.{jpg,jpeg,png,gif}'; // пример glob шаблона -> добавить все .jpg, .jpeg, .png и .gif файлы
$zipFile->addFilesFromGlob($dir, $globPattern);
// можно указать путь в архиве в который необходимо поместить записи
$localPath = "to/path/";
$zipFile->addFilesFromGlob($dir, $globPattern, $localPath);
// можно указать метод сжатия
$zipFile->addFilesFromGlob($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::STORED); // Без сжатия
$zipFile->addFilesFromGlob($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate сжатие
$zipFile->addFilesFromGlob($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 сжатие
ZipFile::addFilesFromGlobRecursive - добавляет файлы из директории в соответствии с glob шаблоном c вложенными директориями.
$globPattern = '**.{jpg,jpeg,png,gif}'; // пример glob шаблона -> добавить все .jpg, .jpeg, .png и .gif файлы
$zipFile->addFilesFromGlobRecursive($dir, $globPattern);
// можно указать путь в архиве в который необходимо поместить записи
$localPath = "to/path/";
$zipFile->addFilesFromGlobRecursive($dir, $globPattern, $localPath);
// можно указать метод сжатия
$zipFile->addFilesFromGlobRecursive($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::STORED); // Без сжатия
$zipFile->addFilesFromGlobRecursive($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate сжатие
$zipFile->addFilesFromGlobRecursive($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 сжатие
ZipFile::addFilesFromRegex - добавляет файлы из директории в соответствии с регулярным выражением без вложенных директорий.
$regexPattern = '/\.(jpe?g|png|gif)$/si'; // пример регулярного выражения -> добавить все .jpg, .jpeg, .png и .gif файлы
$zipFile->addFilesFromRegex($dir, $regexPattern);
// можно указать путь в архиве в который необходимо поместить записи
$localPath = "to/path/";
$zipFile->addFilesFromRegex($dir, $regexPattern, $localPath);
// можно указать метод сжатия
$zipFile->addFilesFromRegex($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::STORED); // Без сжатия
$zipFile->addFilesFromRegex($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate сжатие
$zipFile->addFilesFromRegex($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 сжатие
ZipFile::addFilesFromRegexRecursive - добавляет файлы из директории в соответствии с регулярным выражением с вложенными директориями.
$regexPattern = '/\.(jpe?g|png|gif)$/si'; // пример регулярного выражения -> добавить все .jpg, .jpeg, .png и .gif файлы
$zipFile->addFilesFromRegexRecursive($dir, $regexPattern);
// можно указать путь в архиве в который необходимо поместить записи
$localPath = "to/path/";
$zipFile->addFilesFromRegexRecursive($dir, $regexPattern, $localPath);
// можно указать метод сжатия
$zipFile->addFilesFromRegexRecursive($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::STORED); // Без сжатия
$zipFile->addFilesFromRegexRecursive($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate сжатие
$zipFile->addFilesFromRegexRecursive($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 сжатие
ZipFile::deleteFromName - удаляет запись по имени.
$zipFile->deleteFromName($entryName);
ZipFile::deleteFromGlob - удаляет записи в соответствии с glob шаблоном.
$globPattern = '**.{jpg,jpeg,png,gif}'; // пример glob шаблона -> удалить все .jpg, .jpeg, .png и .gif файлы
$zipFile->deleteFromGlob($globPattern);
ZipFile::deleteFromRegex - удаляет записи в соответствии с регулярным выражением.
$regexPattern = '/\.(jpe?g|png|gif)$/si'; // пример регулярному выражения -> удалить все .jpg, .jpeg, .png и .gif файлы
$zipFile->deleteFromRegex($regexPattern);
ZipFile::deleteAll - удаляет все записи в ZIP-архиве.
$zipFile->deleteAll();
ZipFile::rename - переименовывает запись по имени.
$zipFile->rename($oldName, $newName);
ZipFile::setCompressionLevel - устанавливает уровень сжатия для всех файлов, находящихся в архиве.
Обратите внимание, что действие данного метода не распространяется на записи, добавленные после выполнения этого метода.
По умолчанию используется уровень сжатия 5 (\PhpZip\Constants\ZipCompressionLevel::NORMAL
) или уровень сжатия, определённый в архиве для Deflate сжатия.
Поддерживаются диапазон значений от 1 (\PhpZip\Constants\ZipCompressionLevel::SUPER_FAST
) до 9 (\PhpZip\Constants\ZipCompressionLevel::MAXIMUM
). Чем выше число, тем лучше и дольше сжатие.
$zipFile->setCompressionLevel(\PhpZip\Constants\ZipCompressionLevel::MAXIMUM);
ZipFile::setCompressionLevelEntry - устанавливает уровень сжатия для определённой записи в архиве.
Поддерживаются диапазон значений от 1 (\PhpZip\Constants\ZipCompressionLevel::SUPER_FAST
) до 9 (\PhpZip\Constants\ZipCompressionLevel::MAXIMUM
). Чем выше число, тем лучше и дольше сжатие.
$zipFile->setCompressionLevelEntry($entryName, \PhpZip\Constants\ZipCompressionLevel::MAXIMUM);
ZipFile::setCompressionMethodEntry - устанавливает метод сжатия для определённой записи в архиве.
Доступны следующие методы сжатия:
\PhpZip\Constants\ZipCompressionMethod::STORED
- без сжатия\PhpZip\Constants\ZipCompressionMethod::DEFLATED
- Deflate сжатие\PhpZip\Constants\ZipCompressionMethod::BZIP2
- Bzip2 сжатие при наличии расширения ext-bz2
$zipFile->setCompressionMethodEntry($entryName, \PhpZip\Constants\ZipCompressionMethod::DEFLATED);
ZipFile::setArchiveComment - устанавливает комментарий к ZIP-архиву.
$zipFile->setArchiveComment($commentArchive);
ZipFile::setEntryComment - устанавливает комментарий к записи, используя её имя.
$zipFile->setEntryComment($entryName, $comment);
ZipFile::matcher - выборка записей в архиве для проведения операций над выбранными записями.
$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);
// или
$count = $matcher->count();
getMatches() - получает список выбранных записей:
$entries = $matcher->getMatches();
// пример содержимого: ['entry name', 'another entry name'];
invoke() - выполняет пользовательскую функцию над выбранными записями:
// пример
$matcher->invoke(function($entryName) use($zipFile) {
$newName = preg_replace('~\.(jpe?g)$~i', '.no_optimize.$1', $entryName);
$zipFile->rename($entryName, $newName);
});
Функции для работы над выбранными записями:
$matcher->delete(); // удалет выбранные записи из ZIP-архива
$matcher->setPassword($password); // устанавливает новый пароль на выбранные записи
$matcher->setPassword($password, $encryptionMethod); // устанавливает новый пароль и метод шифрования на выбранные записи
$matcher->setEncryptionMethod($encryptionMethod); // устанавливает метод шифрования на выбранные записи
$matcher->disableEncryption(); // отключает шифрование для выбранных записей
Реализована поддержка методов шифрования:
\PhpZip\Constants\ZipEncryptionMethod::PKWARE
- Traditional PKWARE encryption\PhpZip\Constants\ZipEncryptionMethod::WINZIP_AES_256
- WinZip AES encryption 256 bit (рекомендуемое)\PhpZip\Constants\ZipEncryptionMethod::WINZIP_AES_192
- WinZip AES encryption 192 bit\PhpZip\Constants\ZipEncryptionMethod::WINZIP_AES_128
- WinZip AES encryption 128 bitZipFile::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);
zipalign
ZipFile::setZipAlign - устанавливает выравнивание архива для оптимизации APK файлов (Android packages).
Метод добавляет паддинги незашифрованным и не сжатым записям, для оптимизации расхода памяти в системе Android. Рекомендуется использовать для APK
файлов. Файл может незначительно увеличиться.
Этот метод является альтернативой вызова команды zipalign -f -v 4 filename.zip
.
Подробнее можно ознакомиться по ссылке.
// вызовите до сохранения или вывода архива
$zipFile->setZipAlign(4);
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-тип:
$mimeType = 'application/zip'
$zipFile->outputAsAttachment($outputFilename, $mimeType);
ZipFile::outputAsResponse - выводит ZIP-архив, как Response PSR-7.
Метод вывода может использоваться в любом PSR-7 совместимом фреймворке.
// $response = ....; // instance Psr\Http\Message\ResponseInterface
$zipFile->outputAsResponse($response, $outputFilename);
Можно установить MIME-тип:
$mimeType = 'application/zip'
$zipFile->outputAsResponse($response, $outputFilename, $mimeType);
Пример для Slim Framework:
$app = new \Slim\App;
$app->get('/download', function ($req, $res, $args) {
$zipFile = new \PhpZip\ZipFile();
$zipFile['file.txt'] = 'content';
return $zipFile->outputAsResponse($res, 'file.zip');
});
$app->run();
ZipFile::rewrite - сохраняет изменения и заново открывает изменившийся архив.
$zipFile->rewrite();
ZipFile::close - закрывает ZIP-архив.
$zipFile->close();
Установите зависимости для разработки.
composer install --dev
Запустите тесты:
vendor/bin/phpunit -v -c phpunit.xml
История изменений на странице релизов.
Обновите мажорную версию в файле composer.json
до ^3.0
.
{
"require": {
"nelexa/zip": "^3.0"
}
}
Затем установите обновления с помощью Composer
:
composer update nelexa/zip
Обновите ваш код для работы с новой версией:
ZipOutputFile
объединён с ZipFile
и удалён.
new \PhpZip\ZipOutputFile()
на new \PhpZip\ZipFile()
\PhpZip\ZipFile::openFromFile($filename);
на (new \PhpZip\ZipFile())->openFile($filename);
\PhpZip\ZipOutputFile::openFromFile($filename);
на (new \PhpZip\ZipFile())->openFile($filename);
\PhpZip\ZipFile::openFromString($contents);
на (new \PhpZip\ZipFile())->openFromString($contents);
\PhpZip\ZipFile::openFromStream($stream);
на (new \PhpZip\ZipFile())->openFromStream($stream);
\PhpZip\ZipOutputFile::create()
на new \PhpZip\ZipFile()
\PhpZip\ZipOutputFile::openFromZipFile($zipFile)
на (new \PhpZip\ZipFile())->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