PHPackages verseles/sevenzip - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [File & Storage](/categories/file-storage) 4. / 5. verseles/sevenzip ActiveLibrary[File & Storage](/categories/file-storage) verseles/sevenzip ================= A package to compress and decompress files using 7zip v2.0.1(11mo ago)191.7k↓50%[1 PRs](https://github.com/verseles/SevenZip/pulls)MITPHPPHP >=8.2CI failing Since Mar 25Pushed 1mo ago1 watchersCompare [ Source](https://github.com/verseles/SevenZip)[ Packagist](https://packagist.org/packages/verseles/sevenzip)[ RSS](/packages/verseles-sevenzip/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (2)Versions (27)Used By (0) SevenZip πŸ”§ ========== [](#sevenzip-) A PHP package to compress and decompress files using 7zip CLI. [![GitHub Actions Workflow Status](https://camo.githubusercontent.com/5e7774db751f3ca4d8e1521159f86a2b18f86b431473ffb7d19d071bfe252041/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f76657273656c65732f536576656e5a69702f706870756e69742e796d6c3f7374796c653d666f722d7468652d6261646765266c6162656c3d504850556e6974)](https://camo.githubusercontent.com/5e7774db751f3ca4d8e1521159f86a2b18f86b431473ffb7d19d071bfe252041/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f76657273656c65732f536576656e5a69702f706870756e69742e796d6c3f7374796c653d666f722d7468652d6261646765266c6162656c3d504850556e6974) Installation ------------ [](#installation) Install the package via Composer: ``` composer require verseles/sevenzip ``` ️Star the project to help us reach move devs!️ Usage ----- [](#usage) ### Compression [](#compression) To compress a file or directory: ``` $sevenZip = new SevenZip(); $sevenZip->format('7z') ->source('/path/to/source/file/or/directory') ->target('/path/to/archive.7z') ->compress(); ``` #### Compression Options [](#compression-options) - **Format**: You can set the compression format using the `format()` method. Well known formats include `7z`, `zip`, `tar`, `lz4`, `lz5`, `bzip2`, and `zstd`. Your OS needs to support the selected format. - **Compression Level**: You can adjust the compression level using the `faster()`, `slower()`, `mx()`, and `ultra()` methods. - **Custom Flags**: You can add custom compression flags using the `addFlag()` method. - **Progress Callback**: You can set a progress callback using the `progress()` method to monitor the compression progress. - **Tar Before**: You can enable option to create a tar archive before compressing using the `tarBefore()` method. This is useful for preserving file permissions and attributes. Warning The format support depends on your system, architecture, etc. You can always use `format()` method to set your custom format. > Any set `format()` which starts with `tar.` will automatically enable `tarBefore()`. To disable add `->forceTarBefore(false)` ### Extraction [](#extraction) To extract an archive: ``` $sevenZip = new SevenZip(); $sevenZip->source('/path/to/archive.7z') ->target('/path/to/extract/directory') ->extract(); ``` > If the extracted file is a single tar archive, it will be extracted and the tar file deleted. To avoid this behavior, add `->autoUntar(false)` ### Encryption [](#encryption) You can encrypt the compressed archive using a password: ``` $sevenZip = new SevenZip(); $sevenZip->source('/path/to/source/file/or/directory') ->target('/path/to/encrypted_archive.7z') ->encrypt('your_password') ->compress(); ``` By default, the file names are also encrypted (not possible in zip format). If you want to disable file name encryption, you can use the `notEncryptNames()` method: ``` $sevenZip->notEncryptNames(); ``` For ZIP archives, you can specify the encryption method using the `setZipEncryptionMethod()` method. Available options are 'ZipCrypto' (not secure), ' AES128', 'AES192', or 'AES256'. The default is 'AES256'. ``` $sevenZip->setZipEncryptionMethod('AES256'); ``` ### Decryption [](#decryption) To decrypt an encrypted archive during extraction: ``` $sevenZip = new SevenZip(); $sevenZip->source('/path/to/encrypted_archive.7z') ->target('/path/to/extract/directory') ->decrypt('your_password') ->extract(); ``` Including and Excluding Files ----------------------------- [](#including-and-excluding-files) SevenZip allows you to include or exclude specific files when compressing or extracting archives. ### Including Files [](#including-files) To include specific files in the archive, use the `include` method: ``` $sevenZip->include('*.avg')->compress(); ``` ### Excluding Files [](#excluding-files) To exclude specific files from the archive, use the `exclude` method: ``` $sevenZip->exclude(['*.md', '*.pdf'])->compress(); ``` Note that you can use both `include` and `exclude` methods together to fine-tune the files included in the archive. > You can pass a single file pattern, an array of file patterns or the path to a txt file with a list of patterns inside to the `exclude`and `include` methods. ### Checking format support [](#checking-format-support) You can check if a specific format or multiple formats are supported by the current 7-Zip installation using the checkSupport method: ``` $sevenZip = new SevenZip(); // Check if a single format is supported if ($sevenZip->checkSupport('zip')) { echo "ZIP format is supported."; } else { echo "ZIP format is not supported."; } // Check if multiple formats are supported if ($sevenZip->checkSupport(['zip', 'tar', '7z'])) { echo "ZIP, TAR, and 7Z formats are supported."; } else { echo "One or more formats are not supported."; } ``` TODO / WIP ---------- [](#todo--wip) - Full support for add flags (7z switches) - Add custom support for gz, xz, etc. by using tar flags - Use tar to keep original file permissions and other attributes - Auto untar on extraction - Filter files by patterns - Encrypt and decrypt - Test files using 7z test command - Detect supported formats by the OS - Add built-in binaries for mac and linux - Use docker for PHPUnit tests not needed with built-in binaries - Use native zstd, brotli, and others as fallback for these formats Contributing ------------ [](#contributing) Contributions are welcome! If you'd like to contribute to this project, please follow these steps: 1. Fork the repository 2. Create a new branch for your feature or bug fix 3. Make your changes and commit them with descriptive commit messages 4. Push your changes to your forked repository 5. Submit a pull request to the main repository Please ensure that your code follows the project's coding style and conventions. Also, include appropriate tests for your changes. Testing ------- [](#testing) To run the tests, execute the following command: ``` composer test ``` Documentation / API =================== [](#documentation--api) Here is the Documentation / API section of the README, updated with missing public methods and ordered alphabetically: Documentation / API =================== [](#documentation--api-1) ### `addFlag(string $flag, $value = null): static` [](#addflagstring-flag-value--null-static) Adds a compression flag. **Parameters** - `$flag`: The compression flag to be added. - `$value` (optional): The value for the flag. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->addFlag('mfb', 64); ``` ### `checkSupport(string|array $extensions): bool` [](#checksupportstringarray-extensions-bool) Checks if the given extension(s) are supported by the current 7-Zip installation. **Parameters** - `$extensions`: The extension or an array of extensions to check. **Returns**: Returns true if all the given extensions are supported, false otherwise. **Example** ``` $sevenZip = new SevenZip(); // Check if a single format is supported $isZipSupported = $sevenZip->checkSupport('zip'); // Check if multiple formats are supported $areFormatsSupported = $sevenZip->checkSupport(['zip', 'tar', '7z']); ``` ### `compress(): string` [](#compress-string) Compresses a file or directory. **Returns**: the command output on success. **Throws** - `InvalidArgumentException`: If target path, or source path is not set. **Example** ``` $sevenZip->compress(); ``` ### `copy(): static` [](#copy-static) Configures no compression (copy only) settings based on the specified format. **Returns**: The current instance for method chaining. ### `decrypt(string $password): self` [](#decryptstring-password-self) Decrypts the data using the provided password. **Parameters** - `$password`: The password to decrypt the data. **Returns**: The current instance of this class. ### `encrypt(string $password): self` [](#encryptstring-password-self) Encrypts the data using the provided password. **Parameters** - `$password`: The password to encrypt the data. **Returns**: The current instance of this class. ### `extract(): string` [](#extract-string) Extracts an archive. **Returns**: the command output on success. **Throws** - `InvalidArgumentException`: If format, archive path, or extract path is not set. **Example** ``` $sevenZip->extract(); ``` ### `faster(): static` [](#faster-static) Sets the compression level to faster. **Returns**: The current instance of the SevenZip class. ### `deleteSourceAfterExtract(bool $delete = true): self` [](#deletesourceafterextractbool-delete--true-self) Sets whether to delete the source archive after successful extraction. **Parameters** - `$delete`: Whether to delete the source archive after extraction. Default is `true`. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->deleteSourceAfterExtract(); ``` ### `fileInfo(): string` [](#fileinfo-string) Retrieves information about the specified archive file. **Returns**: The file information output from the 7-Zip command. **Throws** - `InvalidArgumentException`: If the archive path is not set. **Example** ``` $info = $sevenZip->fileInfo(); ``` ### `fileList(): string` [](#filelist-string) Lists the contents of the specified archive file. **Returns**: The file list output from the 7-Zip command. **Throws** - `InvalidArgumentException`: If the archive path is not set. **Example** ``` $list = $sevenZip->fileList(); ``` ### `flagrize(array $flagsAndValues): array` [](#flagrizearray-flagsandvalues-array) Formats flags and values into an array of strings suitable for passing to 7-Zip commands. **Parameters** - `$flagsAndValues`: An associative array of flags and their corresponding values. If the value is null, the flag will be added without an equal sign. **Returns**: An array of formatted flag strings. **Example** ``` $formattedFlags = $sevenZip->flagrize(['m0' => 'lzma2', 'mx' => 9]); // Output: ['-m0=lzma2', '-mx=9'] ``` ### `format(string $format): static` [](#formatstring-format-static) Sets the archive format. **Parameters** - `$format`: The compression format to be used. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->format('7z'); ``` ### `getCustomFlags(): array` [](#getcustomflags-array) Gets the custom compression flags. **Returns**: The custom compression flags that have been added. ### `getEncryptNames(): ?bool` [](#getencryptnames-bool) Gets whether or not file names are encrypted. **Returns**: Whether or not file names are encrypted, or null if not set. ### `getFormat(): string` [](#getformat-string) Gets the archive format. **Returns**: The compression format to be used. ### `getInfo()` [](#getinfo) Returns information about 7-Zip, formats, codecs, and hashers. **Returns**: The output from the 7-Zip command. ### `getLastProgress(): int` [](#getlastprogress-int) Gets the last reported progress. **Returns**: The last reported progress percentage. ### `getPassword(): ?string` [](#getpassword-string) Gets the password used for encryption or decryption. **Returns**: The password used for encryption or decryption, or null if not set. ### `getSevenZipPath(): ?string` [](#getsevenzippath-string) Gets the path to the 7-Zip executable file. **Returns**: Path to the 7-Zip executable file. ### `getSourcePath(): string` [](#getsourcepath-string) Gets the source path for compression/extraction. **Returns**: The path to the source file or directory for compression or extraction. ### `getSupportedFormatExtensions(?array $formats = null): array` [](#getsupportedformatextensionsarray-formats--null-array) Gets all supported format extensions from the given array. **Parameters** - `$formats` (optional): The array of format data. If not provided, the built-in information from 7-Zip will be used. Returns: An array of supported format extensions. **Example** ``` $sevenZip = new SevenZip(); $supportedFormats = $sevenZip->getSupportedFormatExtensions(); if (in_array('zip', $supportedFormats)) { echo "ZIP format is supported."; } else { echo "ZIP format is not supported."; } ``` ### `getTargetPath(): string` [](#gettargetpath-string) Gets the target path for compression/extraction. **Returns**: The path to the target file or directory for compression or extraction. ### `getZipEncryptionMethod(): string` [](#getzipencryptionmethod-string) Gets the encryption method used for ZIP archives. **Returns**: The encryption method used for ZIP archives. ### `exclude(string|array $patterns): self` [](#excludestringarray-patterns-self) Excludes files from the archive based on the provided patterns. **Parameters** - `$patterns`: A single file pattern, an array of file patterns, or the path to a txt file with a list of patterns. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->exclude(['*.md', '*.pdf']); ``` ### `include(string|array $patterns): self` [](#includestringarray-patterns-self) Includes only the specified files in the archive based on the provided patterns. **Parameters** - `$patterns`: A single file pattern, an array of file patterns, or the path to a txt file with a list of patterns. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->include('*.avg'); ``` ### `info(): void` [](#info-void) Prints the information about 7-Zip, formats, codecs, and hashers. ### `md(string $size = '32m'): self` [](#mdstring-size--32m-self) Sets the dictionary size for the compression algorithm. **Parameters** - `$size`: The dictionary size. **Returns**: The current instance of the SevenZip class. ### `mfb(int $bytes = 64): self` [](#mfbint-bytes--64-self) Sets the size of the Fast Bytes for the compression algorithm. **Parameters** - `$bytes`: The size of the Fast Bytes. The default value (when set) is 64. **Returns**: The current instance of the SevenZip class. ### `mm(string $method): self` [](#mmstring-method-self) Sets the compression method for ZIP format. **Parameters** - `$method`: The compression method to be used. Can be 'Copy', 'Deflate', 'Deflate64', 'BZip2', 'LZMA', 'PPMd'. **Returns**: The current instance of the SevenZip class. ### `mmem(int|string $size = 24): static` [](#mmemintstring-size--24-static) Sets the memory limit for compression. **Parameters** - `$size`: The memory limit in megabytes or as a string (e.g., '32m'). **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->mmem(32); // Set memory limit to 32 MB ``` ### `mmt(int|bool|string $threads = 'on'): self` [](#mmtintboolstring-threads--on-self) Sets the number of CPU threads to use for compression. **Parameters** - `$threads`: The number of CPU threads to use, or 'on' or 'off'. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->mmt('on'); // Use all available CPU threads $sevenZip->mmt(4); // Use 4 CPU threads ``` ### `m0($method): self` [](#m0method-self) Sets the compression method. **Parameters** - `$method`: The compression method to be used. **Returns**: The current instance of the SevenZip class. ### `mpass(int $number = 7): self` [](#mpassint-number--7-self) Sets the number of passes for compression. **Parameters** - `$number`: The number of passes for compression. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->mpass(15); // Use 15 compression passes ``` ### `ms(bool|string|int $on = true): self` [](#msboolstringint-on--true-self) Enables or disables solid compression mode. **Parameters** - `$on`: Whether to enable or disable solid compression mode. Can be a boolean, 'on', or 'off'. **Returns**: The current instance of the SevenZip class. ### `mx(int $level): static` [](#mxint-level-static) Sets the compression level using the `-mx` flag. **Parameters** - `$level`: The compression level to be used. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->mx(9); // Maximum compression ``` ### `myx(int $level = 5): self` [](#myxint-level--5-self) Sets the file analysis level. **Parameters** - `$level`: The file analysis level. **Returns**: The current instance of the SevenZip class. ### `notEncryptNames(): self` [](#notencryptnames-self) Disables encryption of file names. **Returns**: The current instance of the SevenZip class. ### `progress(callable $callback): self` [](#progresscallable-callback-self) Sets the progress callback using a fluent interface. **Parameters** - `$callback`: The callback function to be called during the compression progress. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->progress(function ($progress) { echo "Progress: {$progress}%\n"; }); ``` ### `removeFlag(string $flag): self` [](#removeflagstring-flag-self) Removes a compression flag. **Parameters** - `$flag`: The compression flag to be removed. **Returns**: The current instance of the SevenZip class. ### `reset(): SevenZip` [](#reset-sevenzip) Resets the property values to their original state. **Returns**: The current instance of the SevenZip class. ### `setCustomFlags(array $customFlags): SevenZip` [](#setcustomflagsarray-customflags-sevenzip) Sets the custom compression flags. **Parameters** - `$customFlags`: The custom compression flags to be used. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->setCustomFlags(['mx' => 9, 'mfb' => 64]); ``` ### `setEncryptNames(bool $encryptNames): self` [](#setencryptnamesbool-encryptnames-self) Sets whether or not to encrypt file names. **Parameters** - `$encryptNames`: Whether or not to encrypt file names. **Returns**: The current instance of the SevenZip class. ### `setFormat(string $format): self` [](#setformatstring-format-self) Sets the archive format. **Parameters** - `$format`: The compression format to be used. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->setFormat('zip'); ``` ### `setPassword(?string $password): self` [](#setpasswordstring-password-self) Sets the password for encryption or decryption. **Parameters** - `$password`: The password to be used for encryption or decryption. **Returns**: The current instance of the SevenZip class. ### `setProgressCallback(callable $callback): self` [](#setprogresscallbackcallable-callback-self) Sets the progress callback. **Parameters** - `$callback`: The callback function to be called during the compression progress. **Returns**: The current instance of the SevenZip class. ### `setSevenZipPath(string $sevenZipPath): SevenZip` [](#setsevenzippathstring-sevenzippath-sevenzip) Sets the path to the 7-Zip executable file. **Parameters** - `$sevenZipPath`: Path to the 7-Zip executable file. **Returns**: The current instance of the SevenZip class. ### `setSourcePath(string $path): static` [](#setsourcepathstring-path-static) Sets the source path for compression/extraction. **Parameters** - `$path`: The path to the source file or directory for compression or extraction. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->setSourcePath('/path/to/source/file/or/directory'); ``` ### `setTargetPath(string $path): static` [](#settargetpathstring-path-static) Sets the target path for compression/extraction. **Parameters** - `$path`: The path to the target file or directory for compression or extraction. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->setTargetPath('/path/to/archive.7z'); ``` ### `setZipEncryptionMethod(string $method): self` [](#setzipencryptionmethodstring-method-self) Sets the encryption method for ZIP archives. **Parameters** - `$method`: The encryption method to be used. Can be 'ZipCrypto' (not secure), 'AES128', 'AES192', or 'AES256'. **Returns**: The current instance of the SevenZip class. ### `slower(): static` [](#slower-static) Sets the compression level to slower. **Returns**: The current instance of the SevenZip class. ### `source(string $path): self` [](#sourcestring-path-self) Sets the source path for the compression or extraction operation. **Parameters** - `$path`: The source path. **Returns**: The current instance of the SevenZip class. ### `target(?string $path): self` [](#targetstring-path-self) Sets the target path for compression/extraction using a fluent interface. **Parameters** - `$path`: The path to the target file or directory for compression or extraction. **Returns**: The current instance of the SevenZip class. ### `tarBefore(bool $keepFileInfo = true): self` [](#tarbeforebool-keepfileinfo--true-self) Enables creating a tar archive before compressing, preserving file permissions and attributes by default. **Parameters** - `$keepFileInfo` (optional): Whether to preserve file permissions and attributes when creating the tar archive. Default is `true`. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->tarBefore(); ``` ### `forceTarBefore(bool $force): self` [](#forcetarbeforebool-force-self) Sets whether to force creating a tar archive before compressing, regardless of the format. **Parameters** - `$force`: Whether to force creating a tar archive before compressing. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->forceTarBefore(true); ``` ### `setTarKeepFileInfo(bool $keepFileInfo): self` [](#settarkeepfileinfobool-keepfileinfo-self) Sets whether to preserve file permissions and attributes when creating a tar archive before compressing. **Parameters** - `$keepFileInfo`: Whether to preserve file permissions and attributes. **Returns**: The current instance of the SevenZip class. **Example** ``` $sevenZip->keepFileInfoOnTar(false); ``` ### `shouldForceTarBefore(): bool` [](#shouldforcetarbefore-bool) Gets whether forcing tar before compression is enabled. **Returns**: Whether forcing tar before compression is enabled. ### `isTarKeepFileInfo(): bool` [](#istarkeepfileinfo-bool) Gets whether preserving file permissions and attributes when creating a tar archive is enabled. **Returns**: Whether preserving file permissions and attributes is enabled. ### `wasAlreadyTarred(): bool` [](#wasalreadytarred-bool) Checks if the source has already been tarred. **Returns**: Whether the source has already been tarred. ### `ultra(): self` [](#ultra-self) Configures maximum compression settings based on the specified format. **Returns**: The current instance for method chaining. License ------- [](#license) This package is open-sourced software licensed under the [MIT license](./LICENSE.md). > About 7zip binaries: Most of the source code is under the GNU LGPL license. The unRAR code is under a mixed license with GNU LGPL + unRAR restrictions. [Check the license for details](https://sourceforge.net/projects/sevenzip/). ### Health Score 47 β€” FairBetter than 94% of packages Maintenance74 Regular maintenance activity Popularity27 Limited adoption so far Community7 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits β€” single point of failure How is this calculated?**Maintenance (25%)** β€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** β€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** β€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** β€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~37 days Recently: every ~108 days Total 13 Last Release 337d ago Major Versions v1.8.0 β†’ v2.0.02024-05-20 ### Community Maintainers ![](https://www.gravatar.com/avatar/934b53b68624e78343e3f3367897cbaf5fb01475511a1650d2c99c972c810ec6?d=identicon)[insign](/maintainers/insign) --- Top Contributors [![insign](https://avatars.githubusercontent.com/u/1113045?v=4)](https://github.com/insign "insign (35 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/verseles-sevenzip/health.svg) ``` [![Health](https://phpackages.com/badges/verseles-sevenzip/health.svg)](https://phpackages.com/packages/verseles-sevenzip) ``` ### Alternatives [spatie/file-system-watcher Watch changes in the file system using PHP 2502.1M17](/packages/spatie-file-system-watcher) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)