README

这是一个基于 madnest/madzipper 的分支，以保持与 Laravel 6 的兼容性，直到 Laravel 9 发布。它是一个中间版本，支持 PHP 8.0 和 Laravel 6。一旦 Laravel 9 发布并添加对其的支持，我们很可能将继续使用 madnest/madzipper。

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

Madzipper

这是一个简单的包装类，封装了 ZipArchive 方法并提供了一些实用的函数。

安装

1. 通过运行 composer require madnest/madzipper 可以安装 "madnest/madzipper": "1.0.x"

2. 当与 Laravel 8、7 或 6 一起使用时，可选地前往 app/config/app.php

• 将以下内容添加到 providers 中 Madnest\Madzipper\MadzipperServiceProvider::class
• 将以下内容添加到 aliases 中 'Madzipper' => Madnest\Madzipper\Madzipper::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 参数来过滤文件。有关正则表达式语法，请参阅 Pattern Syntax。

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

示例：返回所有以 '.log' 结尾或不以 '.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用户不应使用''设置白名单/黑名单模式，因为这不会匹配任何内容

白名单

Madzipper::WHITELIST

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

这将把test.zip提取到public文件夹，但只有zip内部以vendor前缀开始的文件/文件夹才会被提取。

或黑名单

Madzipper::BLACKLIST 这将把test.zip提取到public文件夹，除了zip内部以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文件夹，但只有exact matching names的文件/文件夹。

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

注意：当zip具有以下类似结构，并且只给出test.bat作为白名单/黑名单参数时，如果没有设置Madzipper::EXACT_MATCH，则提取文件或文件夹，以下所有文件和文件夹都会被提取，因为它们都以给定的字符串开头

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文件夹及其子文件夹中提取所有except以test.php结尾的文件。

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

测试

composer test

变更日志

有关最近更改的更多信息，请参阅变更日志。

开发

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

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