mirror/php-zip
1
0
Fork 0
mirror of https://github.com/Ne-Lexa/php-zip.git synced 2025-08-03 14:07:23 +02:00
Code Issues Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Ne-Lexa
2021-02-24 09:53:24 +03:00
parent 28d33ab687
commit ac899a02e0
1 changed files with 205 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files

361
README.md
View File

@@ -18,31 +18,31 @@
Table of contents Table of contents
----------------- -----------------
- [Features](#Features) - [Features](#features)
- [Requirements](#Requirements) - [Requirements](#requirements)
- [Installation](#Installation) - [Installation](#installation)
- [Examples](#Examples) - [Examples](#examples)
- [Glossary](#Glossary) - [Glossary](#glossary)
- [Documentation](#Documentation) - [Documentation](#documentation)
+ [Overview of methods of the class `\PhpZip\ZipFile`](#Documentation-Overview) + [Overview of methods of the class `\PhpZip\ZipFile`](#overview-of-methods-of-the-class-phpzipzipfile)
+ [Creation/Opening of ZIP-archive](#Documentation-Open-Zip-Archive) + [Creation/Opening of ZIP-archive](#creationopening-of-zip-archive)
+ [Reading entries from the archive](#Documentation-Open-Zip-Entries) + [Reading entries from the archive](#reading-entries-from-the-archive)
+ [Iterating entries](#Documentation-Zip-Iterate) + [Iterating entries](#iterating-entries)
+ [Getting information about entries](#Documentation-Zip-Info) + [Getting information about entries](#getting-information-about-entries)
+ [Adding entries to the archive](#Documentation-Add-Zip-Entries) + [Adding entries to the archive](#adding-entries-to-the-archive)
+ [Deleting entries from the archive](#Documentation-Remove-Zip-Entries) + [Deleting entries from the archive](#deleting-entries-from-the-archive)
+ [Working with entries and archive](#Documentation-Entries) + [Working with entries and archive](#working-with-entries-and-archive)
+ [Working with passwords](#Documentation-Password) + [Working with passwords](#working-with-passwords)
+ [Undo changes](#Documentation-Unchanged) + [Undo changes](#undo-changes)
+ [Saving a file or output to a browser](#Documentation-Save-Or-Output-Entries) + [Saving a file or output to a browser](#saving-a-file-or-output-to-a-browser)
+ [Closing the archive](#Documentation-Close-Zip-Archive) + [Closing the archive](#closing-the-archive)
- [Running the tests](#Running-Tests) - [Running the tests](#running-the-tests)
- [Changelog](#Changelog) - [Changelog](#changelog)
- [Upgrade](#Upgrade) - [Upgrade](#upgrade)
+ [Upgrade version 3 to version 4](#Upgrade-v3-to-v4) + [Upgrade version 3 to version 4](#upgrade-version-3-to-version-4)
+ [Upgrade version 2 to version 3.0](#Upgrade-v2-to-v3) + [Upgrade version 2 to version 3](#upgrade-version-2-to-version-3)
### <a name="Features"></a> Features ### Features
- Opening and unzipping zip files. - Opening and unzipping zip files.
- Creating ZIP-archives. - Creating ZIP-archives.
- Modifying ZIP archives. - Modifying ZIP archives.
@@ -69,17 +69,17 @@ Table of contents
+ Support `Traditional PKWARE Encryption (ZipCrypto)` and `WinZIP AES Encryption` encryption methods. + Support `Traditional PKWARE Encryption (ZipCrypto)` and `WinZIP AES Encryption` encryption methods.
+ Set the encryption method for all or individual entries in the archive. + Set the encryption method for all or individual entries in the archive.
### <a name="Requirements"></a> Requirements ### Requirements
- `PHP` >= 7.4 or `PHP` >= 8.0 (preferably 64-bit). - `PHP` >= 7.4 or `PHP` >= 8.0 (preferably 64-bit).
- Optional php-extension `bzip2` for BZIP2 compression. - Optional php-extension `bzip2` for BZIP2 compression.
- Optional php-extension `openssl` for `WinZip Aes Encryption` support. - Optional php-extension `openssl` for `WinZip Aes Encryption` support.
### <a name="Installation"></a> Installation ### Installation
`composer require nelexa/zip` `composer require nelexa/zip`
Latest stable version: [![Latest Stable Version](https://poser.pugx.org/nelexa/zip/v/stable)](https://packagist.org/packages/nelexa/zip) Latest stable version: [![Latest Stable Version](https://poser.pugx.org/nelexa/zip/v/stable)](https://packagist.org/packages/nelexa/zip)
### <a name="Examples"></a> Examples ### Examples
```php ```php
// create new archive // create new archive
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
@@ -109,89 +109,94 @@ finally{
``` ```
Other examples can be found in the `tests/` folder Other examples can be found in the `tests/` folder
### <a name="Glossary"></a> Glossary ### Glossary
**Zip Entry** - file or folder in a ZIP-archive. Each entry in the archive has certain properties, for example: file name, compression method, encryption method, file size before compression, file size after compression, CRC32 and others. **Zip Entry** - file or folder in a ZIP-archive. Each entry in the archive has certain properties, for example: file name, compression method, encryption method, file size before compression, file size after compression, CRC32 and others.
### <a name="Documentation"></a> Documentation: ### Documentation:
#### <a name="Documentation-Overview"></a> Overview of methods of the class `\PhpZip\ZipFile` #### Overview of methods of the class `\PhpZip\ZipFile`
- [ZipFile::__construct](#Documentation-ZipFile-__construct) - initializes the ZIP archive. - [ZipFile::__construct](#zipfile__construct) - initializes the ZIP archive.
- [ZipFile::addAll](#Documentation-ZipFile-addAll) - adds all entries from an array. - [ZipFile::addAll](#zipfileaddall) - adds all entries from an array.
- [ZipFile::addDir](#Documentation-ZipFile-addDir) - adds files to the archive from the directory on the specified path without subdirectories. - [ZipFile::addDir](#zipfileadddir) - adds files to the archive from the directory on the specified path without subdirectories.
- [ZipFile::addDirRecursive](#Documentation-ZipFile-addDirRecursive) - adds files to the archive from the directory on the specified path with subdirectories. - [ZipFile::addDirRecursive](#zipfileadddirrecursive) - adds files to the archive from the directory on the specified path with subdirectories.
- [ZipFile::addEmptyDir](#Documentation-ZipFile-addEmptyDir) - add a new directory. - [ZipFile::addEmptyDir](#zipfileaddemptydir) - add a new directory.
- [ZipFile::addFile](#Documentation-ZipFile-addFile) - adds a file to a ZIP archive from the given path. - [ZipFile::addFile](#zipfileaddfile) - adds a file to a ZIP archive from the given path.
- [ZipFile::addSplFile](#Documentation-ZipFile-addSplFile) - adds a `\SplFileInfo` to a ZIP archive. - [ZipFile::addSplFile](#zipfileaddsplfile) - adds a `\SplFileInfo` to a ZIP archive.
- [ZipFile::addFromFinder](#Documentation-ZipFile-addFromFinder) - adds files from the `Symfony\Component\Finder\Finder` to a ZIP archive. - [ZipFile::addFromFinder](#zipfileaddfromfinder) - adds files from the `Symfony\Component\Finder\Finder` to a ZIP archive.
- [ZipFile::addFilesFromIterator](#Documentation-ZipFile-addFilesFromIterator) - adds files from the iterator of directories. - [ZipFile::addFilesFromIterator](#zipfileaddfilesfromiterator) - adds files from the iterator of directories.
- [ZipFile::addFilesFromGlob](#Documentation-ZipFile-addFilesFromGlob) - adds files from a directory by glob pattern without subdirectories. - [ZipFile::addFilesFromGlob](#zipfileaddfilesfromglob) - adds files from a directory by glob pattern without subdirectories.
- [ZipFile::addFilesFromGlobRecursive](#Documentation-ZipFile-addFilesFromGlobRecursive) - adds files from a directory by glob pattern with subdirectories. - [ZipFile::addFilesFromGlobRecursive](#zipfileaddfilesfromglobrecursive) - adds files from a directory by glob pattern with subdirectories.
- [ZipFile::addFilesFromRegex](#Documentation-ZipFile-addFilesFromRegex) - adds files from a directory by PCRE pattern without subdirectories. - [ZipFile::addFilesFromRegex](#zipfileaddfilesfromregex) - adds files from a directory by PCRE pattern without subdirectories.
- [ZipFile::addFilesFromRegexRecursive](#Documentation-ZipFile-addFilesFromRegexRecursive) - adds files from a directory by PCRE pattern with subdirectories. - [ZipFile::addFilesFromRegexRecursive](#zipfileaddfilesfromregexrecursive) - adds files from a directory by PCRE pattern with subdirectories.
- [ZipFile::addFromStream](#Documentation-ZipFile-addFromStream) - adds an entry from the stream to the ZIP archive. - [ZipFile::addFromStream](#zipfileaddfromstream) - adds an entry from the stream to the ZIP archive.
- [ZipFile::addFromString](#Documentation-ZipFile-addFromString) - adds a file to a ZIP archive using its contents. - [ZipFile::addFromString](#zipfileaddfromstring) - adds a file to a ZIP archive using its contents.
- [ZipFile::close](#Documentation-ZipFile-close) - close the archive. - [ZipFile::close](#zipfileclose) - close the archive.
- [ZipFile::count](#Documentation-ZipFile-count) - returns the number of entries in the archive. - [ZipFile::count](#zipfilecount) - returns the number of entries in the archive.
- [ZipFile::deleteFromName](#Documentation-ZipFile-deleteFromName) - deletes an entry in the archive using its name. - [ZipFile::deleteFromName](#zipfiledeletefromname) - deletes an entry in the archive using its name.
- [ZipFile::deleteFromGlob](#Documentation-ZipFile-deleteFromGlob) - deletes an entries in the archive using glob pattern. - [ZipFile::deleteFromGlob](#zipfiledeletefromglob) - deletes an entries in the archive using glob pattern.
- [ZipFile::deleteFromRegex](#Documentation-ZipFile-deleteFromRegex) - deletes an entries in the archive using PCRE pattern. - [ZipFile::deleteFromRegex](#zipfiledeletefromregex) - deletes an entries in the archive using PCRE pattern.
- [ZipFile::deleteAll](#Documentation-ZipFile-deleteAll) - deletes all entries in the ZIP archive. - [ZipFile::deleteAll](#zipfiledeleteall) - deletes all entries in the ZIP archive.
- [ZipFile::disableEncryption](#Documentation-ZipFile-disableEncryption) - disable encryption for all entries that are already in the archive. - [ZipFile::disableEncryption](#zipfiledisableencryption) - disable encryption for all entries that are already in the archive.
- [ZipFile::disableEncryptionEntry](#Documentation-ZipFile-disableEncryptionEntry) - disable encryption of an entry defined by its name. - [ZipFile::disableEncryptionEntry](#zipfiledisableencryptionentry) - disable encryption of an entry defined by its name.
- [ZipFile::extractTo](#Documentation-ZipFile-extractTo) - extract the archive contents. - [ZipFile::extractTo](#zipfileextractto) - extract the archive contents.
- [ZipFile::getArchiveComment](#Documentation-ZipFile-getArchiveComment) - returns the Zip archive comment. - [ZipFile::getArchiveComment](#zipfilegetarchivecomment) - returns the Zip archive comment.
- [ZipFile::getEntryComment](#Documentation-ZipFile-getEntryComment) - returns the comment of an entry using the entry name. - [ZipFile::getEntryComment](#zipfilegetentrycomment) - returns the comment of an entry using the entry name.
- [ZipFile::getEntryContent](#Documentation-ZipFile-getEntryContent) - returns the entry contents using its name. - [ZipFile::getEntryContent](#zipfilegetentrycontent) - returns the entry contents using its name.
- [ZipFile::getListFiles](#Documentation-ZipFile-getListFiles) - returns list of archive files. - [ZipFile::getListFiles](#zipfilegetlistfiles) - returns list of archive files.
- [ZipFile::hasEntry](#Documentation-ZipFile-hasEntry) - checks if there is an entry in the archive. - [ZipFile::hasEntry](#zipfilehasentry) - checks if there is an entry in the archive.
- [ZipFile::isDirectory](#Documentation-ZipFile-isDirectory) - checks that the entry in the archive is a directory. - [ZipFile::isDirectory](#zipfileisdirectory) - checks that the entry in the archive is a directory.
- [ZipFile::matcher](#Documentation-ZipFile-matcher) - selecting entries in the archive to perform operations on them. - [ZipFile::matcher](#zipfilematcher) - selecting entries in the archive to perform operations on them.
- [ZipFile::openFile](#Documentation-ZipFile-openFile) - opens a zip-archive from a file. - [ZipFile::openFile](#zipfileopenfile) - opens a zip-archive from a file.
- [ZipFile::openFromString](#Documentation-ZipFile-openFromString) - opens a zip-archive from a string. - [ZipFile::openFromString](#zipfileopenfromstring) - opens a zip-archive from a string.
- [ZipFile::openFromStream](#Documentation-ZipFile-openFromStream) - opens a zip-archive from the stream. - [ZipFile::openFromStream](#zipfileopenfromstream) - opens a zip-archive from the stream.
- [ZipFile::outputAsAttachment](#Documentation-ZipFile-outputAsAttachment) - outputs a ZIP-archive to the browser. - [ZipFile::outputAsAttachment](#zipfileoutputasattachment) - outputs a ZIP-archive to the browser.
- [ZipFile::outputAsResponse](#Documentation-ZipFile-outputAsResponse) - outputs a ZIP-archive as PSR-7 Response. - [ZipFile::outputAsResponse](#zipfileoutputasresponse) - outputs a ZIP-archive as PSR-7 Response.
- [ZipFile::outputAsString](#Documentation-ZipFile-outputAsString) - outputs a ZIP-archive as string. - [ZipFile::outputAsString](#zipfileoutputasstring) - outputs a ZIP-archive as string.
- [ZipFile::rename](#Documentation-ZipFile-rename) - renames an entry defined by its name. - [ZipFile::rename](#zipfilerename) - renames an entry defined by its name.
- [ZipFile::rewrite](#Documentation-ZipFile-rewrite) - save changes and re-open the changed archive. - [ZipFile::rewrite](#zipfilerewrite) - save changes and re-open the changed archive.
- [ZipFile::saveAsFile](#Documentation-ZipFile-saveAsFile) - saves the archive to a file. - [ZipFile::saveAsFile](#zipfilesaveasfile) - saves the archive to a file.
- [ZipFile::saveAsStream](#Documentation-ZipFile-saveAsStream) - writes the archive to the stream. - [ZipFile::saveAsStream](#zipfilesaveasstream) - writes the archive to the stream.
- [ZipFile::setArchiveComment](#Documentation-ZipFile-setArchiveComment) - set the comment of a ZIP archive. - [ZipFile::setArchiveComment](#zipfilesetarchivecomment) - set the comment of a ZIP archive.
- [ZipFile::setCompressionLevel](#Documentation-ZipFile-setCompressionLevel) - set the compression level for all files in the archive. - [ZipFile::setCompressionLevel](#zipfilesetcompressionlevel) - set the compression level for all files in the archive.
- [ZipFile::setCompressionLevelEntry](#Documentation-ZipFile-setCompressionLevelEntry) - sets the compression level for the entry by its name. - [ZipFile::setCompressionLevelEntry](#zipfilesetcompressionlevelentry) - sets the compression level for the entry by its name.
- [ZipFile::setCompressionMethodEntry](#Documentation-ZipFile-setCompressionMethodEntry) - sets the compression method for the entry by its name. - [ZipFile::setCompressionMethodEntry](#zipfilesetcompressionmethodentry) - sets the compression method for the entry by its name.
- [ZipFile::setEntryComment](#Documentation-ZipFile-setEntryComment) - set the comment of an entry defined by its name. - [ZipFile::setEntryComment](#zipfilesetentrycomment) - set the comment of an entry defined by its name.
- [ZipFile::setReadPassword](#Documentation-ZipFile-setReadPassword) - set the password for the open archive. - [ZipFile::setReadPassword](#zipfilesetreadpassword) - set the password for the open archive.
- [ZipFile::setReadPasswordEntry](#Documentation-ZipFile-setReadPasswordEntry) - sets a password for reading of an entry defined by its name. - [ZipFile::setReadPasswordEntry](#zipfilesetreadpasswordentry) - sets a password for reading of an entry defined by its name.
- [ZipFile::setPassword](#Documentation-ZipFile-setPassword) - sets a new password for all files in the archive. - [ZipFile::setPassword](#zipfilesetpassword) - sets a new password for all files in the archive.
- [ZipFile::setPasswordEntry](#Documentation-ZipFile-setPasswordEntry) - sets a new password of an entry defined by its name. - [ZipFile::setPasswordEntry](#zipfilesetpasswordentry) - sets a new password of an entry defined by its name.
- [ZipFile::unchangeAll](#Documentation-ZipFile-unchangeAll) - undo all changes done in the archive. - [ZipFile::unchangeAll](#zipfileunchangeall) - undo all changes done in the archive.
- [ZipFile::unchangeArchiveComment](#Documentation-ZipFile-unchangeArchiveComment) - undo changes to the archive comment. - [ZipFile::unchangeArchiveComment](#zipfileunchangearchivecomment) - undo changes to the archive comment.
- [ZipFile::unchangeEntry](#Documentation-ZipFile-unchangeEntry) - undo changes of an entry defined by its name. - [ZipFile::unchangeEntry](#zipfileunchangeentry) - undo changes of an entry defined by its name.
#### <a name="Documentation-Open-Zip-Archive"></a> Creation/Opening of ZIP-archive #### Creation/Opening of ZIP-archive
<a name="Documentation-ZipFile-__construct"></a>**ZipFile::__construct** - initializes the ZIP archive. ##### ZipFile::__construct**
Initializes the ZIP archive
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
``` ```
<a name="Documentation-ZipFile-openFile"></a> **ZipFile::openFile** - opens a zip-archive from a file. ##### ZipFile::openFile
Opens a zip-archive from a file.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->openFile('file.zip'); $zipFile->openFile('file.zip');
``` ```
<a name="Documentation-ZipFile-openFromString"></a> **ZipFile::openFromString** - opens a zip-archive from a string. ##### ZipFile::openFromString
Opens a zip-archive from a string.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->openFromString($stringContents); $zipFile->openFromString($stringContents);
``` ```
<a name="Documentation-ZipFile-openFromStream"></a> **ZipFile::openFromStream** - opens a zip-archive from the stream. ##### ZipFile::openFromStream
Opens a zip-archive from the stream.
```php ```php
$stream = fopen('file.zip', 'rb'); $stream = fopen('file.zip', 'rb');
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->openFromStream($stream); $zipFile->openFromStream($stream);
``` ```
#### <a name="Documentation-Open-Zip-Entries"></a> Reading entries from the archive #### Reading entries from the archive
<a name="Documentation-ZipFile-count"></a> **ZipFile::count** - returns the number of entries in the archive. ##### ZipFile::count
Returns the number of entries in the archive.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
@@ -199,7 +204,8 @@ $count = count($zipFile);
// or // or
$count = $zipFile->count(); $count = $zipFile->count();
``` ```
<a name="Documentation-ZipFile-getListFiles"></a> **ZipFile::getListFiles** - returns list of archive files. ##### ZipFile::getListFiles
Returns list of archive files.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$listFiles = $zipFile->getListFiles(); $listFiles = $zipFile->getListFiles();
@@ -212,7 +218,8 @@ $listFiles = $zipFile->getListFiles();
// 3 => '0', // 3 => '0',
// ) // )
``` ```
<a name="Documentation-ZipFile-getEntryContent"></a> **ZipFile::getEntryContent** - returns the entry contents using its name. ##### ZipFile::getEntryContent
Returns the entry contents using its name.
```php ```php
// $entryName = 'path/to/example-entry-name.txt'; // $entryName = 'path/to/example-entry-name.txt';
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
@@ -221,7 +228,8 @@ $contents = $zipFile[$entryName];
// or // or
$contents = $zipFile->getEntryContents($entryName); $contents = $zipFile->getEntryContents($entryName);
``` ```
<a name="Documentation-ZipFile-hasEntry"></a> **ZipFile::hasEntry** - checks if there is an entry in the archive. ##### ZipFile::hasEntry
Checks if there is an entry in the archive.
```php ```php
// $entryName = 'path/to/example-entry-name.txt'; // $entryName = 'path/to/example-entry-name.txt';
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
@@ -230,14 +238,16 @@ $hasEntry = isset($zipFile[$entryName]);
// or // or
$hasEntry = $zipFile->hasEntry($entryName); $hasEntry = $zipFile->hasEntry($entryName);
``` ```
<a name="Documentation-ZipFile-isDirectory"></a> **ZipFile::isDirectory** - checks that the entry in the archive is a directory. ##### ZipFile::isDirectory
Checks that the entry in the archive is a directory.
```php ```php
// $entryName = 'path/to/'; // $entryName = 'path/to/';
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$isDirectory = $zipFile->isDirectory($entryName); $isDirectory = $zipFile->isDirectory($entryName);
``` ```
<a name="Documentation-ZipFile-extractTo"></a> **ZipFile::extractTo** - extract the archive contents. ##### ZipFile::extractTo
Extract the archive contents.
The directory must exist. The directory must exist.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
@@ -255,7 +265,7 @@ $extractOnlyFiles = [
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->extractTo($toDirectory, $extractOnlyFiles); $zipFile->extractTo($toDirectory, $extractOnlyFiles);
``` ```
#### <a name="Documentation-Zip-Iterate"></a> Iterating entries #### Iterating entries
`ZipFile` is an iterator. `ZipFile` is an iterator.
Can iterate all the entries in the `foreach` loop. Can iterate all the entries in the `foreach` loop.
```php ```php
@@ -280,19 +290,21 @@ while ($iterator->valid())
$iterator->next(); $iterator->next();
} }
``` ```
#### <a name="Documentation-Zip-Info"></a> Getting information about entries #### Getting information about entries
<a name="Documentation-ZipFile-getArchiveComment"></a> **ZipFile::getArchiveComment** - returns the Zip archive comment. ##### ZipFile::getArchiveComment
Returns the Zip archive comment.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$commentArchive = $zipFile->getArchiveComment(); $commentArchive = $zipFile->getArchiveComment();
``` ```
<a name="Documentation-ZipFile-getEntryComment"></a> **ZipFile::getEntryComment** - returns the comment of an entry using the entry name. ##### ZipFile::getEntryComment
Returns the comment of an entry using the entry name.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$commentEntry = $zipFile->getEntryComment($entryName); $commentEntry = $zipFile->getEntryComment($entryName);
``` ```
#### <a name="Documentation-Add-Zip-Entries"></a> Adding entries to the archive
#### Adding entries to the archive
All methods of adding entries to a ZIP archive allow you to specify a method for compressing content. All methods of adding entries to a ZIP archive allow you to specify a method for compressing content.
The following methods of compression are available: The following methods of compression are available:
@@ -300,7 +312,8 @@ The following methods of compression are available:
- `\PhpZip\Constants\ZipCompressionMethod::DEFLATED` - Deflate compression - `\PhpZip\Constants\ZipCompressionMethod::DEFLATED` - Deflate compression
- `\PhpZip\Constants\ZipCompressionMethod::BZIP2` - Bzip2 compression with the extension `ext-bz2` - `\PhpZip\Constants\ZipCompressionMethod::BZIP2` - Bzip2 compression with the extension `ext-bz2`
<a name="Documentation-ZipFile-addFile"></a> **ZipFile::addFile** - adds a file to a ZIP archive from the given path. ##### ZipFile::addFile
Adds a file to a ZIP archive from the given path.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
// $file = '...../file.ext'; // $file = '...../file.ext';
@@ -315,8 +328,8 @@ $zipFile->addFile($file, $entryName, \PhpZip\Constants\ZipCompressionMethod::STO
$zipFile->addFile($file, $entryName, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression $zipFile->addFile($file, $entryName, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression
$zipFile->addFile($file, $entryName, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression $zipFile->addFile($file, $entryName, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression
``` ```
<a name="Documentation-ZipFile-addSplFile"></a> ##### ZipFile::addSplFile
**ZipFile::addSplFile"** - adds a `\SplFileInfo` to a ZIP archive. Adds a `\SplFileInfo` to a ZIP archive.
```php ```php
// $file = '...../file.ext'; // $file = '...../file.ext';
// $entryName = 'file2.ext' // $entryName = 'file2.ext'
@@ -334,9 +347,8 @@ $zipFile->addSplFile($splFile, $entryName, $options = [
\PhpZip\Constants\ZipOptions::COMPRESSION_METHOD => \PhpZip\Constants\ZipCompressionMethod::DEFLATED, \PhpZip\Constants\ZipOptions::COMPRESSION_METHOD => \PhpZip\Constants\ZipCompressionMethod::DEFLATED,
]); ]);
``` ```
<a name="Documentation-ZipFile-addFromFinder"></a> ##### ZipFile::addFromFinder
**ZipFile::addFromFinder** - adds files from the `Symfony\Component\Finder\Finder` to a ZIP archive. Adds files from the [`Symfony\Component\Finder\Finder`](https://symfony.com/doc/current/components/finder.html) to a ZIP archive.
https://symfony.com/doc/current/components/finder.html
```php ```php
$finder = new \Symfony\Component\Finder\Finder(); $finder = new \Symfony\Component\Finder\Finder();
$finder $finder
@@ -352,7 +364,8 @@ $zipFile->addFromFinder($finder, $options = [
\PhpZip\Constants\ZipOptions::MODIFIED_TIME => new \DateTimeImmutable('-1 day 5 min') \PhpZip\Constants\ZipOptions::MODIFIED_TIME => new \DateTimeImmutable('-1 day 5 min')
]); ]);
``` ```
<a name="Documentation-ZipFile-addFromString"></a> **ZipFile::addFromString** - adds a file to a ZIP archive using its contents. ##### ZipFile::addFromString
Adds a file to a ZIP archive using its contents.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
@@ -365,7 +378,8 @@ $zipFile->addFromString($entryName, $contents, \PhpZip\Constants\ZipCompressionM
$zipFile->addFromString($entryName, $contents, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression $zipFile->addFromString($entryName, $contents, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression
$zipFile->addFromString($entryName, $contents, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression $zipFile->addFromString($entryName, $contents, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression
``` ```
<a name="Documentation-ZipFile-addFromStream"></a> **ZipFile::addFromStream** - adds an entry from the stream to the ZIP archive. ##### ZipFile::addFromStream
Adds an entry from the stream to the ZIP archive.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
// $stream = fopen(..., 'rb'); // $stream = fopen(..., 'rb');
@@ -379,7 +393,8 @@ $zipFile->addFromStream($stream, $entryName, \PhpZip\Constants\ZipCompressionMet
$zipFile->addFromStream($stream, $entryName, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression $zipFile->addFromStream($stream, $entryName, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression
$zipFile->addFromStream($stream, $entryName, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression $zipFile->addFromStream($stream, $entryName, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression
``` ```
<a name="Documentation-ZipFile-addEmptyDir"></a> **ZipFile::addEmptyDir** - add a new directory. ##### ZipFile::addEmptyDir
Add a new directory.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
// $path = "path/to/"; // $path = "path/to/";
@@ -387,7 +402,8 @@ $zipFile->addEmptyDir($path);
// or // or
$zipFile[$path] = null; $zipFile[$path] = null;
``` ```
<a name="Documentation-ZipFile-addAll"></a> **ZipFile::addAll** - adds all entries from an array. ##### ZipFile::addAll
Adds all entries from an array.
```php ```php
$entries = [ $entries = [
'file.txt' => 'file contents', // add an entry from the string contents 'file.txt' => 'file contents', // add an entry from the string contents
@@ -399,7 +415,8 @@ $entries = [
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->addAll($entries); $zipFile->addAll($entries);
``` ```
<a name="Documentation-ZipFile-addDir"></a> **ZipFile::addDir** - adds files to the archive from the directory on the specified path without subdirectories. ##### ZipFile::addDir
Adds files to the archive from the directory on the specified path without subdirectories.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->addDir($dirName); $zipFile->addDir($dirName);
@@ -413,7 +430,8 @@ $zipFile->addDir($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::S
$zipFile->addDir($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression $zipFile->addDir($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression
$zipFile->addDir($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression $zipFile->addDir($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression
``` ```
<a name="Documentation-ZipFile-addDirRecursive"></a> **ZipFile::addDirRecursive** - adds files to the archive from the directory on the specified path with subdirectories. ##### ZipFile::addDirRecursive
Adds files to the archive from the directory on the specified path with subdirectories.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->addDirRecursive($dirName); $zipFile->addDirRecursive($dirName);
@@ -427,7 +445,8 @@ $zipFile->addDirRecursive($dirName, $localPath, \PhpZip\Constants\ZipCompression
$zipFile->addDirRecursive($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression $zipFile->addDirRecursive($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression
$zipFile->addDirRecursive($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression $zipFile->addDirRecursive($dirName, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression
``` ```
<a name="Documentation-ZipFile-addFilesFromIterator"></a> **ZipFile::addFilesFromIterator** - adds files from the iterator of directories. ##### ZipFile::addFilesFromIterator
Adds files from the iterator of directories.
```php ```php
// $directoryIterator = new \DirectoryIterator($dir); // without subdirectories // $directoryIterator = new \DirectoryIterator($dir); // without subdirectories
// $directoryIterator = new \RecursiveDirectoryIterator($dir); // with subdirectories // $directoryIterator = new \RecursiveDirectoryIterator($dir); // with subdirectories
@@ -464,7 +483,8 @@ $ignoreIterator = new \PhpZip\Util\Iterator\IgnoreFilesRecursiveFilterIterator(
$zipFile->addFilesFromIterator($ignoreIterator); $zipFile->addFilesFromIterator($ignoreIterator);
``` ```
<a name="Documentation-ZipFile-addFilesFromGlob"></a> **ZipFile::addFilesFromGlob** - adds files from a directory by [glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)) without subdirectories. ##### ZipFile::addFilesFromGlob
Adds files from a directory by [glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)) without subdirectories.
```php ```php
$globPattern = '**.{jpg,jpeg,png,gif}'; // example glob pattern -> add all .jpg, .jpeg, .png and .gif files $globPattern = '**.{jpg,jpeg,png,gif}'; // example glob pattern -> add all .jpg, .jpeg, .png and .gif files
@@ -480,7 +500,8 @@ $zipFile->addFilesFromGlob($dir, $globPattern, $localPath, \PhpZip\Constants\Zip
$zipFile->addFilesFromGlob($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression $zipFile->addFilesFromGlob($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression
$zipFile->addFilesFromGlob($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression $zipFile->addFilesFromGlob($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression
``` ```
<a name="Documentation-ZipFile-addFilesFromGlobRecursive"></a> **ZipFile::addFilesFromGlobRecursive** - adds files from a directory by [glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)) with subdirectories. ##### ZipFile::addFilesFromGlobRecursive
Adds files from a directory by [glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)) with subdirectories.
```php ```php
$globPattern = '**.{jpg,jpeg,png,gif}'; // example glob pattern -> add all .jpg, .jpeg, .png and .gif files $globPattern = '**.{jpg,jpeg,png,gif}'; // example glob pattern -> add all .jpg, .jpeg, .png and .gif files
@@ -496,7 +517,8 @@ $zipFile->addFilesFromGlobRecursive($dir, $globPattern, $localPath, \PhpZip\Cons
$zipFile->addFilesFromGlobRecursive($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression $zipFile->addFilesFromGlobRecursive($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression
$zipFile->addFilesFromGlobRecursive($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression $zipFile->addFilesFromGlobRecursive($dir, $globPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression
``` ```
<a name="Documentation-ZipFile-addFilesFromRegex"></a> **ZipFile::addFilesFromRegex** - adds files from a directory by [PCRE pattern](https://en.wikipedia.org/wiki/Regular_expression) without subdirectories. ##### ZipFile::addFilesFromRegex
Adds files from a directory by [PCRE pattern](https://en.wikipedia.org/wiki/Regular_expression) without subdirectories.
```php ```php
$regexPattern = '/\.(jpe?g|png|gif)$/si'; // example regex pattern -> add all .jpg, .jpeg, .png and .gif files $regexPattern = '/\.(jpe?g|png|gif)$/si'; // example regex pattern -> add all .jpg, .jpeg, .png and .gif files
@@ -512,11 +534,11 @@ $zipFile->addFilesFromRegex($dir, $regexPattern, $localPath, \PhpZip\Constants\Z
$zipFile->addFilesFromRegex($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression $zipFile->addFilesFromRegex($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression
$zipFile->addFilesFromRegex($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression $zipFile->addFilesFromRegex($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression
``` ```
<a name="Documentation-ZipFile-addFilesFromRegexRecursive"></a> **ZipFile::addFilesFromRegexRecursive** - adds files from a directory by [PCRE pattern](https://en.wikipedia.org/wiki/Regular_expression) with subdirectories. ##### ZipFile::addFilesFromRegexRecursive
Adds files from a directory by [PCRE pattern](https://en.wikipedia.org/wiki/Regular_expression) with subdirectories.
```php ```php
$regexPattern = '/\.(jpe?g|png|gif)$/si'; // example regex pattern -> add all .jpg, .jpeg, .png and .gif files $regexPattern = '/\.(jpe?g|png|gif)$/si'; // example regex pattern -> add all .jpg, .jpeg, .png and .gif files
$zipFile->addFilesFromRegexRecursive($dir, $regexPattern); $zipFile->addFilesFromRegexRecursive($dir, $regexPattern);
// you can specify the path in the archive to which you want to put entries // you can specify the path in the archive to which you want to put entries
@@ -528,38 +550,44 @@ $zipFile->addFilesFromRegexRecursive($dir, $regexPattern, $localPath, \PhpZip\Co
$zipFile->addFilesFromRegexRecursive($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression $zipFile->addFilesFromRegexRecursive($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); // Deflate compression
$zipFile->addFilesFromRegexRecursive($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression $zipFile->addFilesFromRegexRecursive($dir, $regexPattern, $localPath, \PhpZip\Constants\ZipCompressionMethod::BZIP2); // BZIP2 compression
``` ```
#### <a name="Documentation-Remove-Zip-Entries"></a> Deleting entries from the archive #### Deleting entries from the archive
<a name="Documentation-ZipFile-deleteFromName"></a> **ZipFile::deleteFromName** - deletes an entry in the archive using its name. ##### ZipFile::deleteFromName
Deletes an entry in the archive using its name.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->deleteFromName($entryName); $zipFile->deleteFromName($entryName);
``` ```
<a name="Documentation-ZipFile-deleteFromGlob"></a> **ZipFile::deleteFromGlob** - deletes a entries in the archive using [glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)). ##### ZipFile::deleteFromGlob
Deletes a entries in the archive using [glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)).
```php ```php
$globPattern = '**.{jpg,jpeg,png,gif}'; // example glob pattern -> delete all .jpg, .jpeg, .png and .gif files $globPattern = '**.{jpg,jpeg,png,gif}'; // example glob pattern -> delete all .jpg, .jpeg, .png and .gif files
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->deleteFromGlob($globPattern); $zipFile->deleteFromGlob($globPattern);
``` ```
<a name="Documentation-ZipFile-deleteFromRegex"></a> **ZipFile::deleteFromRegex** - deletes a entries in the archive using [PCRE pattern](https://en.wikipedia.org/wiki/Regular_expression). ##### ZipFile::deleteFromRegex
Deletes a entries in the archive using [PCRE pattern](https://en.wikipedia.org/wiki/Regular_expression).
```php ```php
$regexPattern = '/\.(jpe?g|png|gif)$/si'; // example regex pattern -> delete all .jpg, .jpeg, .png and .gif files $regexPattern = '/\.(jpe?g|png|gif)$/si'; // example regex pattern -> delete all .jpg, .jpeg, .png and .gif files
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->deleteFromRegex($regexPattern); $zipFile->deleteFromRegex($regexPattern);
``` ```
<a name="Documentation-ZipFile-deleteAll"></a> **ZipFile::deleteAll** - deletes all entries in the ZIP archive. ##### ZipFile::deleteAll
Deletes all entries in the ZIP archive.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->deleteAll(); $zipFile->deleteAll();
``` ```
#### <a name="Documentation-Entries"></a> Working with entries and archive #### Working with entries and archive
<a name="Documentation-ZipFile-rename"></a> **ZipFile::rename** - renames an entry defined by its name. ##### ZipFile::rename
Renames an entry defined by its name.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->rename($oldName, $newName); $zipFile->rename($oldName, $newName);
``` ```
<a name="Documentation-ZipFile-setCompressionLevel"></a> **ZipFile::setCompressionLevel** - set the compression level for all files in the archive. ##### ZipFile::setCompressionLevel
Set the compression level for all files in the archive.
> _Note that this method does not apply to entries that are added after this method is run._ > _Note that this method does not apply to entries that are added after this method is run._
@@ -570,14 +598,16 @@ The values range from 1 (`\PhpZip\Constants\ZipCompressionLevel::SUPER_FAST`) to
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->setCompressionLevel(\PhpZip\Constants\ZipCompressionLevel::MAXIMUM); $zipFile->setCompressionLevel(\PhpZip\Constants\ZipCompressionLevel::MAXIMUM);
``` ```
<a name="Documentation-ZipFile-setCompressionLevelEntry"></a> **ZipFile::setCompressionLevelEntry** - sets the compression level for the entry by its name. ##### ZipFile::setCompressionLevelEntry
Sets the compression level for the entry by its name.
The values range from 1 (`\PhpZip\Constants\ZipCompressionLevel::SUPER_FAST`) to 9 (`\PhpZip\Constants\ZipCompressionLevel::MAXIMUM`) are supported. The higher the number, the better and longer the compression. The values range from 1 (`\PhpZip\Constants\ZipCompressionLevel::SUPER_FAST`) to 9 (`\PhpZip\Constants\ZipCompressionLevel::MAXIMUM`) are supported. The higher the number, the better and longer the compression.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->setCompressionLevelEntry($entryName, \PhpZip\Constants\ZipCompressionLevel::FAST); $zipFile->setCompressionLevelEntry($entryName, \PhpZip\Constants\ZipCompressionLevel::FAST);
``` ```
<a name="Documentation-ZipFile-setCompressionMethodEntry"></a> **ZipFile::setCompressionMethodEntry** - sets the compression method for the entry by its name. ##### ZipFile::setCompressionMethodEntry
Sets the compression method for the entry by its name.
The following compression methods are available: The following compression methods are available:
- `\PhpZip\Constants\ZipCompressionMethod::STORED` - No compression - `\PhpZip\Constants\ZipCompressionMethod::STORED` - No compression
@@ -587,17 +617,20 @@ The following compression methods are available:
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->setCompressionMethodEntry($entryName, \PhpZip\Constants\ZipCompressionMethod::DEFLATED); $zipFile->setCompressionMethodEntry($entryName, \PhpZip\Constants\ZipCompressionMethod::DEFLATED);
``` ```
<a name="Documentation-ZipFile-setArchiveComment"></a> **ZipFile::setArchiveComment** - set the comment of a ZIP archive. ##### ZipFile::setArchiveComment
Set the comment of a ZIP archive.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->setArchiveComment($commentArchive); $zipFile->setArchiveComment($commentArchive);
``` ```
<a name="Documentation-ZipFile-setEntryComment"></a> **ZipFile::setEntryComment** - set the comment of an entry defined by its name. ##### ZipFile::setEntryComment
Set the comment of an entry defined by its name.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$zipFile->setEntryComment($entryName, $comment); $zipFile->setEntryComment($entryName, $comment);
``` ```
<a name="Documentation-ZipFile-matcher"></a> **ZipFile::matcher** - selecting entries in the archive to perform operations on them. ##### ZipFile::matcher
Selecting entries in the archive to perform operations on them.
```php ```php
$zipFile = new \PhpZip\ZipFile(); $zipFile = new \PhpZip\ZipFile();
$matcher = $zipFile->matcher(); $matcher = $zipFile->matcher();
@@ -651,7 +684,7 @@ $matcher->setPassword($password, $encryptionMethod); // sets a new password and
$matcher->setEncryptionMethod($encryptionMethod); // sets the encryption method to the selected entries $matcher->setEncryptionMethod($encryptionMethod); // sets the encryption method to the selected entries
$matcher->disableEncryption(); // disables encryption for selected entries $matcher->disableEncryption(); // disables encryption for selected entries
``` ```
#### <a name="Documentation-Password"></a> Working with passwords #### Working with passwords
Implemented support for encryption methods: Implemented support for encryption methods:
- `\PhpZip\Constants\ZipEncryptionMethod::PKWARE` - Traditional PKWARE encryption (legacy) - `\PhpZip\Constants\ZipEncryptionMethod::PKWARE` - Traditional PKWARE encryption (legacy)
@@ -659,17 +692,20 @@ Implemented support for encryption methods:
- `\PhpZip\Constants\ZipEncryptionMethod::WINZIP_AES_192` - WinZip AES encryption 192 bit - `\PhpZip\Constants\ZipEncryptionMethod::WINZIP_AES_192` - WinZip AES encryption 192 bit
- `\PhpZip\Constants\ZipEncryptionMethod::WINZIP_AES_128` - WinZip AES encryption 128 bit - `\PhpZip\Constants\ZipEncryptionMethod::WINZIP_AES_128` - WinZip AES encryption 128 bit
<a name="Documentation-ZipFile-setReadPassword"></a> **ZipFile::setReadPassword** - set the password for the open archive. ##### ZipFile::setReadPassword
Set the password for the open archive.
> _Setting a password is not required for adding new entries or deleting existing ones, but if you want to extract the content or change the method / compression level, the encryption method, or change the password, in this case the password must be specified._ > _Setting a password is not required for adding new entries or deleting existing ones, but if you want to extract the content or change the method / compression level, the encryption method, or change the password, in this case the password must be specified._
```php ```php
$zipFile->setReadPassword($password); $zipFile->setReadPassword($password);
``` ```
<a name="Documentation-ZipFile-setReadPasswordEntry"></a> **ZipFile::setReadPasswordEntry** - gets a password for reading of an entry defined by its name. ##### ZipFile::setReadPasswordEntry
Gets a password for reading of an entry defined by its name.
```php ```php
$zipFile->setReadPasswordEntry($entryName, $password); $zipFile->setReadPasswordEntry($entryName, $password);
``` ```
<a name="Documentation-ZipFile-setPassword"></a> **ZipFile::setPassword** - sets a new password for all files in the archive. ##### ZipFile::setPassword
Sets a new password for all files in the archive.
> _Note that this method does not apply to entries that are added after this method is run._ > _Note that this method does not apply to entries that are added after this method is run._
```php ```php
@@ -680,7 +716,8 @@ You can set the encryption method:
$encryptionMethod = \PhpZip\Constants\ZipEncryptionMethod::WINZIP_AES_256; $encryptionMethod = \PhpZip\Constants\ZipEncryptionMethod::WINZIP_AES_256;
$zipFile->setPassword($password, $encryptionMethod); $zipFile->setPassword($password, $encryptionMethod);
``` ```
<a name="Documentation-ZipFile-setPasswordEntry"></a> **ZipFile::setPasswordEntry** - sets a new password of an entry defined by its name. ##### ZipFile::setPasswordEntry
Sets a new password of an entry defined by its name.
```php ```php
$zipFile->setPasswordEntry($entryName, $password); $zipFile->setPasswordEntry($entryName, $password);
``` ```
@@ -689,45 +726,54 @@ You can set the encryption method:
$encryptionMethod = \PhpZip\Constants\ZipEncryptionMethod::WINZIP_AES_256; $encryptionMethod = \PhpZip\Constants\ZipEncryptionMethod::WINZIP_AES_256;
$zipFile->setPasswordEntry($entryName, $password, $encryptionMethod); $zipFile->setPasswordEntry($entryName, $password, $encryptionMethod);
``` ```
<a name="Documentation-ZipFile-disableEncryption"></a> **ZipFile::disableEncryption** - disable encryption for all entries that are already in the archive. ##### ZipFile::disableEncryption
Disable encryption for all entries that are already in the archive.
> _Note that this method does not apply to entries that are added after this method is run._ > _Note that this method does not apply to entries that are added after this method is run._
```php ```php
$zipFile->disableEncryption(); $zipFile->disableEncryption();
``` ```
<a name="Documentation-ZipFile-disableEncryptionEntry"></a> **ZipFile::disableEncryptionEntry** - disable encryption of an entry defined by its name. ##### ZipFile::disableEncryptionEntry
Disable encryption of an entry defined by its name.
```php ```php
$zipFile->disableEncryptionEntry($entryName); $zipFile->disableEncryptionEntry($entryName);
``` ```
#### <a name="Documentation-Unchanged"></a> Undo changes #### Undo changes
<a name="Documentation-ZipFile-unchangeAll"></a> **ZipFile::unchangeAll** - undo all changes done in the archive. ##### ZipFile::unchangeAll
Undo all changes done in the archive.
```php ```php
$zipFile->unchangeAll(); $zipFile->unchangeAll();
``` ```
<a name="Documentation-ZipFile-unchangeArchiveComment"></a> **ZipFile::unchangeArchiveComment** - undo changes to the archive comment. ##### ZipFile::unchangeArchiveComment
Undo changes to the archive comment.
```php ```php
$zipFile->unchangeArchiveComment(); $zipFile->unchangeArchiveComment();
``` ```
<a name="Documentation-ZipFile-unchangeEntry"></a> **ZipFile::unchangeEntry** - undo changes of an entry defined by its name. ##### ZipFile::unchangeEntry
Undo changes of an entry defined by its name.
```php ```php
$zipFile->unchangeEntry($entryName); $zipFile->unchangeEntry($entryName);
``` ```
#### <a name="Documentation-Save-Or-Output-Entries"></a> Saving a file or output to a browser #### Saving a file or output to a browser
<a name="Documentation-ZipFile-saveAsFile"></a> **ZipFile::saveAsFile** - saves the archive to a file. ##### ZipFile::saveAsFile
Saves the archive to a file.
```php ```php
$zipFile->saveAsFile($filename); $zipFile->saveAsFile($filename);
``` ```
<a name="Documentation-ZipFile-saveAsStream"></a> **ZipFile::saveAsStream** - writes the archive to the stream. ##### ZipFile::saveAsStream
Writes the archive to the stream.
```php ```php
// $fp = fopen($filename, 'w+b'); // $fp = fopen($filename, 'w+b');
$zipFile->saveAsStream($fp); $zipFile->saveAsStream($fp);
``` ```
<a name="Documentation-ZipFile-outputAsString"></a> **ZipFile::outputAsString** - outputs a ZIP-archive as string. ##### ZipFile::outputAsString
Outputs a ZIP-archive as string.
```php ```php
$rawZipArchiveBytes = $zipFile->outputAsString(); $rawZipArchiveBytes = $zipFile->outputAsString();
``` ```
<a name="Documentation-ZipFile-outputAsAttachment"></a> **ZipFile::outputAsAttachment** - outputs a ZIP-archive to the browser. ##### ZipFile::outputAsAttachment
Outputs a ZIP-archive to the browser.
```php ```php
$zipFile->outputAsAttachment($outputFilename); $zipFile->outputAsAttachment($outputFilename);
``` ```
@@ -736,7 +782,8 @@ You can set the Mime-Type:
$mimeType = 'application/zip'; $mimeType = 'application/zip';
$zipFile->outputAsAttachment($outputFilename, $mimeType); $zipFile->outputAsAttachment($outputFilename, $mimeType);
``` ```
<a name="Documentation-ZipFile-outputAsResponse"></a> **ZipFile::outputAsResponse** - outputs a ZIP-archive as [PSR-7 Response](http://www.php-fig.org/psr/psr-7/). ##### ZipFile::outputAsResponse
Outputs a ZIP-archive as [PSR-7 Response](http://www.php-fig.org/psr/psr-7/).
The output method can be used in any PSR-7 compatible framework. The output method can be used in any PSR-7 compatible framework.
```php ```php
@@ -748,16 +795,18 @@ You can set the Mime-Type:
$mimeType = 'application/zip'; $mimeType = 'application/zip';
$zipFile->outputAsResponse($response, $outputFilename, $mimeType); $zipFile->outputAsResponse($response, $outputFilename, $mimeType);
``` ```
<a name="Documentation-ZipFile-rewrite"></a> **ZipFile::rewrite** - save changes and re-open the changed archive. ##### ZipFile::rewrite
Save changes and re-open the changed archive.
```php ```php
$zipFile->rewrite(); $zipFile->rewrite();
``` ```
#### <a name="Documentation-Close-Zip-Archive"></a> Closing the archive #### Closing the archive
<a name="Documentation-ZipFile-close"></a> **ZipFile::close** - close the archive. ##### ZipFile::close
Close the archive.
```php ```php
$zipFile->close(); $zipFile->close();
``` ```
### <a name="Running-Tests"></a> Running the tests ### Running the tests
Install the dependencies for the development: Install the dependencies for the development:
```bash ```bash
composer install --dev composer install --dev
@@ -766,11 +815,11 @@ Run the tests:
```bash ```bash
vendor/bin/phpunit vendor/bin/phpunit
``` ```
### <a name="Changelog"></a> Changelog ### Changelog
Changes are documented in the [releases page](https://github.com/Ne-Lexa/php-zip/releases). Changes are documented in the [releases page](https://github.com/Ne-Lexa/php-zip/releases).
### <a name="Upgrade"></a> Upgrade ### Upgrade
#### <a name="Upgrade-v3-to-v4"></a> Upgrade version 3 to version 4 #### Upgrade version 3 to version 4
Update the major version in the file `composer.json` to `^4.0`. Update the major version in the file `composer.json` to `^4.0`.
```json ```json
{ {
@@ -788,7 +837,7 @@ Update your code to work with the new version:
- removed deprecated classes and methods. - removed deprecated classes and methods.
- removed `zipalign` functional. This functionality will be placed in a separate package `nelexa/apkfile`. - removed `zipalign` functional. This functionality will be placed in a separate package `nelexa/apkfile`.
#### <a name="Upgrade-v2-to-v3"></a> Upgrade version 2 to version 3.0 #### Upgrade version 2 to version 3
Update the major version in the file `composer.json` to `^3.0`. Update the major version in the file `composer.json` to `^3.0`.
```json ```json
{ {