README

除了合并PRs之外，我已经很久没有更新这个包了。我最后一次使用这个包是在PHP5时。由于我不再使用PHP（我们有时都必须前进），也没有时间妥善照顾它，所以我存档了这个仓库。

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

Zipper

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

安装

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

• 对于Laravel 5: "chumper/zipper": "1.0.x"
• 对于Laravel 4: "chumper/zipper": "0.5.x"

1. 运行 composer update

2. 转到 app/config/app.php

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

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

简单示例

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

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

另一个示例

$zipper = new \Chumper\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内部使用'/'作为文件/文件夹的分隔符。因此，Windows用户不应使用''作为whitelist/blacklist模式，因为它将不会匹配任何内容

列入白名单

Zipper::WHITELIST

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

这将把test.zip提取到public文件夹，但仅提取以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文件夹，但仅提取名称完全匹配的文件/文件夹。

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

注意：当zip的结构如下，并且只提供test.bat作为whitelist/blacklist参数时，不设置Zipper::EXACT_MATCH提取文件/文件夹，则会提取所有以给定字符串开头的文件和文件夹

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。