README

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

安装

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

• 对于Laravel 6: "dariusiii/zipper": "2.0.x"
  • 对于Laravel 5: "dariusiii/zipper": "1.0.x"
  • 对于Laravel 4: "dariusiii/zipper": "0.5.x"

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'模式结束/不结束的文件/文件夹（不区分大小写）。这将返回子文件夹及其子文件夹中的匹配项。

$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文件的一部分，您还可以传递第二个和第三个参数来指定单个文件或文件数组。

注意：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 的文件或文件夹从 zip 中的 vendor 文件夹解压到 public，结果为 public/composer
• 将名为 bin/phpunit 的文件或文件夹从 vendor/bin/phpunit 文件夹解压到 public，结果为 public/bin/phpunit

注意：当 zip 的结构如下，并且只提供 test.bat 作为白名单/黑名单参数时，如果不设置 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'); 

开发

可能添加其他压缩函数，如 rar、phar 或 bzip2 等，是个好主意。一切都已经设置好了，如果你想进一步开发，只需分叉并开发即可。

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