README

这是一个非常初级的包，旨在成为 chumper/zipper 包的后继者。它最初作为分支开始，因为我们需要与 Laravel 6.0 兼容。我将努力使其与 Laravel 6 及以上版本兼容。

Madzipper

这是对 ZipArchive 方法的简单封装，包含一些方便的功能。

安装

1. 对于 Laravel 6 或 7： "madnest/madzipper": "1.0.x" 运行 composer require madnest/madzipper

2. 可选地进入 app/config/app.php

• 添加到提供者 Madnest\Madzipper\MadzipperServiceProvider::class
• 添加到别名 'Madzipper' => Madnest\Madzipper\Madzipper::class

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

简单示例

$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 参数过滤文件。有关正则表达式语法的更多信息，请参阅 Pattern Syntax。

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

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

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

home()

重置文件夹指针。

zip($fileName)

使用 ZipRepository 处理文件。

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用户不应使用''作为whitelist/blacklist模式，因为它不会匹配任何内容

列入白名单

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的文件或文件夹（位于zip中的vendor文件夹内），并将其解压缩到public中，结果为public/composer
• 提取名为bin/phpunit的文件或文件夹（位于zip中的vendor/bin/phpunit文件夹内），并将其解压缩到public中，结果为public/bin/phpunit

注意：在没有设置Madzipper::EXACT_MATCH的情况下从zip中提取文件/文件夹，当zip的结构如下，并且仅提供test.bat作为whitelist/blacklist参数时，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');

开发

可能添加其他压缩功能，如rar、phar或bzip2等，是个不错的想法。一切都已经设置好了，如果您想进一步开发，只需进行fork即可。

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