Download the PHP package verseles/sevenzip without Composer
On this page you can find all versions of the php package verseles/sevenzip. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download verseles/sevenzip
More information about verseles/sevenzip
Files in verseles/sevenzip
Package sevenzip
Short Description A package to compress and decompress files using 7zip
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sevenzip
SevenZip 🔧
A PHP package to compress and decompress files using 7zip CLI.
Installation
Install the package via Composer:
Usage
Compression
To compress a file or directory:
Compression Options
- Format: You can set the compression format using the
format()method. Well known formats include7z,zip,tar,lz4,lz5,bzip2, andzstd. Your OS needs to support the selected format. - Compression Level: You can adjust the compression level using the
faster(),slower(),mx(), andultra()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 withtar.will automatically enabletarBefore(). To disable add->forceTarBefore(false)
Extraction
To extract an archive:
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
You can encrypt the compressed archive using a password:
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:
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'.
Decryption
To decrypt an encrypted archive during extraction:
Including and Excluding Files
SevenZip allows you to include or exclude specific files when compressing or extracting archives.
Including Files
To include specific files in the archive, use the include method:
Excluding Files
To exclude specific files from the archive, use the exclude method:
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
excludeandincludemethods.
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:
TODO / WIP
- [x] Full support for add flags (7z switches)
- [x] Add custom support for gz, xz, etc. by using tar flags
- [x] Use tar to keep original file permissions and other attributes
- [x] Auto untar on extraction
- [x] Filter files by patterns
- [x] Encrypt and decrypt
- [ ] Test files using 7z test command
- [x] Detect supported formats by the OS
- [x] Add built-in binaries for mac and linux
- [x]
Use docker for PHPUnit testsnot needed with built-in binaries - [ ] Use native zstd, brotli, and others as fallback for these formats
Contributing
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
- Fork the repository
- Create a new branch for your feature or bug fix
- Make your changes and commit them with descriptive commit messages
- Push your changes to your forked repository
- 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
To run the tests, execute the following command:
Documentation / API
Here is the Documentation / API section of the README, updated with missing public methods and ordered alphabetically:
Documentation / API
addFlag(string $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
checkSupport(string|array $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
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
copy(): static
Configures no compression (copy only) settings based on the specified format.
Returns: The current instance for method chaining.
decrypt(string $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
Encrypts the data using the provided password.
Parameters
$password: The password to encrypt the data.
Returns: The current instance of this class.
extract(): string
Extracts an archive.
Returns: the command output on success.
Throws
InvalidArgumentException: If format, archive path, or extract path is not set.
Example
faster(): static
Sets the compression level to faster.
Returns: The current instance of the SevenZip class.
deleteSourceAfterExtract(bool $delete = true): self
Sets whether to delete the source archive after successful extraction.
Parameters
$delete: Whether to delete the source archive after extraction. Default istrue.
Returns: The current instance of the SevenZip class.
Example
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
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
flagrize(array $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
format(string $format): static
Sets the archive format.
Parameters
$format: The compression format to be used.
Returns: The current instance of the SevenZip class.
Example
getCustomFlags(): array
Gets the custom compression flags.
Returns: The custom compression flags that have been added.
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
Gets the archive format.
Returns: The compression format to be used.
getInfo()
Returns information about 7-Zip, formats, codecs, and hashers.
Returns: The output from the 7-Zip command.
getLastProgress(): int
Gets the last reported progress.
Returns: The last reported progress percentage.
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
Gets the path to the 7-Zip executable file.
Returns: Path to the 7-Zip executable file.
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
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
getTargetPath(): string
Gets the target path for compression/extraction.
Returns: The path to the target file or directory for compression or extraction.
getZipEncryptionMethod(): string
Gets the encryption method used for ZIP archives.
Returns: The encryption method used for ZIP archives.
exclude(string|array $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
include(string|array $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
info(): void
Prints the information about 7-Zip, formats, codecs, and hashers.
md(string $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
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
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
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
mmt(int|bool|string $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
m0($method): 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
Sets the number of passes for compression.
Parameters
$number: The number of passes for compression.
Returns: The current instance of the SevenZip class.
Example
ms(bool|string|int $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
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
myx(int $level = 5): self
Sets the file analysis level.
Parameters
$level: The file analysis level.
Returns: The current instance of the SevenZip class.
notEncryptNames(): self
Disables encryption of file names.
Returns: The current instance of the SevenZip class.
progress(callable $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
removeFlag(string $flag): self
Removes a compression flag.
Parameters
$flag: The compression flag to be removed.
Returns: The current instance of the SevenZip class.
reset(): SevenZip
Resets the property values to their original state.
Returns: The current instance of the SevenZip class.
setCustomFlags(array $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
setEncryptNames(bool $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
Sets the archive format.
Parameters
$format: The compression format to be used.
Returns: The current instance of the SevenZip class.
Example
setPassword(?string $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
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
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
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
setTargetPath(string $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
setZipEncryptionMethod(string $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
Sets the compression level to slower.
Returns: The current instance of the SevenZip class.
source(string $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
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
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 istrue.
Returns: The current instance of the SevenZip class.
Example
forceTarBefore(bool $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
setTarKeepFileInfo(bool $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
shouldForceTarBefore(): bool
Gets whether forcing tar before compression is enabled.
Returns: Whether forcing tar before compression is enabled.
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
Checks if the source has already been tarred.
Returns: Whether the source has already been tarred.
ultra(): self
Configures maximum compression settings based on the specified format.
Returns: The current instance for method chaining.
License
This package is open-sourced software licensed under the MIT license.
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.
