php zipダウンロード - php zipソースコードのダウンロード

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は必要ありません)。
アーカイブをファイルに保存すること、アーカイブをブラウザに出力すること、またはファイルに保存せずに文字列として出力することをサポートします。
アーカイブコメントと個別エントリのコメントがサポートされています。
アーカイブ内の各エントリに関する情報を取得します。
次の圧縮方法のみがサポートされています。
- 圧縮なし(保存)。
- 空気を抜いて圧縮します。
- 拡張子php-bz2を持つ BZIP2 圧縮。
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-extension 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 Entry - 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::openFile

ファイルから 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::count

アーカイブ内のエントリの数を返します。

 $ 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::isDirectory

アーカイブ内のエントリがディレクトリであることを確認します。

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

$ isDirectory = $ zipFile -> isDirectory ( $ entryName );

ZipFile::extractTo

アーカイブの内容を抽出します。ディレクトリが存在する必要があります。

 $ 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::addFile

指定されたパスから 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::addDir

サブディレクトリを含まない、指定されたパス上のディレクトリからアーカイブにファイルを追加します。

 $ 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::deleteFromName

名前を使用してアーカイブ内のエントリを削除します。

 $ 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::deleteAll

ZIP アーカイブ内のすべてのエントリを削除します。

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

エントリとアーカイブの操作

ZipFile::名前変更

名前で定義されたエントリの名前を変更します。

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> rename ( $ oldName , $ newName );

ZipFile::setCompressionLevel

アーカイブ内のすべてのファイルの圧縮レベルを設定します。

このメソッドは、このメソッドの実行後に追加されたエントリには適用されないことに注意してください。

デフォルトでは、圧縮レベルは 5 ( PhpZipConstantsZipCompressionLevel::NORMAL )、または Deflate 圧縮のアーカイブで指定された圧縮レベルです。

サポートされる値の範囲は 1 ( PhpZipConstantsZipCompressionLevel::SUPER_FAST ) から 9 ( PhpZipConstantsZipCompressionLevel::MAXIMUM ) です。数値が大きいほど、圧縮がより良く、より長くなります。

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setCompressionLevel ( PhpZip  Constants ZipCompressionLevel:: MAXIMUM );

ZipFile::setCompressionLevelEntry

エントリの圧縮レベルを名前で設定します。

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setCompressionLevelEntry ( $ entryName ,  PhpZip  Constants ZipCompressionLevel:: FAST );

ZipFile::setCompressionMethodEntry

エントリの圧縮方法を名前で設定します。

次の圧縮方法が使用できます。

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::matcher

アーカイブ内のエントリを選択して、それらに対して操作を実行します。

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

アーカイブからファイルを一度に 1 つずつ選択します。

 $ 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::setPassword

アーカイブ内のすべてのファイルに新しいパスワードを設定します。

このメソッドは、このメソッドの実行後に追加されたエントリには適用されないことに注意してください。

 $ 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::disableEncryption

すでにアーカイブ内にあるすべてのエントリの暗号化を無効にします。

このメソッドは、このメソッドの実行後に追加されたエントリには適用されないことに注意してください。

 $ zipFile -> disableEncryption ();

ZipFile::disableEncryptionEntry

名前で定義されたエントリの暗号化を無効にします。

 $ zipFile -> disableEncryptionEntry ( $ entryName );

変更を元に戻す

ZipFile::unchangeAll

アーカイブ内で行われたすべての変更を元に戻します。

 $ zipFile -> unchangeAll ();

ZipFile::unchangeArchiveComment

アーカイブコメントへの変更を元に戻します。

 $ zipFile -> unchangeArchiveComment ();

ZipFile::unchangeEntry

名前で定義されたエントリの変更を元に戻します。

 $ zipFile -> unchangeEntry ( $ entryName );

ファイルまたは出力をブラウザに保存する

ZipFile::saveAsFile

アーカイブをファイルに保存します。

 $ zipFile -> saveAsFile ( $ filename );

ZipFile::saveAsStream

アーカイブをストリームに書き込みます。

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

$ zipFile -> saveAsStream ( $ fp );

ZipFile::outputAsString

ZIP アーカイブを文字列として出力します。

 $ rawZipArchiveBytes = $ zipFile -> outputAsString ();

ZipFile::outputAsAttachment

ZIP アーカイブをブラウザに出力します。

 $ zipFile -> outputAsAttachment ( $ outputFilename );

Mime タイプを設定できます。

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

ZipFile::outputAsPsr7Response

ZIP アーカイブを PSR-7 応答として出力します。

この出力方法は、PSR-7 互換のフレームワークで使用できます。

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

Mime タイプを設定できます。

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

ZipFile::outputAsSymfonyResponse

ZIP アーカイブを Symfony レスポンスとして出力します。

出力メソッドは Symfony フレームワークで使用できます。

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

Mime タイプを設定できます。

 $ 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 ();

アーカイブを閉じる

ZIPファイル::閉じる

アーカイブを閉じます。

 $ 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

拡大する

php zip

バージョンと依存関係

目次

特徴

要件

インストール

例

用語集

ドキュメント:

クラスPhpZipZipFileのメソッドの概要

ZIP アーカイブの作成/オープン

ZipFile::__construct**

ZipFile::openFile

ZipFile::openFromString

ZipFile::openFromStream

アーカイブからエントリを読み取る

ZipFile::count

ZipFile::getListFiles

ZipFile::getEntryContent

ZipFile::hasEntry

ZipFile::isDirectory

ZipFile::extractTo

エントリの反復

エントリーに関する情報の取得

ZipFile::getArchiveComment

ZipFile::getEntryComment

アーカイブへのエントリの追加

ZipFile::addFile

ZipFile::addSplFile

ZipFile::addFromFinder

ZipFile::addFromString

ZipFile::addFromStream

ZipFile::addEmptyDir

ZipFile::addAll

ZipFile::addDir

ZipFile::addDirRecursive

ZipFile::addFilesFromIterator

ZipFile::addFilesFromGlob

ZipFile::addFilesFromGlobRecursive

ZipFile::addFilesFromRegex

ZipFile::addFilesFromRegexRecursive

アーカイブからエントリを削除する

ZipFile::deleteFromName

ZipFile::deleteFromGlob

ZipFile::deleteFromRegex

ZipFile::deleteAll

エントリとアーカイブの操作

ZipFile::名前変更

ZipFile::setCompressionLevel

ZipFile::setCompressionLevelEntry

ZipFile::setCompressionMethodEntry

ZipFile::setArchiveComment

ZipFile::setEntryComment

ZipFile::matcher

パスワードの操作

ZipFile::setReadPassword

ZipFile::setReadPasswordEntry

ZipFile::setPassword

ZipFile::setPasswordEntry

ZipFile::disableEncryption

ZipFile::disableEncryptionEntry

変更を元に戻す

ZipFile::unchangeAll

ZipFile::unchangeArchiveComment

ZipFile::unchangeEntry

ファイルまたは出力をブラウザに保存する

ZipFile::saveAsFile

ZipFile::saveAsStream

ZipFile::outputAsString

ZipFile::outputAsAttachment

ZipFile::outputAsPsr7Response

ZipFile::outputAsSymfonyResponse

ZipFile::リライト

アーカイブを閉じる

ZIPファイル::閉じる

テストの実行

変更履歴

アップグレード

バージョン 3 をバージョン 4 にアップグレードします

バージョン 2 をバージョン 3 にアップグレードする

クラス`PhpZipZipFile`のメソッドの概要