README

这是一个简单的包装器，围绕ZipArchive方法提供一些实用函数。

安装

1. 通过运行以下命令安装 madnest/madzipper

composer require madnest/madzipper

1. 当与Laravel一起使用时，可选地前往 app/config/app.php

• 添加到提供者 Madnest\Madzipper\MadzipperServiceProvider::class

现在您可以使用 Madzipper 别名访问Madzipper。

版本

使用Madzipper外观的简单Laravel示例

$files = glob('public/files/*');
Madzipper::make('public/test.zip')->add($files)->close();

• 默认情况下，该包将在项目路由文件夹中创建 test.zip，但在上面的示例中，我们将其更改为 project_route/public/。

另一个示例

$zipper = new \Madnest\Madzipper\Madzipper;

$zipper->make('test.zip')->folder('test')->add('composer.json');
$zipper->zip('test.zip')->folder('test')->add('composer.json','test');

$zipper->remove('composer.lock');

$zipper->folder('mySuperPackage')->add(
    array(
        'vendor',
        'composer.json'
    ),
);

$zipper->getFileContent('mySuperPackage/composer.json');

$zipper->make('test.zip')->extractTo('', ['mySuperPackage/composer.json'], Madzipper::WHITELIST);

$zipper->close();

注意：请记住在最后调用 ->close() 将zip文件写入磁盘。

您可以将大多数函数轻松串联，除了 getFileContent、getStatus、close 和 extractTo，这些必须在链的末尾。

我编写这个小包的主要原因是因为 extractTo 方法，因为它允许您在解压缩zip时非常灵活。因此，例如，您可以实现一个更新方法，它只会覆盖已更改的文件。

函数

make($pathToFile)

创建或打开zip存档；如果文件不存在，将创建一个新的文件。它将返回Zipper实例，以便您可以轻松串联。

add($files/folder)

您可以添加文件数组，或者一个文件夹，然后该文件夹中的所有文件都将被添加，所以从第一个示例中，我们也可以这样做 $files = 'public/files/';。

addString($filename, $content)

通过指定名称和内容字符串将单个文件添加到zip中。

remove($file/s)

从zip中删除单个文件或文件数组。

folder($folder)

指定要“添加文件到”或“从zip中删除文件”的文件夹，例如

Madzipper::make('test.zip')->folder('test')->add('composer.json');
Madzipper::make('test.zip')->folder('test')->remove('composer.json');

listFiles($regexFilter = null)

列出存档中的所有文件（如果没有提供过滤器模式）。使用 $regexFilter 参数来过滤文件。有关正则表达式语法，请参阅 模式语法。

注意：listFiles 忽略了使用 folder 函数设置的文件夹

示例：返回以'.log'模式结尾/不结尾的所有文件/文件夹（不区分大小写）。这将返回子文件夹及其子文件夹中的匹配项

$logFiles = Madzipper::make('test.zip')->listFiles('/\.log$/i');
$notLogFiles = Madzipper::make('test.zip')->listFiles('/^(?!.*\.log).*$/i');

home()

重置文件夹指针。

zip($fileName)

使用文件处理。

getFileContent($filePath)

获取zip中文件的内容。这将返回内容或false。

getStatus()

获取zip打开状态的整数值。

close()

关闭zip并写入所有更改。

extractTo($path)

将zip存档的内容提取到指定的位置，例如

Madzipper::make('test.zip')->folder('test')->extractTo('foo');

这将进入zip文件中的 test 文件夹，并将该文件夹的内容仅提取到文件夹 foo 中，这等于使用 Madzipper::WHITELIST。

此命令非常适合仅获取zip文件的一部分，您还可以传递第2个和第3个参数来指定单个文件或文件数组。

注意：Php ZipArchive 内部使用 '/' 作为 zip 文件夹的目录分隔符。因此，Windows 用户不应使用 '' 作为白名单/黑名单模式，因为它不会匹配任何内容。

白名单

Madzipper::WHITELIST

Madzipper::make('test.zip')->extractTo('public', array('vendor'), Madzipper::WHITELIST);

这将把 test.zip 提取到 public 文件夹，但 仅 提取以 vendor 前缀开始的文件/文件夹。

或黑名单

Madzipper::BLACKLIST 这将把 test.zip 提取到 public 文件夹，但 不包括 以 vendor 前缀开始的文件/文件夹。

Madzipper::make('test.zip')->extractTo('public', array('vendor'), Madzipper::BLACKLIST);

Madzipper::EXACT_MATCH

Madzipper::make('test.zip')
    ->folder('vendor')
    ->extractTo('public', array('composer', 'bin/phpunit'), Madzipper::WHITELIST | Madzipper::EXACT_MATCH);

这将把 test.zip 提取到 public 文件夹，但 仅 提取名称完全匹配的文件/文件夹。因此，这将

• 提取名为 composer 的文件或文件夹到名为 vendor 的文件夹中，结果为 public/composer
• 提取名为 bin/phpunit 的文件或文件夹到 vendor/bin/phpunit 文件夹中，结果为 public/bin/phpunit

注意：在 zip 文件具有以下类似结构时，不设置 Madzipper::EXACT_MATCH 提取文件/文件夹，并且只提供了 test.bat 作为白名单/黑名单参数，则 extractTo 会提取所有这些文件和文件夹，因为它们都以给定的字符串开始。

test.zip
 |- test.bat
 |- test.bat.~
 |- test.bat.dir/
    |- fileInSubFolder.log

extractMatchingRegex($path, $regex)

将匹配正则表达式的 zip 归档内容提取到指定位置。请参阅 模式语法 了解正则表达式的语法。

示例：从 src 文件夹及其子文件夹中提取所有以 .php 结尾的文件。

Madzipper::make('test.zip')->folder('src')->extractMatchingRegex($path, '/\.php$/i');

示例：从 src 文件夹及其子文件夹中提取所有 除了 以 test.php 结尾的文件。

Madzipper::make('test.zip')->folder('src')->extractMatchingRegex($path, '/^(?!.*test\.php).*$/i');

测试

composer test

变更日志

请参阅 变更日志 了解最近有哪些变化。

开发

也许添加其他压缩功能，如 rar、phar 或 bzip2 等，是个好主意。一切准备就绪，如果你想进一步开发，只需 fork 并继续开发。

如果你需要其他功能或遇到错误，请在 github 上提交 issue。

致谢

非常感谢 @Chumper 创建原始包 Chumper/Zipper