README

这是对 https://github.com/Chumper/Zipper 的分支，以使其适用于当前的 Laravel 版本 6.0，并保持可维护性。

Zipper

这是一个简单的包装器，围绕 ZipArchive 方法提供一些便捷函数。

安装

将此包添加到 composer.json 文件中所需包的列表中

对于 Laravel 5: "chumper/zipper": "1.0.x"

运行 composer update
转到 app/config/app.php

在提供者中添加 Wrklst\Zipper\ZipperServiceProvider::class
在别名中添加 'Zipper' => Wrklst\Zipper\Zipper::class

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

简单示例

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

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

另一个示例

$zipper = new \Wrklst\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' 结尾/不以 '.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 内部使用 '/' 作为文件/文件夹的分隔符。因此，Windows 用户不应使用 '' 作为白名单/黑名单模式，因为它不会匹配任何内容

白名单

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

注意：在未设置 Zipper::EXACT_MATCH 的情况下从 zip 中提取文件/文件夹。当 zip 的结构如下所示，并且只提供 test.bat 作为白名单/黑名单参数时，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上提交问题。

wrklst / zipper

维护者

详细信息