README

我已很久没有更新这个包了，除了合并PR。我最后一次使用这个包是在PHP5时代。由于我不再使用PHP（我们有时都必须前进），我没有时间再好好照顾它了，所以我将其存档。

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

更新 2020年2月25日

我合并了一个包含安全修复的PR，以减轻zip目录遍历攻击。
此包仍然存档，应与其他包替换。
但是，只要安全修复仍在进行中，我认为在需要时更新此包是我的基本义务。

Zipper

这是一个简单的包装，包含一些实用的函数，围绕ZipArchive方法。

安装

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

对于Laravel 5: "chumper/zipper": "1.0.x"
~~对于Laravel 4: "chumper/zipper": "0.5.x"~~

运行 composer update
转到 app/config/app.php

添加到提供者 Chumper\Zipper\ZipperServiceProvider::class
添加到别名 'Zipper' => Chumper\Zipper\Zipper::class

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

简单示例

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

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

另一个示例

$zipper = new \Chumper\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 的文件或文件夹，位于名为 vendor 的文件夹中，提取到 public，结果为 public/composer
提取zip中名为 bin/phpunit 的文件或文件夹，位于 vendor/bin/phpunit 文件夹中，提取到 public，结果为 public/bin/phpunit

注意：当zip的结构与以下类似，并且只提供了 test.bat 作为白名单/黑名单参数时，从zip中提取文件/文件夹而不设置 Zipper::EXACT_MATCH

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等可能是个好主意...一切准备工作都已就绪，如果您想进一步开发，只需fork并继续开发。

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

chumper / zipper

维护者

详细信息