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 参数来过滤文件。有关正则表达式语法的说明，请参阅 模式语法。

NB: 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文件的一部分，您还可以传递第2个和第3个参数来指定单个文件或文件数组。

注意：PHP ZipArchive内部使用'/'作为文件/文件夹的目录分隔符。因此，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文件夹，但只提取文件/文件夹的**精确名称**。所以这将

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

注意：当zip的结构如下所示，并且只提供test.bat作为whitelist/blacklist参数时，如果没有设置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等是个好主意。一切都已经设置好了，如果您想继续开发，只需fork并进一步开发。

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