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() 以将压缩文件写入磁盘。

您可以将大多数函数轻松串联，除了 getFileContent、getStatus、close 和 extractTo，它们必须位于链的末尾。

我编写这个小包的主要原因是 extractTo 方法，因为它允许在解压缩 zip 时非常灵活。因此，例如，您可以实现一个更新方法，该方法只需覆盖已更改的文件。

函数

make($pathToFile)

创建 或 打开 一个压缩存档；如果文件不存在，它将创建一个新的文件。它将返回 Zipper 实例，以便您可以轻松链式调用。

add($files/folder)

您可以添加文件数组，或文件夹，然后该文件夹中的所有文件都将被添加，因此从第一个示例中，我们可以这样做 $files = 'public/files/';。

addString($filename, $content)

通过指定名称和内容作为字符串，向压缩包中添加单个文件。

remove($file/s)

从压缩包中删除单个文件或文件数组。

folder($folder)

指定一个文件夹，以向其中“添加文件”或从压缩包中“删除文件”，例如

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

注意：Php ZipArchive内部使用'/'作为zip文件中文件/文件夹的分隔符。因此，Windows用户不应使用''作为whitelist/blacklist模式，因为它不会匹配任何内容

whitelisted

Zipper::WHITELIST

Zipper::make('test.zip')->extractTo('public', array('vendor'), Zipper::WHITELIST);

这将把test.zip提取到public文件夹中，但只有zip内部以vendor前缀开始的文件/文件夹会被提取。

或blacklisted

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文件夹中，但只有与名称完全匹配的文件/文件夹会被提取。

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

注意：在未设置Zipper::EXACT_MATCH的情况下从zip中提取文件/文件夹，当zip的结构如下，并且仅提供了test.bat作为whitelist/blacklist参数时，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等，是个好主意。一切准备就绪，如果你想进一步开发，只需fork并开发即可。

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