README

我长时间没有更新这个包，除了合并PR。我最后一次使用这个包是在PHP5时代。我归档了这个仓库，因为我不再使用PHP（我们有时不得不前进）并且没有时间好好照顾它了。

请随意阅读代码，fork它或以您希望的方式使用它。

更新 2020年2月25日

我已经合并了一个PR，该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

• 添加到 providers Chumper\Zipper\ZipperServiceProvider::class
• 添加到 aliases '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'模式结束/不结束的文件/文件夹（不区分大小写）。这将返回子文件夹及其子文件夹中的匹配项。

$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上提交一个问题。