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

• 添加到 providers DariusIII\Zipper\ZipperServiceProvider::class
• 添加到 aliases '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 使用内部 '/' 作为文件/文件夹的目录分隔符。因此，Windows 用户不应使用 '' 作为 whitelists/blacklists 模式，因为它不会匹配任何内容

列入白名单

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