README

这是一个处于早期阶段的包，旨在成为chumper/zipper包的继任者。它最初作为分支开始，因为我们需要Laravel 6+的兼容性。

Zipper

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

安装

1. 对于Laravel 5.8和6： "suzonraj/zipper": "1.0" 运行 composer require suzonraj/zipper

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 参数来过滤文件。有关正则表达式语法，请参阅模式语法。

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

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

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

home()

重置文件夹指针。

zip($fileName)

使用文件处理。

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文件夹，但仅从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文件夹，但仅提取exact matching names的文件/文件夹。因此，这将

• 提取zip中名为composer的文件或文件夹，该文件夹位于vendor文件夹中，并将其解压到public中，结果为public/composer
• 提取zip中名为bin/phpunit的文件或文件夹，位于vendor/bin/phpunit文件夹中，并将其解压到public中，结果为public/bin/phpunit

注意：当zip的结构如下，并且仅将test.bat作为whitelist/blacklist参数给出时，如果没有设置Zipper::EXACT_MATCH，则从zip中提取文件/文件夹，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文件夹及其子文件夹中提取所有except以test.php结尾的文件。

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

开发

也许添加其他压缩功能（如rar、phar或bzip2等）是个好主意。一切都已经设置好了，如果您想进一步开发，只需fork并开发即可。

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