Gzip PHP ActiveX Reference Documentation

Gzip

Current Version: 10.0.0

Requires Chilkat Bundle License

GZip compression component.

Object Creation

Chilkat v10.0.0 or greater:
$obj = new COM("Chilkat.Gzip");
Chilkat v9.5.0.*:
$obj = new COM("Chilkat_9_5_0.Gzip");

Properties

AbortCurrent

bool AbortCurrent

Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

Comment

string Comment

Specifies an optional comment string that can be embedded within the .gz when any Compress* method is called.

CompressionLevel

int CompressionLevel

Introduced in version 9.5.0.50

The compression level to be used when compressing. The default is 6, which is the typical value used for zip utility programs when compressing data. The compression level may range from 0 (no compression) to 9 (the most compression). The benefits of trying to increase compression may not be worth the added expense in compression time. In many cases (which is data dependent), the improvement in compression is minimal while the increase in computation time is significant.

DebugLogFilePath

string DebugLogFilePath

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
there is an internal problem (bug) in the Chilkat code that causes the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

ExtraData

VARIANT ExtraData

Optional extra-data that can be included within a .gz when a Compress* method is called.

Filename

string Filename

The filename that is embedded within the .gz during any Compress* method call. When extracting from a .gz using applications such as WinZip, this will be the filename that is created.

LastBinaryResult

VARIANT LastBinaryResult (read-only)

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to true. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

LastErrorHtml

string LastErrorHtml (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText

string LastErrorText (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

string LastErrorXml (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastMethodSuccess

bool LastMethodSuccess

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

Any method that returns a string.
Any method returning a Chilkat object, binary bytes, or a date/time.
Any method returning a standard boolean status value where success = true and failure = false.
Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastModStr

string LastModStr

The same as the LastMod property, but allows the date/time to be get/set in RFC822 string format.

LastStringResult

string LastStringResult (read-only)

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to true. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

int LastStringResultLen (read-only)

The length, in characters, of the string contained in the LastStringResult property.

UseCurrentDate

bool UseCurrentDate

If set to true, the file produced by an Uncompress* method will use the current date/time for the last-modification date instead of the date/time found within the Gzip format.

VerboseLogging

bool 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

string Version (read-only)

Version of the component/library, such as "9.5.0.94"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

CompressBd

bool CompressBd(Chilkat.BinData binDat)

Introduced in version 9.5.0.67

In-place gzip the contents of binDat.

Returns true for success, false for failure.

More Information and Examples

Gzip Compress In Memory and Base64 Encode

CompressBdAsync ⁽¹⁾

Chilkat.Task CompressBdAsync(Chilkat.BinData binDat)

Introduced in version 9.5.0.67

Creates an asynchronous task to call the CompressBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

CompressFile

bool CompressFile(string inFilename, string destPath)

Compresses a file to create a GZip compressed file (.gz).

Returns true for success, false for failure.

More Information and Examples

CompressFileAsync ⁽¹⁾

Chilkat.Task CompressFileAsync(string inFilename, string destPath)

Creates an asynchronous task to call the CompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

CompressFile2

bool CompressFile2(string inFilename, string embeddedFilename, string destPath)

Compresses a file to create a GZip compressed file (.gz). inFilename is the actual filename on disk. embeddedFilename is the filename to be embedded in the .gz such that when it is un-gzipped, this is the name of the file that will be created.

Returns true for success, false for failure.

More Information and Examples

CompressFile2Async ⁽¹⁾

Chilkat.Task CompressFile2Async(string inFilename, string embeddedFilename, string destPath)

Creates an asynchronous task to call the CompressFile2 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

CompressFileToMem

VARIANT CompressFileToMem(string inFilename)

Gzip compresses a file to an in-memory image of a .gz file.

Note: There is a 4GB size limitation. The compressed size of the file cannot be more than 4GB. Chilkat will be working to alleviate this limitation in the future.

Returns null on failure

CompressFileToMemAsync ⁽¹⁾

Chilkat.Task CompressFileToMemAsync(string inFilename)

Creates an asynchronous task to call the CompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

CompressMemory

VARIANT CompressMemory(VARIANT inData)

Compresses in-memory data to an in-memory image of a .gz file.

Note: There is a 4GB uncompressed size limitation. The uncompressed size of the file cannot be more than 4GB. Chilkat will be working to alleviate this limitation in the future.

Returns null on failure

CompressMemoryAsync ⁽¹⁾

Chilkat.Task CompressMemoryAsync(VARIANT inData)

Creates an asynchronous task to call the CompressMemory method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

CompressMemToFile

bool CompressMemToFile(VARIANT inData, string destPath)

Gzip compresses and creates a .gz file from in-memory data.

Returns true for success, false for failure.

CompressMemToFileAsync ⁽¹⁾

Chilkat.Task CompressMemToFileAsync(VARIANT inData, string destPath)

Creates an asynchronous task to call the CompressMemToFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

CompressString

VARIANT CompressString(string inStr, string destCharset)

Gzip compresses a string and writes the output to a byte array. The string is first converted to the charset specified by destCharset. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc.

Returns null on failure

More Information and Examples

Full List of Charset Names

CompressStringAsync ⁽¹⁾

Chilkat.Task CompressStringAsync(string inStr, string destCharset)

Creates an asynchronous task to call the CompressString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

CompressStringENC

string CompressStringENC(string inStr, string charset, string encoding)

The same as CompressString, except the binary output is returned in encoded string form according to the encoding. The encoding can be any of the following: "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

Returns null on failure

CompressStringToFile

bool CompressStringToFile(string inStr, string destCharset, string destPath)

Gzip compresses a string and writes the output to a .gz compressed file. The string is first converted to the charset specified by destCharset. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc.

Returns true for success, false for failure.

More Information and Examples

Full List of Charset Names

CompressStringToFileAsync ⁽¹⁾

Chilkat.Task CompressStringToFileAsync(string inStr, string destCharset, string destPath)

Creates an asynchronous task to call the CompressStringToFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

Decode

VARIANT Decode(string encodedStr, string encoding)

Decodes an encoded string and returns the original data. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url".

Returns null on failure

DeflateStringENC

string DeflateStringENC(string inString, string charsetName, string outputEncoding)

Provides the ability to use the zip/gzip's deflate algorithm directly to compress a string. Internal to this method, inString is first converted to the charset specified by charsetName. The data is then compressed using the deflate compression algorithm. The binary output is then encoded according to outputEncoding. Possible values for outputEncoding are "hex", "base64", "url", and "quoted-printable".

Note: The output of this method is compressed data with no Gzip file format. Use the Compress* methods to produce Gzip file format output.

Returns null on failure

More Information and Examples

Full List of Charset Names

Encode

string Encode(VARIANT byteData, string encoding)

Encodes binary data to a printable string. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url".

Returns null on failure

ExamineFile

bool ExamineFile(string inGzFilename)

Determines if the inGzFilename is a Gzip formatted file. Returns true if it is a Gzip formatted file, otherwise returns false.

ExamineMemory

bool ExamineMemory(VARIANT inGzData)

Determines if the in-memory bytes (inGzData) contain a Gzip formatted file. Returns true if it is Gzip format, otherwise returns false.

GetDt

Chilkat.CkDateTime GetDt()

Gets the last-modification date/time to be embedded within the .gz.

Returns null on failure

InflateStringENC

string InflateStringENC(string inString, string convertFromCharset, string inputEncoding)

This the reverse of DeflateStringENC.

The input string is first decoded according to inputEncoding. (Possible values for inputEncoding are "hex", "base64", "url", and "quoted-printable".) The compressed data is then inflated, and the result is then converted from convertFromCharset (if necessary) to return a string.

Returns null on failure

LoadTaskCaller

bool LoadTaskCaller(Chilkat.Task task)

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

ReadFile

VARIANT ReadFile(string path)

Reads a binary file into memory and returns the byte array. Note: This method does not parse a Gzip, it is only a convenience method for reading a binary file into memory.

Returns null on failure

SetDt

bool SetDt(Chilkat.CkDateTime dt)

Sets the last-modification date/time to be embedded within the .gz when a Compress* method is called. If not explicitly set, the current system date/time is used.

Returns true for success, false for failure.

UncompressBd

bool UncompressBd(Chilkat.BinData binDat)

Introduced in version 9.5.0.67

In-place ungzip the contents of binDat.

Returns true for success, false for failure.

UncompressBdAsync ⁽¹⁾

Chilkat.Task UncompressBdAsync(Chilkat.BinData binDat)

Introduced in version 9.5.0.67

Creates an asynchronous task to call the UncompressBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

UncompressFile

bool UncompressFile(string srcPath, string destPath)

Un-Gzips a .gz file. The output filename is specified by the 2nd argument and not by the filename embedded within the .gz.

Returns true for success, false for failure.

More Information and Examples

GZip Decompress File

UncompressFileAsync ⁽¹⁾

Chilkat.Task UncompressFileAsync(string srcPath, string destPath)

Creates an asynchronous task to call the UncompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

UncompressFileToMem

VARIANT UncompressFileToMem(string inFilename)

Un-Gzips a .gz file directly to memory.

Note: There is a 4GB uncompressed size limitation. The uncompressed size of the file cannot be more than 4GB. Chilkat will be working to alleviate this limitation in the future.

Returns null on failure

UncompressFileToMemAsync ⁽¹⁾

Chilkat.Task UncompressFileToMemAsync(string inFilename)

Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

UncompressFileToString

string UncompressFileToString(string gzFilename, string charset)

Uncompresses a .gz file that contains a text file. The contents of the text file are returned as a string. The character encoding of the text file is specified by charset. Typical charsets are "iso-8859-1", "utf-8", "windows-1252", "shift_JIS", "big5", etc.

Returns null on failure

More Information and Examples

List of Valid Charsets

UncompressFileToStringAsync ⁽¹⁾

Chilkat.Task UncompressFileToStringAsync(string gzFilename, string charset)

Creates an asynchronous task to call the UncompressFileToString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

UncompressMemory

VARIANT UncompressMemory(VARIANT inData)

Un-Gzips from an in-memory image of a .gz file directly into memory.

Note: There is a 4GB uncompressed size limitation. The uncompressed size of the file cannot be more than 4GB. Chilkat will be working to alleviate this limitation in the future.

Returns null on failure

UncompressMemoryAsync ⁽¹⁾

Chilkat.Task UncompressMemoryAsync(VARIANT inData)

Creates an asynchronous task to call the UncompressMemory method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

UncompressMemToFile

bool UncompressMemToFile(VARIANT inData, string destPath)

Un-Gzips from an in-memory image of a .gz file to a file.

Returns true for success, false for failure.

UncompressMemToFileAsync ⁽¹⁾

Chilkat.Task UncompressMemToFileAsync(VARIANT inData, string destPath)

Creates an asynchronous task to call the UncompressMemToFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

UncompressString

string UncompressString(VARIANT inData, string inCharset)

The reverse of CompressString.

The bytes in inData are uncompressed, then converted from inCharset (if necessary) to return a string.

Returns null on failure

More Information and Examples

Full List of Charset Names

UncompressStringAsync ⁽¹⁾

Chilkat.Task UncompressStringAsync(VARIANT inData, string inCharset)

Creates an asynchronous task to call the UncompressString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

UncompressStringENC

string UncompressStringENC(string inStr, string charset, string encoding)

The same as UncompressString, except the compressed data is provided in encoded string form based on the value of encoding. The encoding can be "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

Returns null on failure

UnTarGz

bool UnTarGz(string tgzFilename, string destDir, bool bNoAbsolute)

Unpacks a .tar.gz file. The ungzip and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring. bNoAbsolute may be true or false. A value of true protects from untarring to absolute paths. (For example, imagine the trouble if the tar contains files with absolute paths beginning with /Windows/system32)

Returns true for success, false for failure.

UnTarGzAsync ⁽¹⁾

Chilkat.Task UnTarGzAsync(string tgzFilename, string destDir, bool bNoAbsolute)

Creates an asynchronous task to call the UnTarGz method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

WriteFile

bool WriteFile(string path, VARIANT binaryData)

A convenience method for writing a binary byte array to a file.

Returns true for success, false for failure.

XfdlToXml

string XfdlToXml(string xfldData)

Converts base64-gzip .xfdl data to a decompressed XML string. The xfldData contains the base64 data. This method returns the decoded/decompressed XML string.

Returns null on failure