README

这是 Chumper/Zipper 的兼容性更新，针对 laravel 6.0+。所有荣誉归于 Chumper/Zipper。

Zipper

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

安装

1. 运行 composer require imritesh/zipper

2. 转到 app/config/app.php

• 添加提供者 imritesh\Zipper\ZipperServiceProvider::class
• 添加别名 'Zipper' => imritesh\Zipper\Zipper::class

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

简单示例

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

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

另一个示例

$zipper = new \imritesh\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文件夹，但只有完全匹配名称的文件/文件夹会被解压。

• 解压名为composer的文件或文件夹到名为vendor的文件夹中，结果为public/composer
• 解压名为bin/phpunit的文件或文件夹到vendor/bin/phpunit文件夹中，结果为public/bin/phpunit

注意：当zip的结构如下所示且只给出test.bat作为whitelist/blacklist参数时，从zip中提取文件/文件夹而不设置Zipper::EXACT_MATCH。那么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'); 

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