README

我长时间没有更新这个包，除了合并PRs。我上次使用这个包是在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文件的一部分，你也可以传递第二个和第三个参数来指定单个或多个将被打包的文件

注意：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

注意：当zip的结构如下，并且仅给出test.bat作为whitelist/blacklist参数时，如果不设置Zipper::EXACT_MATCH来从zip中提取文件/文件夹，则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上提交问题。