README

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

请随意阅读代码，克隆它或以任何你想要的方式使用它。

Zipper

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

安装

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

• 对于Laravel 7: "plehanov/zipper": "3.1.x"
• 对于Laravel 6: "plehanov/zipper": "3.x.x"
• 对于Laravel 5: "plehanov/zipper": "1.0.x"
• 对于Laravel 4: "plehanov/zipper": "0.5.x"

1. 运行composer update

2. 转到app/config/app.php

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

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

简单示例

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

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

另一个示例

$zipper = new \Plehanov\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文件的一部分，你也可以传递第二个和第三个参数来指定一个或多个文件

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

被白名单列出

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

• 例如，将zip中名为vendor/composer文件夹内的文件或文件夹composer提取到public文件夹，结果为public/composer
• 将zip中名为vendor/bin/phpunit文件夹内的文件或文件夹bin/phpunit提取到public文件夹，结果为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文件夹及其子文件夹中提取所有except以test.php结尾的文件。

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

开发

也许添加其他压缩函数，如rar、phar或bzip2等是个好主意。一切都已经设置好了，如果你想进一步开发，只需要fork并继续开发。

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