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

• 添加到 providers Madnest\Madzipper\MadzipperServiceProvider::class
• 添加到 aliases '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 参数进行文件过滤。请参阅模式语法了解正则表达式的语法。

注意： 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 用户不应使用 '' 设置白名单/黑名单模式，因为这不会匹配任何内容

白名单

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 文件夹中，但 仅 提取 名称完全匹配 的文件/文件夹。因此，这将

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

注意：当 zip 有类似以下的结构，并且仅提供 test.bat 作为白名单/黑名单参数时，从 zip 中提取文件/文件夹而不设置 Madzipper::EXACT_MATCH。如果 zip 结构如下，并且仅提供白名单/黑名单参数 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');

开发

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

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