README

备注

除了合并 PR 之外，我已经很久没有更新这个包了。我最后一次使用这个包是在 PHP5 上。我归档了这个仓库，因为我不再使用 PHP（我们有时都必须前进），而且再也没有时间好好照顾它了。

请随意阅读代码，将其分支或以任何你想要的方式使用。

Zipper

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

安装

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

• 对于 Laravel 7: "sammyjo20/zipper": "^3.0"
• 对于 Laravel 6: "sammyjo20/zipper": "^2.0"
• 对于 Laravel 5: "chumper/zipper": "1.0.x"
• 对于 Laravel 4: "chumper/zipper": "0.5.x"

1. 运行 composer update

2. 转到 app/config/app.php

• 添加到 providers Sammyjo20\Zipper\ZipperServiceProvider::class
• 添加到 aliases 'Zipper' => Sammyjo20\Zipper\Zipper::class

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

简单示例

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

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

另一个示例

$zipper = new \Sammyjo20\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文件的一部分，您还可以传递第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 文件夹中，但 仅 提取文件/文件夹 精确匹配名称。因此，这将

• 将zip中名为 composer 的文件或文件夹提取到名为 vendor 的文件夹中，结果为 public/composer
• 将zip中名为 bin/phpunit 的文件或文件夹提取到 vendor/bin/phpunit 文件夹中，结果为 public/bin/phpunit

注意：当zip的结构如下时，并且只提供了 test.bat 作为whitelist/blacklist参数，那么在不设置Zipper::EXACT_MATCH的情况下从zip中提取文件/文件夹，则会提取所有那些文件和文件夹，因为它们都以给定的字符串开始

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 上提交问题。