README

这是一个简单的ZipArchive方法包装器，包含一些方便的函数。

该软件包的原始归功于

Chumper/Zipper

安装

composer require aungmyokyaw/zipper

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

简单示例

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

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

另一个示例

$zipper = new \Amk\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使用内部'/'作为zip中文件/文件夹的分隔符。因此，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 文件夹，但只有 完全匹配名称 的文件/文件夹。因此，这将

• 将名为 composer 的文件或文件夹从 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');