README

这是一个非常早期的包，旨在成为 chumper/zipper 包的后继者。它最初作为分支开始，因为我们需要 Laravel 6.0 兼容性。我将尝试使其与 Laravel 5.8 及更高版本兼容。

Madzipper

这是一个围绕 ZipArchive 方法的简单包装，包含一些便捷的功能。

安装

1. 对于 Laravel 5.8 和 6： "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() 以将压缩文件写入磁盘。

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

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

函数

make($pathToFile)

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

add($files/folder)

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

addString($filename, $content)

通过指定名称和内容作为字符串向压缩文件中添加单个文件。

remove($file/s)

从压缩文件中移除单个文件或文件数组。

folder($folder)

指定一个文件夹以 '添加文件到' 或 '从压缩文件中移除文件'，例如

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在内部使用'/'作为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的文件或文件夹从zip中的vendor文件夹解压到public文件夹，结果为public/composer
• 将名为bin/phpunit的文件或文件夹从zip中的vendor/bin/phpunit文件夹解压到public文件夹，结果为public/bin/phpunit

注意：在未设置Madzipper::EXACT_MATCH的情况下从zip文件中提取文件/文件夹。当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文件夹及其子文件夹中提取所有except以test.php结尾的文件。

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

开发

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

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