README

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

请随意阅读代码、分叉它或以任何您希望的方式使用它。

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

注意：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中名为vendor文件夹内名为composer的文件或文件夹提取到public，结果为public/composer
• 将zip中vendor/bin/phpunit文件夹内名为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上提交问题。