README

除了合并PR之外，我已经很久没有更新这个包了。我最后一次使用这个包是在PHP5的时候。我归档了这个仓库，因为我不再从事PHP开发（我们有时都必须向前看）并且没有时间再好好照顾它了。

请随意阅读代码，分叉它或以任何你想要的方式使用它。

更新于2020年2月25日

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

Zipper

这是一个简单的ZipArchive方法的包装，包含一些便捷的函数。

安装

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

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

1. 运行 composer update

2. 转到 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中删除文件”，例如

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'模式结尾或不以'.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用户不应使用''设置whitelist/blacklist模式，因为这不会匹配任何内容

列入白名单

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

**注意**：在没有设置Zipper::EXACT_MATCH的情况下从zip提取文件/文件夹，当zip的结构与以下类似，并且只提供test.bat作为whitelist/blacklist参数时，则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等是个好主意。一切都已经设置好了，如果您想进一步开发，只需fork并继续开发即可。

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