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'模式结尾/不结尾的文件/文件夹（不区分大小写）。这将返回子文件夹及其子文件夹中的匹配项

$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在内部使用'/'作为zip文件中文件/文件夹的目录分隔符。因此，Windows用户不应使用''作为whitelist/blacklist模式，因为它不会匹配任何内容

白名单

Zipper::WHITELIST

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

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

或者黑名单

Zipper::BLACKLIST 这将把test.zip提取到public文件夹中，但不会提取以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文件中vendor文件夹内的名为composer的文件或文件夹提取到public中，结果为public/composer
• 将位于zip文件中vendor/bin/phpunit文件夹内的名为bin/phpunit的文件或文件夹提取到public中，结果为public/bin/phpunit

注意：当zip的结构如下所示，并且只提供test.bat作为whitelist/blacklist参数时，从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文件夹及其子文件夹中提取所有except以test.php结尾的文件。

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

开发

也许添加其他压缩函数如rar、phar或bzip2等是个不错的主意...一切都已设置好了，如果您想进一步开发，只需fork并继续开发。

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