adrian1207/zipper

这是一个针对 ZipArchive 方法的简洁辅助工具,具有实用函数

1.0.1 2020-12-18 15:17 UTC

This package is not auto-updated.

Last update: 2024-09-22 06:57:29 UTC


README

这是 Chumper/Zipper(Chumper/Zipper)的 laravel 6.0+ 兼容性更新。所有功劳归功于 Chumper/Zipper

Zipper

这是一个围绕 ZipArchive 方法简单包装,并包含一些实用函数的工具。

安装

  1. 运行 composer require imritesh/zipper

  2. 转到 app/config/app.php

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

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

简单示例

$files = glob('public/files/*');
Zipper::make('public/test.zip')->add($files)->close();
  • 默认情况下,该包将在项目路由文件夹中创建 test.zip,但在上面的示例中,我们将其更改为 project_route/public/

另一个示例

$zipper = new \imritesh\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 文件写入磁盘。

您可以将大多数函数轻松链接起来,除了 getFileContentgetStatuscloseextractTo,它们必须链在最后。

我编写这个小包的主要原因是因为 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 在内部使用 '/' 作为 zip 文件中文件/文件夹的目录分隔符。因此,Windows 用户不应使用 '' 设置白名单/黑名单模式,因为它不会匹配任何内容

白名单

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'); 

如果您需要其他功能或遇到错误,请将问题提交到GitHub。