README

这是一个从 chumper/Zipper 分支出来的支持 Laravel 7 的包。因此，所有代码、概念和设计权利都属于 chumper。安装 composer require epicsagas/zipper:dev-master

注意

除了合并 PR 外，我已经很长时间没有更新这个包了。我最后一次使用这个包是在 PHP5 的时候。我存档了这个仓库，因为我不再使用 PHP（我们有时都必须前进），也没有时间来妥善照顾它了。

请随意阅读代码，将其分支出来，或以任何你想要的方式使用它。

更新 2020 年 2 月 25 日

我已经合并了一个包含安全修复的 PR，以减轻 zip 目录遍历攻击。
此包仍然存档，应该用另一个包替换。
然而，只要还有安全修复，我认为我有责任在需要时更新这个包。

Zipper

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

安装

1. 将此包添加到 composer.json 中所需包的列表

• 对于 Laravel 7: "chumper/zipper": "1.0.x"
• 对于 Laravel 4: "chumper/zipper": "0.5.x"

1. 运行 composer update

2. 转到 app/config/app.php

• 添加到 providers Epicsagas\Zipper\ZipperServiceProvider::class
• 添加到 aliases 'Zipper' => Epicsagas\Zipper\Zipper::class

现在你可以使用 Zipper 别名访问 Zipper。

简单示例

$files = glob('public/files/*');
Zipper::make('public/test.zip')->add($files)->close();

• 默认情况下，该包将在项目路由文件夹中创建 test.zip，但在上面的示例中，我们将其更改为了 project_route/public/。

另一个示例

$zipper = new \Epicsagas\Zipper\Zipper;

$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('',array('mySuperPackage/composer.json'),Zipper::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 中的文件或从 zip 中删除文件，例如

Zipper::make('test.zip')->folder('test')->add('composer.json');
Zipper::make('test.zip')->folder('test')->remove('composer.json');

listFiles($regexFilter = null)

列出存档中所有文件（如果没有提供过滤器模式）。使用 $regexFilter 参数过滤文件。查看模式语法了解正则表达式语法。

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

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

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

home()

重置文件夹指针。

zip($fileName)

使用 ZipRepository 处理文件。

getFileContent($filePath)

获取 zip 中文件的內容。这将返回内容或 false。

getStatus()

以整数形式获取 zip 的打开状态。

close()

关闭 zip 并写入所有更改。

extractTo($path)

将 zip 存档的内容提取到指定的位置，例如

Zipper::make('test.zip')->folder('test')->extractTo('foo');

这将进入 zip 文件中的 test 文件夹，并将该文件夹的内容仅提取到 foo 文件夹中，这与使用 Zipper::WHITELIST 相同。

此命令非常适合仅获取 zip 文件的一部分，您还可以传递第二个和第三个参数来指定单个文件或文件数组，这些文件将被

注意：Php ZipArchive 在内部使用 '/' 作为 zip 中的文件/文件夹的分隔符。因此，Windows 用户不应使用 '' 设置白名单/黑名单模式，因为这不会匹配任何内容

白名单

Zipper::WHITELIST

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

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

或黑名单

Zipper::BLACKLIST 这将把 test.zip 提取到 public 文件夹，但 zip 内部以 vendor 前缀开始的文件/文件夹将不会提取。

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

Zipper::EXACT_MATCH

Zipper::make('test.zip')
    ->folder('vendor')
    ->extractTo('public', array('composer', 'bin/phpunit'), Zipper::WHITELIST | Zipper::EXACT_MATCH);

这将把 test.zip 提取到 public 文件夹，但 仅 提取文件/文件夹 名称精确匹配 的。因此，这将

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

注意：当 zip 的结构如下所示且仅提供 test.bat 作为白名单/黑名单参数时，从 zip 中提取文件/文件夹而未设置 Zipper::EXACT_MATCH，则 extractTo 会提取所有这些文件和文件夹，因为它们都以给定的字符串开始

test.zip
 |- test.bat
 |- test.bat.~
 |- test.bat.dir/
    |- fileInSubFolder.log

extractMatchingRegex($path, $regex)

将匹配正则表达式的 zip 存档内容提取到指定的位置。查看模式语法了解正则表达式语法。

示例：从 src 文件夹及其子文件夹中提取所有以 .php 结尾的文件。

Zipper::make('test.zip')->folder('src')->extractMatchingRegex($path, '/\.php$/i'); 

示例：从 src 文件夹及其子文件夹中提取所有 除了 以 test.php 结尾的文件。

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

开发

可能添加其他压缩函数（如 rar、phar 或 bzip2 等）是一个好主意。一切都已经设置好了，如果您想进一步开发，只需分叉并开发即可。

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