README

这是一个围绕 ZipArchive 方法的简单包装，包含一些实用的功能。

要求

PHP: 7.3+
Laravel: 5+

安装

1. flttgo/easy-zipper 可以通过以下命令安装：

composer require flttgo/easy-zipper

1. 当与 easy 一起使用时，可选地转到 app/config/app.php

• 添加到提供者 Zipper\EasyZipperServiceProvider::class

现在您可以使用 EasyZipper 别名访问 EasyZipper。

使用 EasyZipper 面板的一个简单示例

use Zipper\EasyZipper;
$files = glob('public/files/*');
EasyZipper::make('public/test.zip')->add($files)->close();

• 默认情况下，该包将在项目路由文件夹中创建 test.zip，但在上面的示例中，我们将其更改为 project_route/public/。

另一个示例

$zipper = new Zipper\EasyZipper;

$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('', ['mySuperPackage/composer.json'], EasyZipper::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 中删除文件' 的文件夹，例如

EasyZipper::make('test.zip')->folder('test')->add('composer.json');
EasyZipper::make('test.zip')->folder('test')->remove('composer.json');

listFiles($regexFilter = null)

列出存档中的所有文件（如果没有提供过滤器模式）。使用 $regexFilter 参数来过滤文件。有关正则表达式语法，请参阅模式语法

注意：listFiles 忽略使用 folder 函数设置的文件夹

示例：返回所有以 '.log' 模式结束/不结束的文件/文件夹（不区分大小写）。这将返回子文件夹及其子文件夹中的匹配项

$logFiles = EasyZipper::make('test.zip')->listFiles('/\.log$/i');
$notLogFiles = EasyZipper::make('test.zip')->listFiles('/^(?!.*\.log).*$/i');

home()

重置文件夹指针。

zip($fileName)

使用 ZipRepository 进行文件处理。

getFileContent($filePath)

获取 zip 中的文件内容。这将返回内容或 false。

getStatus()

获取 zip 的打开状态为整数。

close()

关闭 zip 并写入所有更改。

extractTo($path)

将 zip 存档的内容提取到指定的位置，例如

use Zipper\EasyZipper;
EasyZipper::make('test.zip')->folder('test')->extractTo('foo');

这将进入 zip 文件中的 test 文件夹，并将该文件夹的内容仅提取到文件夹 foo 中，这等于使用 EasyZipper::WHITELIST。

此命令非常方便，仅获取 zip 文件的一部分，您还可以传递第二个和第三个参数来指定单个文件或文件数组，这些文件将

注意：Php ZipArchive 在内部使用 '/' 作为文件/文件夹在 zip 中的目录分隔符。因此，Windows 用户不应使用 '' 设置白名单/黑名单模式，因为它不会匹配任何内容

白名单

EasyZipper::WHITELIST

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

这将把 test.zip 解压到 public 文件夹中，但只有以 vendor 前缀开始的文件/文件夹会被解压。

或列入黑名单

EasyZipper::BLACKLIST 将把 test.zip 解压到 public 文件夹，除了以 vendor 前缀开始的文件/文件夹不会解压。

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

EasyZipper::EXACT_MATCH

EasyZipper::make('test.zip')
    ->folder('vendor')
    ->extractTo('public', array('composer', 'bin/phpunit'), EasyZipper::WHITELIST | EasyZipper::EXACT_MATCH);

这将把 test.zip 解压到 public 文件夹，但只有 完全匹配名称 的文件/文件夹。所以这会

• 将名为 composer 的文件或文件夹从名为 vendor 的文件夹中提取到 public 中，结果为 public/composer
• 将名为 bin/phpunit 的文件或文件夹从 vendor/bin/phpunit 文件夹中提取到 public 中，结果为 public/bin/phpunit

注意：在未设置 EasyZipper::EXACT_MATCH 时从 zip 文件中提取文件/文件夹。当 zip 文件的目录结构与以下类似，并且只将 test.bat 作为白名单/黑名单参数提供时，extractTo 会提取所有这些文件和文件夹，因为它们都以给定的字符串开头。

test.zip
 |- test.bat
 |- test.bat.~
 |- test.bat.dir/
    |- fileInSubFolder.log

extractMatchingRegex($path, $regex)

将匹配正则表达式的 zip 存档内容提取到指定的位置。有关正则表达式语法，请参阅 模式语法。

示例：从 src 文件夹及其子文件夹中提取所有以 .php 结尾的文件。

EasyZipper::make('test.zip')->folder('src')->extractMatchingRegex($path, '/\.php$/i');

示例：从 src 文件夹及其子文件夹中提取所有 除了 以 test.php 结尾的文件。

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

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

开发

可能添加其他压缩功能（如 rar、phar 或 bzip2 等）是个好主意。一切已设置妥当，如果您想进一步开发，请克隆并开发。

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

鸣谢

@Chumper