README

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

为了保持与 Laravel 最新版本的同步。

安装

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

• 对于 Laravel 10: composer require ice6/zipper 10.0.0

1. 运行 composer update

2. 转到 app/config/app.php

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

现在您可以通过 Zipper 别名访问 Zipper。

简单示例

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

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

另一个示例

$zipper = new \DariusIII\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内部使用'/'作为zip文件中文件/文件夹的目录分隔符。因此，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/composer
• 提取名为bin/phpunit的文件或文件夹到名为vendor/bin/phpunit的文件夹中，结果为public/bin/phpunit

注意：当zip的结构如下所示，并且只提供了test.bat作为白名单/黑名单参数时，提取文件/文件夹而不设置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文件夹及其子文件夹中提取所有不以test.php结尾的文件。

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

开发

可能添加其他压缩函数如rar、phar或bzip2等是个好主意。一切准备就绪，如果需要，请克隆并进一步开发。

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