首页>PHP源码>其他类别
下载

PhpZip是一个用于扩展 ZIP 档案工作的 php 库。

俄语文档

版本和依赖项

版本PHP文档
^4.0（主） ^7.4|^8.0当前的
^3.0 ^5.5|^7.0文档 v3.3

目录

  • 特征
  • 要求
  • 安装
  • 示例
  • 词汇表
  • 文档
    • PhpZipZipFile类的方法概述
    • 创建/打开 ZIP 存档
    • 从存档中读取条目
    • 迭代条目
    • 获取有关条目的信息
    • 将条目添加到存档
    • 从存档中删除条目
    • 处理条目和档案
    • 使用密码
    • 撤消更改
    • 将文件或输出保存到浏览器
    • 关闭存档
  • 运行测试
  • 变更日志
  • 升级
    • 将版本3升级到版本4
    • 将版本2升级到版本3

特征

  • 打开并解压缩 zip 文件。
  • 创建 ZIP 档案。
  • 修改 ZIP 存档。
  • 纯 php （不需要扩展名php-zip和类ZipArchive ）。
  • 它支持将存档保存到文件，将存档输出到浏览器，或者将其作为字符串输出而不保存到文件。
  • 支持档案评论和个人条目评论。
  • 获取有关存档中每个条目的信息。
  • 仅支持以下压缩方法：
    • 没有压缩（存储）。
    • 放气压缩。
    • BZIP2 压缩，扩展名为php-bz2 。
  • 支持ZIP64 （文件大小超过 4 GB 或存档中的条目数超过 65535）。
  • 使用密码

    注意力！

    对于 32 位系统，当前不支持Traditional PKWARE Encryption (ZipCrypto)加密方法。尽可能使用加密方法WinZIP AES Encryption 。

    • 设置密码以读取所有条目或仅某些条目的存档。
    • 更改存档的密码，包括单个条目的密码。
    • 删除所有或单个条目的存档密码。
    • 为存档中的所有条目和单个条目设置密码和/或加密方法。
    • 为不同的条目设置不同的密码和加密方式。
    • 删除全部或部分条目的密码。
    • 支持Traditional PKWARE Encryption (ZipCrypto)和WinZIP AES Encryption加密方式。
    • 为存档中的所有或单个条目设置加密方法。

要求

  • PHP >= 7.4 或PHP >= 8.0（最好是 64 位）。
  • 用于 BZIP2 压缩的可选 php-extension bzip2 。
  • 用于WinZip Aes Encryption支持的可选 php 扩展openssl 。

安装

composer require nelexa/zip

最新稳定版本：

示例

 // create new archive
$ zipFile = new  PhpZip  ZipFile ();
try {
    $ zipFile
        -> addFromString ( ' zip/entry/filename ' , ' Is file content ' ) // add an entry from the string
        -> addFile ( ' /path/to/file ' , ' data/tofile ' ) // add an entry from the file
        -> addDir ( __DIR__ , ' to/path/ ' ) // add files from the directory
        -> saveAsFile ( $ outputFilename ) // save the archive to a file
        -> close (); // close archive
            
    // open archive, extract, add files, set password and output to browser.
    $ zipFile
        -> openFile ( $ outputFilename ) // open archive from file
        -> extractTo ( $ outputDirExtract ) // extract files to the specified directory
        -> deleteFromRegex ( ' ~^.~ ' ) // delete all hidden (Unix) files
        -> addFromString ( ' dir/file.txt ' , ' Test file ' ) // add a new entry from the string
        -> setPassword ( ' password ' ) // set password for all entries
        -> outputAsAttachment ( ' library.jar ' ); // output to the browser without saving to a file
}
catch (  PhpZip  Exception  ZipException $ e ){
    // handle exception
}
finally {
    $ zipFile -> close ();
}

其他示例可以在tests/文件夹中找到

词汇表

Zip 条目- ZIP 存档中的文件或文件夹。存档中的每个条目都有一定的属性，例如：文件名、压缩方法、加密方法、压缩前的文件大小、压缩后的文件大小、CRC32 等。

文档：

PhpZipZipFile类的方法概述

  • ZipFile::__construct - 初始化 ZIP 存档。
  • ZipFile::addAll - 添加数组中的所有条目。
  • ZipFile::addDir - 将文件从指定路径上的目录（不带子目录）添加到存档中。
  • ZipFile::addDirRecursive - 将指定路径及其子目录中的目录中的文件添加到存档中。
  • ZipFile::addEmptyDir - 添加新目录。
  • ZipFile::addFile - 将文件从给定路径添加到 ZIP 存档中。
  • ZipFile::addSplFile - 将SplFileInfo添加到 ZIP 存档中。
  • ZipFile::addFromFinder - 将SymfonyComponentFinderFinder中的文件添加到 ZIP 存档中。
  • ZipFile::addFilesFromIterator - 从目录迭代器添加文件。
  • ZipFile::addFilesFromGlob - 通过 glob 模式从目录添加文件，不带子目录。
  • ZipFile::addFilesFromGlobRecursive - 通过子目录的 glob 模式添加目录中的文件。
  • ZipFile::addFilesFromRegex - 通过 PCRE 模式从目录添加文件，不带子目录。
  • ZipFile::addFilesFromRegexRecursive - 通过 PCRE 模式从目录添加文件和子目录。
  • ZipFile::addFromStream - 将流中的条目添加到 ZIP 存档中。
  • ZipFile::addFromString - 使用文件内容将文件添加到 ZIP 存档中。
  • ZipFile::close - 关闭存档。
  • ZipFile::count - 返回存档中的条目数。
  • ZipFile::deleteFromName - 使用名称删除存档中的条目。
  • ZipFile::deleteFromGlob - 使用 glob 模式删除存档中的条目。
  • ZipFile::deleteFromRegex - 使用 PCRE 模式删除存档中的条目。
  • ZipFile::deleteAll - 删除 ZIP 存档中的所有条目。
  • ZipFile::disableEncryption - 禁用存档中已有的所有条目的加密。
  • ZipFile::disableEncryptionEntry - 禁用由其名称定义的条目的加密。
  • ZipFile::extractTo - 提取存档内容。
  • ZipFile::getArchiveComment - 返回 Zip 存档注释。
  • ZipFile::getEntryComment - 使用条目名称返回条目的注释。
  • ZipFile::getEntryContent - 使用其名称返回条目内容。
  • ZipFile::getListFiles - 返回存档文件列表。
  • ZipFile::hasEntry - 检查存档中是否有条目。
  • ZipFile::isDirectory - 检查存档中的条目是否是目录。
  • ZipFile::matcher - 选择存档中的条目以对其执行操作。
  • ZipFile::openFile - 从文件中打开 zip 存档。
  • ZipFile::openFromString - 从字符串打开 zip 存档。
  • ZipFile::openFromStream - 从流中打开 zip 存档。
  • ZipFile::outputAsAttachment - 将 ZIP 存档输出到浏览器。
  • ZipFile::outputAsPsr7Response - 输出 ZIP 存档作为 PSR-7 响应。
  • ZipFile::outputAsSymfonyResponse - 将 ZIP 存档输出为 Symfony Response。
  • ZipFile::outputAsString - 将 ZIP 存档输出为字符串。
  • ZipFile::rename - 重命名由其名称定义的条目。
  • ZipFile::rewrite - 保存更改并重新打开更改的存档。
  • ZipFile::saveAsFile - 将存档保存到文件中。
  • ZipFile::saveAsStream - 将存档写入流。
  • ZipFile::setArchiveComment - 设置 ZIP 存档的注释。
  • ZipFile::setCompressionLevel - 设置存档中所有文件的压缩级别。
  • ZipFile::setCompressionLevelEntry - 按条目名称设置条目的压缩级别。
  • ZipFile::setCompressionMethodEntry - 按条目名称设置条目的压缩方法。
  • ZipFile::setEntryComment - 设置由其名称定义的条目的注释。
  • ZipFile::setReadPassword - 设置打开存档的密码。
  • ZipFile::setReadPasswordEntry - 设置用于读取由其名称定义的条目的密码。
  • ZipFile::setPassword - 为存档中的所有文件设置新密码。
  • ZipFile::setPasswordEntry - 设置由其名称定义的条目的新密码。
  • ZipFile::unchangeAll - 撤消存档中所做的所有更改。
  • ZipFile::unchangeArchiveComment - 撤消对存档注释的更改。
  • ZipFile::unchangeEntry - 撤消由其名称定义的条目的更改。

创建/打开 ZIP 存档

ZipFile::__construct**

初始化 ZIP 存档

 $ zipFile = new  PhpZip  ZipFile ();
ZipFile::打开文件

从文件打开 zip 存档。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> openFile ( ' file.zip ' );
ZipFile::openFromString

从字符串打开 zip 存档。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> openFromString ( $ stringContents );
ZipFile::openFromStream

从流中打开 zip 存档。 

 $ stream = fopen ( ' file.zip ' , ' rb ' );

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> openFromStream ( $ stream );

从存档中读取条目

ZipFile::计数

返回存档中的条目数。 

 $ zipFile = new  PhpZip  ZipFile ();

$ count = count ( $ zipFile );
// or
$ count = $ zipFile -> count ();
ZipFile::getListFiles

返回存档文件列表。 

 $ zipFile = new  PhpZip  ZipFile ();
$ listFiles = $ zipFile -> getListFiles ();

// example array contents:
// array (
//   0 => 'info.txt',
//   1 => 'path/to/file.jpg',
//   2 => 'another path/',
//   3 => '0',
// )
ZipFile::getEntryContent

使用条目名称返回条目内容。 

 // $entryName = 'path/to/example-entry-name.txt';
$ zipFile = new  PhpZip  ZipFile ();

$ contents = $ zipFile [ $ entryName ];
// or
$ contents = $ zipFile -> getEntryContents ( $ entryName );
ZipFile::hasEntry

检查存档中是否有条目。 

 // $entryName = 'path/to/example-entry-name.txt';
$ zipFile = new  PhpZip  ZipFile ();

$ hasEntry = isset ( $ zipFile [ $ entryName ]);
// or
$ hasEntry = $ zipFile -> hasEntry ( $ entryName );
ZipFile::is目录

检查存档中的条目是否是一个目录。 

 // $entryName = 'path/to/';
$ zipFile = new  PhpZip  ZipFile ();

$ isDirectory = $ zipFile -> isDirectory ( $ entryName );
ZipFile::提取到

提取存档内容。该目录必须存在。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> extractTo ( $ directory );

将一些文件解压到目录中。该目录必须存在。 

 // $toDirectory = '/tmp';
$ extractOnlyFiles = [
    ' filename1 ' , 
    ' filename2 ' , 
    ' dir/dir/dir/ '
];
$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> extractTo ( $ toDirectory , $ extractOnlyFiles );

迭代条目

ZipFile是一个迭代器。可以迭代foreach循环中的所有条目。 

 foreach ( $ zipFile as $ entryName => $ contents ){
    echo " Filename: $ entryName " . PHP_EOL ;
    echo " Contents: $ contents " . PHP_EOL ;
    echo ' ----------------------------- ' . PHP_EOL ;
}

可以通过Iterator进行迭代。 

 $ iterator = new  ArrayIterator ( $ zipFile );
while ( $ iterator -> valid ())
{
    $ entryName = $ iterator -> key ();
    $ contents = $ iterator -> current ();

    echo " Filename: $ entryName " . PHP_EOL ;
    echo " Contents: $ contents " . PHP_EOL ;
    echo ' ----------------------------- ' . PHP_EOL ;

    $ iterator -> next ();
}

获取有关条目的信息

ZipFile::getArchiveComment

返回 Zip 存档注释。 

 $ zipFile = new  PhpZip  ZipFile ();
$ commentArchive = $ zipFile -> getArchiveComment ();
ZipFile::getEntryComment

使用条目名称返回条目的注释。 

 $ zipFile = new  PhpZip  ZipFile ();
$ commentEntry = $ zipFile -> getEntryComment ( $ entryName );

将条目添加到存档

所有向 ZIP 存档添加条目的方法都允许您指定压缩内容的方法。

可以使用以下压缩方法：

  • PhpZipConstantsZipCompressionMethod::STORED - 不压缩
  • PhpZipConstantsZipCompressionMethod::DEFLATED - 放气压缩
  • PhpZipConstantsZipCompressionMethod::BZIP2 - 扩展名为ext-bz2的 Bzip2 压缩
ZipFile::添加文件

将文件从给定路径添加到 ZIP 存档。 

 $ zipFile = new  PhpZip  ZipFile ();
// $file = '...../file.ext'; 
// $entryName = 'file2.ext'
$ zipFile -> addFile ( $ file );

// you can specify the name of the entry in the archive (if null, then the last component from the file name is used)
$ zipFile -> addFile ( $ file , $ entryName );

// you can specify a compression method
$ zipFile -> addFile ( $ file , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFile ( $ file , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFile ( $ file , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression
ZipFile::addSplFile

将SplFileInfo添加到 ZIP 存档。 

 // $file = '...../file.ext'; 
// $entryName = 'file2.ext'
$ zipFile = new  PhpZip  ZipFile ();

$ splFile = new  SplFileInfo ( ' README.md ' );

$ zipFile -> addSplFile ( $ splFile );
$ zipFile -> addSplFile ( $ splFile , $ entryName );
// or
$ zipFile [ $ entryName ] = new  SplFileInfo ( $ file );

// set compression method
$ zipFile -> addSplFile ( $ splFile , $ entryName , $ options = [
     PhpZip  Constants ZipOptions:: COMPRESSION_METHOD =>  PhpZip  Constants ZipCompressionMethod:: DEFLATED ,
]);
ZipFile::addFromFinder

将SymfonyComponentFinderFinder中的文件添加到 ZIP 存档中。 

 $ finder = new  Symfony  Component  Finder  Finder ();
$ finder
    -> files ()
    -> name ( ' *.{jpg,jpeg,gif,png} ' )
    -> name ( ' /^[0-9a-f]./ ' )
    -> contains ( ' /lorems+ipsum$/i ' )
    -> in ( ' path ' );

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFromFinder ( $ finder , $ options = [
     PhpZip  Constants ZipOptions:: COMPRESSION_METHOD =>  PhpZip  Constants ZipCompressionMethod:: DEFLATED ,
     PhpZip  Constants ZipOptions:: MODIFIED_TIME => new  DateTimeImmutable ( ' -1 day 5 min ' )
]);
ZipFile::addFromString

使用文件内容将文件添加到 ZIP 存档。 

 $ zipFile = new  PhpZip  ZipFile ();

$ zipFile [ $ entryName ] = $ contents ;
// or
$ zipFile -> addFromString ( $ entryName , $ contents );

// you can specify a compression method
$ zipFile -> addFromString ( $ entryName , $ contents ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFromString ( $ entryName , $ contents ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFromString ( $ entryName , $ contents ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression
ZipFile::addFromStream

将流中的条目添加到 ZIP 存档。 

 $ zipFile = new  PhpZip  ZipFile ();
// $stream = fopen(..., 'rb');

$ zipFile -> addFromStream ( $ stream , $ entryName );
// or
$ zipFile [ $ entryName ] = $ stream ;

// you can specify a compression method
$ zipFile -> addFromStream ( $ stream , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFromStream ( $ stream , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFromStream ( $ stream , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression
ZipFile::addEmptyDir

添加新目录。 

 $ zipFile = new  PhpZip  ZipFile ();
// $path = "path/to/";
$ zipFile -> addEmptyDir ( $ path );
// or
$ zipFile [ $ path ] = null ;
ZipFile::addAll

添加数组中的所有条目。 

 $ entries = [
    ' file.txt ' => ' file contents ' , // add an entry from the string contents
    ' empty dir/ ' => null , // add empty directory
    ' path/to/file.jpg ' => fopen ( ' ..../filename ' , ' rb ' ), // add an entry from the stream
    ' path/to/file.dat ' => new  SplFileInfo ( ' ..../filename ' ), // add an entry from the file
];

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addAll ( $ entries );
ZipFile::添加目录

将文件从指定路径上的目录（不带子目录）添加到存档中。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addDir ( $ dirName );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addDir ( $ dirName , $ localPath );

// you can specify a compression method
$ zipFile -> addDir ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addDir ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addDir ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression
ZipFile::addDirRecursive

将指定路径及其子目录中的目录中的文件添加到存档中。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addDirRecursive ( $ dirName );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addDirRecursive ( $ dirName , $ localPath );

// you can specify a compression method
$ zipFile -> addDirRecursive ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addDirRecursive ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addDirRecursive ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression
ZipFile::addFilesFromIterator

从目录迭代器添加文件。 

 // $directoryIterator = new DirectoryIterator($dir); // without subdirectories
// $directoryIterator = new RecursiveDirectoryIterator($dir); // with subdirectories
$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromIterator ( $ directoryIterator );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath );
// or
$ zipFile [ $ localPath ] = $ directoryIterator ;

// you can specify a compression method
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

一些文件被忽略的示例： 

 $ ignoreFiles = [
    ' file_ignore.txt ' , 
    ' dir_ignore/sub dir ignore/ '
];

// $directoryIterator = new DirectoryIterator($dir); // without subdirectories
// $directoryIterator = new RecursiveDirectoryIterator($dir); // with subdirectories
// use PhpZipUtilIteratorIgnoreFilesFilterIterator for non-recursive search
 
$ zipFile = new  PhpZip  ZipFile ();
$ ignoreIterator = new  PhpZip  Util  Iterator  IgnoreFilesRecursiveFilterIterator (
    $ directoryIterator , 
    $ ignoreFiles
);

$ zipFile -> addFilesFromIterator ( $ ignoreIterator );
ZipFile::addFilesFromGlob

通过 glob 模式从目录添加文件，不带子目录。 

 $ globPattern = ' **.{jpg,jpeg,png,gif} ' ; // example glob pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression
ZipFile::addFilesFromGlobRecursive

通过带有子目录的 glob 模式添加目录中的文件。 

 $ globPattern = ' **.{jpg,jpeg,png,gif} ' ; // example glob pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression
ZipFile::addFilesFromRegex

通过 PCRE 模式从目录添加文件，不带子目录。 

 $ regexPattern = ' /.(jpe?g|png|gif)$/si ' ; // example regex pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression
ZipFile::addFilesFromRegexRecursive

通过带有子目录的 PCRE 模式添加目录中的文件。 

 $ regexPattern = ' /.(jpe?g|png|gif)$/si ' ; // example regex pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

从存档中删除条目

ZipFile::从名称删除

使用名称删除存档中的条目。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteFromName ( $ entryName );
ZipFile::deleteFromGlob

使用 glob 模式删除存档中的条目。 

 $ globPattern = ' **.{jpg,jpeg,png,gif} ' ; // example glob pattern -> delete all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteFromGlob ( $ globPattern );
ZipFile::deleteFromRegex

使用 PCRE 模式删除存档中的条目。 

 $ regexPattern = ' /.(jpe?g|png|gif)$/si ' ; // example regex pattern -> delete all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteFromRegex ( $ regexPattern );
ZipFile::删除全部

删除 ZIP 存档中的所有条目。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteAll ();

处理条目和档案

ZipFile::重命名

重命名由其名称定义的条目。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> rename ( $ oldName , $ newName );
ZipFile::设置压缩级别

设置存档中所有文件的压缩级别。

请注意，此方法不适用于运行此方法后添加的条目。

默认情况下，压缩级别为 5 ( PhpZipConstantsZipCompressionLevel::NORMAL ) 或存档中为 Deflate 压缩指定的压缩级别。

支持的值范围为 1 ( PhpZipConstantsZipCompressionLevel::SUPER_FAST ) 到 9 ( PhpZipConstantsZipCompressionLevel::MAXIMUM )。数字越大，压缩效果越好、时间越长。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setCompressionLevel ( PhpZip  Constants ZipCompressionLevel:: MAXIMUM );
ZipFile::set压缩级别条目

按条目名称设置条目的压缩级别。

支持的值范围为 1 ( PhpZipConstantsZipCompressionLevel::SUPER_FAST ) 到 9 ( PhpZipConstantsZipCompressionLevel::MAXIMUM )。数字越大，压缩效果越好、时间越长。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setCompressionLevelEntry ( $ entryName ,  PhpZip  Constants ZipCompressionLevel:: FAST );
ZipFile::set压缩方法条目

按条目名称设置条目的压缩方法。

可以使用以下压缩方法：

  • PhpZipConstantsZipCompressionMethod::STORED - 无压缩
  • PhpZipConstantsZipCompressionMethod::DEFLATED - 放气压缩
  • PhpZipConstantsZipCompressionMethod::BZIP2 - 扩展名为ext-bz2的 Bzip2 压缩
 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setCompressionMethodEntry ( $ entryName ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED );
ZipFile::setArchiveComment

设置 ZIP 存档的注释。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setArchiveComment ( $ commentArchive );
ZipFile::setEntryComment

设置由名称定义的条目的注释。 

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setEntryComment ( $ entryName , $ comment );
ZipFile::匹配器

选择存档中的条目以对其执行操作。 

 $ zipFile = new  PhpZip  ZipFile ();
$ matcher = $ zipFile -> matcher ();

一次从存档中选择一个文件： 

 $ matcher
    -> add ( ' entry name ' )
    -> add ( ' another entry ' );

选择存档中的多个文件： 

 $ matcher -> add ([
    ' entry name ' ,
    ' another entry name ' ,
    ' path/ '
]);

通过正则表达式选择文件： 

 $ matcher -> match ( ' ~.jpe?g$~i ' );

选择存档中的所有文件： 

 $ matcher -> all ();

count() - 获取所选条目的数量： 

 $ count = count ( $ matcher );
// or
$ count = $ matcher -> count ();

getMatches() - 返回选定条目的列表： 

 $ entries = $ matcher -> getMatches ();
// example array contents: ['entry name', 'another entry name'];

invoke() - 对选定条目调用可调用函数： 

 // example
$ matcher -> invoke ( static function ( $ entryName ) use ( $ zipFile ) {
    $ newName = preg_replace ( ' ~.(jpe?g)$~i ' , ' .no_optimize.$1 ' , $ entryName );
    $ zipFile -> rename ( $ entryName , $ newName );
});

用于处理所选条目的函数： 

 $ matcher -> delete (); // remove selected entries from a ZIP archive
$ matcher -> setPassword ( $ password ); // sets a new password for the selected entries
$ matcher -> setPassword ( $ password , $ encryptionMethod ); // sets a new password and encryption method to selected entries
$ matcher -> setEncryptionMethod ( $ encryptionMethod ); // sets the encryption method to the selected entries
$ matcher -> disableEncryption (); // disables encryption for selected entries

使用密码

实现了对加密方法的支持：

  • PhpZipConstantsZipEncryptionMethod::PKWARE - 传统 PKWARE 加密（遗留）
  • PhpZipConstantsZipEncryptionMethod::WINZIP_AES_256 - WinZip AES 加密 256 位（推荐）
  • PhpZipConstantsZipEncryptionMethod::WINZIP_AES_192 - WinZip AES 加密 192 位
  • PhpZipConstantsZipEncryptionMethod::WINZIP_AES_128 - WinZip AES 加密 128 位
ZipFile::setReadPassword

设置打开档案的密码。

添加新条目或删除现有条目不需要设置密码，但如果要提取内容或更改方法/压缩级别、加密方法或更改密码，在这种情况下必须指定密码。 

 $ zipFile -> setReadPassword ( $ password );
ZipFile::setReadPasswordEntry

获取用于读取由其名称定义的条目的密码。 

 $ zipFile -> setReadPasswordEntry ( $ entryName , $ password );
ZipFile::设置密码

为存档中的所有文件设置新密码。

请注意，此方法不适用于运行此方法后添加的条目。 

 $ zipFile -> setPassword ( $ password );

您可以设置加密方法： 

 $ encryptionMethod =  PhpZip  Constants ZipEncryptionMethod:: WINZIP_AES_256 ;
$ zipFile -> setPassword ( $ password , $ encryptionMethod );
ZipFile::setPasswordEntry

设置由其名称定义的条目的新密码。 

 $ zipFile -> setPasswordEntry ( $ entryName , $ password );

您可以设置加密方法： 

 $ encryptionMethod =  PhpZip  Constants ZipEncryptionMethod:: WINZIP_AES_256 ;
$ zipFile -> setPasswordEntry ( $ entryName , $ password , $ encryptionMethod );
ZipFile::禁用加密

对存档中已有的所有条目禁用加密。

请注意，此方法不适用于运行此方法后添加的条目。 

 $ zipFile -> disableEncryption ();
ZipFile::disableEncryptionEntry

禁用由其名称定义的条目的加密。 

 $ zipFile -> disableEncryptionEntry ( $ entryName );

撤消更改

ZipFile::unchangeAll

撤消存档中所做的所有更改。 

 $ zipFile -> unchangeAll ();
ZipFile::unchangeArchiveComment

撤消对存档注释的更改。 

 $ zipFile -> unchangeArchiveComment ();
ZipFile::unchangeEntry

撤消对由其名称定义的条目的更改。 

 $ zipFile -> unchangeEntry ( $ entryName );

将文件或输出保存到浏览器

ZipFile::另存为文件

将存档保存到文件中。 

 $ zipFile -> saveAsFile ( $ filename );
ZipFile::saveAsStream

将存档写入流。 

 // $fp = fopen($filename, 'w+b');

$ zipFile -> saveAsStream ( $ fp );
ZipFile::输出为字符串

将 ZIP 存档输出为字符串。 

 $ rawZipArchiveBytes = $ zipFile -> outputAsString ();
ZipFile::输出为附件

将 ZIP 存档输出到浏览器。 

 $ zipFile -> outputAsAttachment ( $ outputFilename );

您可以设置 Mime-Type： 

 $ mimeType = ' application/zip ' ;
$ zipFile -> outputAsAttachment ( $ outputFilename , $ mimeType );
ZipFile::outputAsPsr7Response

输出 ZIP 存档作为 PSR-7 响应。

输出方法可以在任何 PSR-7 兼容框架中使用。 

 // $response = ....; // instance PsrHttpMessageResponseInterface
$ zipFile -> outputAsPsr7Response ( $ response , $ outputFilename );

您可以设置 Mime-Type： 

 $ mimeType = ' application/zip ' ;
$ zipFile -> outputAsPsr7Response ( $ response , $ outputFilename , $ mimeType );
ZipFile::outputAsSymfonyResponse

将 ZIP 存档输出为 Symfony Response。

输出方法可以在Symfony框架中使用。 

 $ response = $ zipFile -> outputAsSymfonyResponse ( $ outputFilename );

您可以设置 Mime-Type： 

 $ mimeType = ' application/zip ' ;
$ response = $ zipFile -> outputAsSymfonyResponse ( $ outputFilename , $ mimeType );

Symfony 控制器中的使用示例： 

 <?php

namespace App  Controller ;

use PhpZip  ZipFile ;
use Symfony  Component  HttpFoundation  Response ;
use Symfony  Component  Routing  Annotation  Route ;

class DownloadZipController
{
    /**
     * @Route("/downloads/{id}")
     *
     * @throws PhpZipExceptionZipException
     */
    public function __invoke ( string $ id ): Response
    {
        $ zipFile = new ZipFile ();
        $ zipFile [ ' file ' ] = ' contents ' ;

        $ outputFilename = $ id . ' .zip ' ;
        return $ zipFile -> outputAsSymfonyResponse ( $ outputFilename );
    }
}
ZipFile::重写

保存更改并重新打开更改的存档。 

 $ zipFile -> rewrite ();

关闭存档

压缩文件::关闭

关闭存档。 

 $ zipFile -> close ();

运行测试

安装开发的依赖项： 

composer install --dev

运行测试： 

vendor/bin/phpunit

变更日志

更改记录在发布页面中。

升级

将版本3升级到版本4

将文件composer.json中的主要版本更新为^4.0 。 

{
    "require" : {
        "nelexa/zip" : " ^4.0 "
    }
}

然后使用Composer安装更新： 

composer update nelexa/zip

更新您的代码以使用新版本： BC

  • 删除了已弃用的类和方法。
  • 删除了zipalign功能。此功能将放置在单独的包nelexa/apkfile中。

将版本2升级到版本3

将文件composer.json中的主要版本更新为^3.0 。 

{
    "require" : {
        "nelexa/zip" : " ^3.0 "
    }
}

然后使用Composer安装更新： 

composer update nelexa/zip

更新您的代码以使用新版本：

  • ZipOutputFile类合并到ZipFile并删除。
    • new PhpZipZipOutputFile()到new PhpZipZipFile()
  • 静态初始化方法现在不是静态的。
    • PhpZipZipFile::openFromFile($filename);到(new PhpZipZipFile())->openFile($filename);
    • PhpZipZipOutputFile::openFromFile($filename);到(new PhpZipZipFile())->openFile($filename);
    • PhpZipZipFile::openFromString($contents);到(new PhpZipZipFile())->openFromString($contents);
    • PhpZipZipFile::openFromStream($stream);到(new PhpZipZipFile())->openFromStream($stream);
    • PhpZipZipOutputFile::create()到new PhpZipZipFile()
    • PhpZipZipOutputFile::openFromZipFile(PhpZipZipFile $zipFile) > (new PhpZipZipFile())->openFile($filename);
  • 重命名方法：
    • addFromFile到addFile
    • setLevel为setCompressionLevel
    • ZipFile::setPassword到ZipFile::withReadPassword
    • ZipOutputFile::setPassword到ZipFile::withNewPassword
    • ZipOutputFile::disableEncryptionAllEntries到ZipFile::withoutPassword
    • ZipOutputFile::setComment到ZipFile::setArchiveComment
    • ZipFile::getComment到ZipFile::getArchiveComment
  • 更改了方法addDir 、 addFilesFromGlob 、 addFilesFromRegex的签名。
  • 删除方法：
    • getLevel
    • setCompressionMethod
    • setEntryPassword
展开
附加信息
相关应用
为您推荐
相关资讯 全部