README

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

安装

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

composer require wrklst/madzipper

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

• 将以下内容添加到提供者 WrkLst\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 \WrkLst\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 文件的一部分，您还可以传递第二个和第三个参数以指定单个文件或文件数组，这些文件将被

注意：PHP ZipArchive 内部使用 '/' 作为文件/文件夹的分隔符。因此，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 中，结果为 public/composer
• 提取名为 bin/phpunit 的文件或文件夹，位于 vendor/bin/phpunit 文件夹中，并将其提取到 public 中，结果为 public/bin/phpunit

注意：当 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');

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近有哪些更改。

开发

可能添加其他压缩功能（如 rar、phar 或 bzip2 等）是个好主意。一切都已设置好，如果您想继续开发，只需进行分支即可。

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

致谢

@Chumper