README

除了合并PR之外，我已经很久没有更新这个软件包了。我最后一次使用这个软件包是在PHP5时。由于我不再使用PHP（我们有时都必须前进），我没有时间再好好照顾它了，所以我存档了这个仓库。

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

更新时间：2020年2月25日

我已经合并了一个包含安全修复的PR，以减轻zip目录遍历攻击。
此软件包仍然是存档状态，应替换为其他软件包。
然而，只要还有安全修复，我认为我有责任根据需求更新此软件包。

拉链

这是一个简单的包装，围绕 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 别名访问拉链了。

简单示例

$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存档；如果文件不存在，它将创建一个新的。它将返回拉链实例，以便您可以轻松地链接。

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文件夹中，但仅提取名称完全匹配的文件/文件夹。

• 提取名为composer的文件或文件夹，该文件或文件夹位于zip文件中的vendor文件夹内，提取到public，结果为public/composer。
• 提取名为bin/phpunit的文件或文件夹，该文件或文件夹位于zip文件中的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。