https://github.com/Gemorroj/Archive7z
This library provides handling of 7z files in PHP
https://github.com/Gemorroj/Archive7z
7-zip 7z 7zip archive archiver p7zip
Last synced: 21 days ago
JSON representation
This library provides handling of 7z files in PHP
- Host: GitHub
- URL: https://github.com/Gemorroj/Archive7z
- Owner: Gemorroj
- License: lgpl-3.0
- Created: 2012-09-02T18:16:45.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-03-03T18:10:00.000Z (about 2 months ago)
- Last Synced: 2025-03-25T09:07:10.587Z (29 days ago)
- Topics: 7-zip, 7z, 7zip, archive, archiver, p7zip
- Language: PHP
- Homepage:
- Size: 4.26 MB
- Stars: 92
- Watchers: 5
- Forks: 19
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wrapper 7-zip (p7zip)
[](https://packagist.org/packages/gemorroj/archive7z)
[](https://packagist.org/packages/gemorroj/archive7z)
[](https://github.com/Gemorroj/Archive7z/actions?query=workflow%3A%22Continuous+Integration%22)
### Features:
- Supported all 7-zip formats:
- Packing / unpacking: `7z`, `XZ`, `BZIP2`, `GZIP`, `TAR`, `ZIP` and `WIM`.
- Unpacking only: `APFS`, `AR`, `ARJ`, `Base64`, `CAB`, `CHM`, `CPIO`, `CramFS`, `DMG`, `EXT`, `FAT`, `GPT`, `HFS`, `IHEX`, `ISO`, `LZH`, `LZMA`, `MBR`, `MSI`, `NSIS`, `NTFS`, `QCOW2`, `RAR`, `RPM`, `SquashFS`, `UDF`, `UEFI`, `VDI`, `VHD`, `VHDX`, `VMDK`, `XAR` and `Z`.
- List files and directories
- Get contents of any file from archive
- Delete files or directories
- Add files or directories
### Requirements:
- PHP >= 8.0.2
- allow [proc_open](https://www.php.net/proc_open) function
- for Windows: 7-zip >= 7.30 (https://www.7-zip.org/)
- for Linux/MacOs: 7-zip >= 21.01 or p7zip >= 9.38 (https://github.com/p7zip-project/p7zip)
### Installation:
```bash
composer require gemorroj/archive7z
```
### Notes:
- https://sourceforge.net/p/p7zip/discussion/383043/thread/fa143cf2/
- Correctly works only with filenames in UTF-8 encoding [#15](https://github.com/Gemorroj/Archive7z/issues/15).
### Recommendations:
Archive7z focuses on wrapping up the original 7-zip features.
But it is not always convenient to use in your application.
Therefore, we recommend that you always create your own wrapper class over Archive7z with the addition of higher-level logic.
### Example:
```php
isValid()) {
throw new \RuntimeException('Incorrect archive');
}
print_r($obj->getInfo());
/*
Archive7z\Info Object
(
[path:Archive7z\Info:private] => /full_path_to/test.7z
[type:Archive7z\Info:private] => 7z
[physicalSize:Archive7z\Info:private] => 165343
[headersSize:Archive7z\Info:private] => 241
[method:Archive7z\Info:private] => LZMA2:192k
[solid:Archive7z\Info:private] => +
[blocks:Archive7z\Info:private] => 1
[codePage:Archive7z\Info:private] =>
)
*/
// $obj->setPassword('123');
// $obj->getEntries('test', 100)
foreach ($obj->getEntries() as $entry) {
print_r($entry);
/*
Archive7z\Entry Object
(
[path:Archive7z\Entry:private] => 1.jpg
[size:Archive7z\Entry:private] => 91216
[packedSize:Archive7z\Entry:private] => 165344
[modified:Archive7z\Entry:private] => 2013-06-10 09:56:07
[created:Archive7z\Entry:private] =>
[attributes:Archive7z\Entry:private] => A
[crc:Archive7z\Entry:private] => 871345C2
[encrypted:Archive7z\Entry:private] => +
[method:Archive7z\Entry:private] => LZMA:192k 7zAES:19
[block:Archive7z\Entry:private] => 0
[comment:Archive7z\Entry:private] =>
[hostOs:Archive7z\Entry:private] =>
[characteristics:Archive7z\Entry:private] =>
[folder:Archive7z\Entry:private] =>
[archive:Archive7z\Entry:private] => MyArchive7z Object
(
[timeout:protected] => 60
[compressionLevel:protected] => 6
[overwriteMode:protected] => -aos
[outputDirectory:protected] => /path/to/custom/output/directory
[binary7z:Archive7z\Archive7z:private] => C:\Program Files\7-Zip\7z.exe
[filename:Archive7z\Archive7z:private] => s:\VCS\Git\Archive7z\tests/fixtures/testPasswd.7z
[password:Archive7z\Archive7z:private] => 123
[encryptFilenames:protected] =>
)
)
*/
if ($entry->getPath() === 'test/test.txt') {
$entry->extractTo('path_to_extract_folder/'); // extract the file
}
}
echo $obj->getContent('test/test.txt'); // show content of the file
$obj->setOutputDirectory('path_to_extract_folder/')->extract(); // extract the archive
$obj->setOutputDirectory('path_to_extract_pass_folder/')->setPassword('pass')->extractEntry('test/test.txt'); // extract the password-protected entry
$solidMode = new SolidMode();
$solidMode->setMode(SolidMode::OFF);
$obj->setSolidMode($solidMode);
$obj->addEntry(__DIR__); // add directory to the archive (include subfolders)
$obj->addEntry(__FILE__); // add file to the archive
$obj->renameEntry(__FILE__, __FILE__.'new'); // rename the file in the archive
$obj->delEntry(__FILE__.'new'); // remove the file from the archive
```