Gzip Chilkat2 PHP Reference Documentation
Gzip
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.Gzip
Compress files to
Work with byte arrays and
Compress and uncompress strings with explicit charset handling for text
data that must round-trip correctly.
Handle GZIP data represented as Base64, hex, or other supported encoded
forms when binary data must be carried as text.
Set or inspect metadata such as original filename, modified time,
comments, and extra data stored in the GZIP header.
Extract
For an extended overview, see
Gzip Class Overview.
Compress, decompress, inspect, and convert GZIP data in files or memory.
Chilkat.Gzip provides GZIP compression and decompression for
file-based and in-memory workflows. It can compress and uncompress files,
strings, byte arrays, BinData, and encoded data such as Base64
or hex. It also supports .tar.gz extraction, gzip metadata such
as original filename, timestamp, and comments, and inspection of GZIP header
information without fully expanding the compressed data.
File compression
.gz, uncompress .gz files,
and write decompressed output directly to disk.
Memory-based data
Chilkat.BinData for applications
that need compression or decompression without temporary files.
String workflows
Encoded GZIP data
GZIP metadata
Tar-gzip and XFDL
.tar.gz archives and decode XFDL content that uses
gzip-related encodings.
Gzip when the data is a single GZIP stream, a
.gz file, or a .tar.gz archive. For ZIP archives,
use Chilkat.Zip; for raw deflate or zlib-style compression, use
Chilkat.Compression.
Object Creation
use Chilkat2\Gzip;
try {
$gzip = new Gzip();
// ... use $gzip ...
} catch (\Chilkat2\Exception $e) {
echo $e->getClass(), '::', $e->getMethod(), " failed\n";
echo $e->getMessage(), "\n"; // the LastErrorText of the failed call
}Creates the object. The optional array sets properties in order, as if assigned one by one (new Gzip(['VerboseLogging' => true, 'RaiseError' => false])); an unknown or read-only name throws Error. The class is defined by the chilkat2 extension (extension=chilkat2 in php.ini): there is no PHP file to include.
There is no close(): PHP frees the object when its last reference goes (unset($gzip), $gzip = null, or the end of the function or request). Objects returned by methods are independent and freed the same way. The class may be extended (class MyGzip extends \Chilkat2\Gzip); objects cannot be cloned or serialized.
When true (the default), a method that fails throws Chilkat2\Exception. When false, it returns false (or null) instead, and the reason is in LastErrorText. Objects returned by a method inherit the value of the object that returned them.
Errors
Chilkat2\Exception extends RuntimeException: getMessage() is the failed call's full LastErrorText, getClass() its class ('Chilkat2\Gzip') and getMethod() the method name. The object remains usable. Methods that look something up and find nothing return null without throwing (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain bool, and property reads and writes do not throw for Chilkat reasons.
Misuse always throws, whatever RaiseError is: a wrong argument type is a TypeError (exact types under declare(strict_types=1)), a missing or extra argument an ArgumentCountError, a string containing a NUL byte or an out-of-range integer a ValueError, and an unknown property (properties are case-sensitive) or a write to a read-only one an Error. Named arguments work with the parameter names shown.
Strings are passed and returned as UTF-8; binary data is a PHP string of bytes. Unlocking: call (new \Chilkat2\GlobalSettings())->UnlockBundle('...') once at startup.
Properties
AbortCurrent
Set this property to true
If no method is currently running, the property is automatically reset to falsefalse
Comment
An optional comment to embed in the Gzip file when a Compress* method is called.
CompressionLevel
Controls the compression level used when creating Gzip data. The value can range from
0 to 9.
0= no compression9= maximum compression
The default value is 6, which is a typical balance between compression size and speed.
Higher levels may take significantly more CPU time while producing only slightly smaller output,
depending on the data.
DebugLogFilePath
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
Filename
The filename to embed in the Gzip file when a Compress* method is called.
Some Gzip extraction tools use this embedded filename as the default output filename.
HeartbeatMs
Specifies the interval, in milliseconds, between AbortCheck event callbacks.
These callbacks allow an application to cancel certain long-running operations before they finish.
The default value is 0, which means no AbortCheck callbacks are triggered.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LastModStr
Specifies the last-modified date/time to embed in the Gzip file when a
Compress* method is called.
The value must be provided as an RFC 822 formatted date/time string.
Example:
Sun, 12 Apr 2026 12:45:26 GMT
If this property is not set, the current system date/time is used automatically.
UseCurrentDate
Controls the last-modified date/time assigned to files created by Uncompress* methods.
When set to true
VerboseLogging
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
CompressBd
Compresses the contents of a BinData object in place, replacing the original data
with Gzip-compressed data.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
CompressFile
Compresses a file and writes the result as a Gzip file, typically with a .gz extension.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
CompressFile2
Compresses a file and writes the result as a Gzip file, while allowing a different filename to be embedded inside the Gzip data.
The inFilename parameter is the actual file on disk. The
$srcPath
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
CompressFileBd
Compresses a file and stores the resulting Gzip data in a BinData object.
The compressed output is held in memory. The maximum compressed size is 4 GB.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
CompressSb
Compresses the text contained in a StringBuilder and writes the Gzip-compressed
result to a BinData object.
Before compression, the string is converted to bytes using the specified character set, such as
utf-8, iso-8859-1, or shift_JIS.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
CompressStringENC
Compresses a string and returns the Gzip-compressed data as an encoded string.
The input string is first converted to bytes using the specified character set. The compressed
binary data is then encoded using the requested encoding, such as base64,
hex, url, base32, or quoted-printable.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
CompressStringToFile
Compresses a string and writes the resulting Gzip data to a file.
The string is first converted to bytes using the character set specified by
destCharset.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
GetGzipInfo
Retrieves metadata stored in a Gzip file and returns the information in a
JsonObject.
The metadata is returned using the following JSON structure:
{
"extraData": "AAECAw==",
"filename": "example.txt",
"comment": "This is the comment"
}
- filename – the original filename embedded in the Gzip file (if present)
- comment – an optional descriptive comment (if present)
- extraData – optional additional binary data, returned as a Base64-encoded string
Any of these fields may be omitted if they were not included when the Gzip file was created.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
GetGzipInfoBd
Retrieves metadata stored in Gzip data contained within a BinData object
and returns the information in a JsonObject.
The metadata is returned using the same JSON structure:
{
"extraData": "AAECAw==",
"filename": "example.txt",
"comment": "This is the comment"
}
- filename – the original filename embedded in the Gzip data (if present)
- comment – an optional descriptive comment (if present)
- extraData – optional additional binary data, returned as a Base64-encoded string
Any of these fields may be omitted if they were not included when the Gzip data was created.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
IsGzip
Checks whether the data contained in a BinData object is in Gzip format.
Returns truefalse
Never throws: false is an answer, not a failure.
SetDt
Sets the last-modified date/time to embed in the Gzip file when a Compress*
method is called.
If no date/time is explicitly set, the current system date/time is used.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
SetExtraData
Sets optional extra binary data to include in the Gzip header when a Compress*
method is called.
The data is passed as an encoded string. Supported encodings include base64,
hex, ascii, and many others.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
UncompressBd
Decompresses Gzip data contained in a BinData object in place, replacing the
compressed data with the uncompressed data.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
UncompressBdToFile
Decompresses Gzip data stored in a BinData object and writes the result to a file.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
UncompressFile
Decompresses a Gzip file and writes the result to the specified output path.
The output filename is provided by the caller. The filename embedded in the Gzip data is not used.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
UncompressFileToString
Decompresses a Gzip file that contains text and returns the uncompressed text as a string.
The charset parameter specifies the character encoding of the uncompressed text,
such as utf-8, iso-8859-1, windows-1252,
shift_JIS, big5, etc.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
UncompressStringENC
Decompresses Gzip data provided as an encoded string and returns the uncompressed result as text.
The input string is first decoded using the specified encoding, such as base64,
hex, url, base32, quoted-printable, etc. The decoded
Gzip data is then decompressed and converted to text using the specified character set.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
UnTarGz
Extracts a .tar.gz archive to a directory.
The Gzip decompression and TAR extraction are performed in streaming mode. No temporary files are created, and memory usage remains small and constant.
If bNoAbsolute is true
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
XfdlToXml
Converts encoded and compressed XFDL data to a decompressed XML string.
XFDL data is often stored in an ASCII-safe compressed form, such as
asci-gzip or asc-gzip. Despite the name, this does not always mean
the data is a standard .gz file. In some XFDL files, the compressed payload uses
the raw deflate format rather than the full Gzip file format.
Chilkat automatically detects the actual encoding and compression format used by the XFDL data. It decodes the ASCII/Base64 representation, determines whether the compressed data is Gzip or deflate, decompresses it correctly, and returns the resulting XML string.
This allows applications to call XfdlToXml without needing to manually distinguish
between XFDL variants such as Base64+Gzip and Base64+Deflate.
Returns the decoded and decompressed XML string.
XFDL (Extensible Forms Description Language) is an XML-based format used to define secure, interactive electronic forms—often including digital signatures and integrity protections—commonly used in government and enterprise applications.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
Events
All Chilkat methods are synchronous: the call returns when the work is done. During a long-running call, Gzip reports progress to handlers installed with three methods, each taking any PHP callable (a closure, an arrow function, $this->method(...), an invokable object) and returning the object, so the calls chain:
$gzip->onPercentDone(function (int $pctDone): bool {
echo "$pctDone%\n";
return false; // return true to abort the method in progress
})
->onProgressInfo(function (string $name, string $value): void {
echo "$name: $value\n";
});
$gzip->HeartbeatMs = 250; // the AbortCheck handler is called 4 times per secondEach installs the handler for one event, replacing the one installed before; null removes it. A callable that does not exist is a TypeError right away.
The AbortCheck handler is called at the interval set by the HeartbeatMs property (0, the default, disables it); PercentDone is called when an operation's completion percentage is known; ProgressInfo delivers named progress values. A truthy return from the AbortCheck or PercentDone handler aborts the running method, which then fails in the usual way (Chilkat2\Exception, or false / null with RaiseError off). PHP's set_time_limit() does not interrupt a Chilkat call; an AbortCheck handler is how a script enforces its own limit.
Handlers run during the method call, in the same request. Inside a handler, the object's properties (such as $gzip->AbortCurrent = true) and other objects may be used, but calling a method of the same object throws Error. An exception thrown by a handler aborts the running method and propagates from it; the object remains usable. A closure that captures $gzip itself makes a reference cycle, which PHP's cycle collector frees.
AbortCheck
public function onAbortCheck(?callable $callback): static
Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.
Example
$deadline = microtime(true) + 30; // give up after 30 seconds
$gzip->HeartbeatMs = 250; // call the handler 4 times per second
$gzip->onAbortCheck(fn(): bool => microtime(true) > $deadline);PercentDone
public function onPercentDone(?callable $callback): static
This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).
The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.
To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.
Example
$gzip->onPercentDone(function (int $pctDone): bool {
// $pctDone ranges from 0 to 100.
echo "Percent done: $pctDone\n";
return false; // return true to abort the method in progress
});ProgressInfo
public function onProgressInfo(?callable $callback): static
This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.
Note: Some Chilkat methods don't fire any ProgressInfo events.
Example
$gzip->onProgressInfo(function (string $name, string $value): void {
echo "$name: $value\n";
});