CkGzip PHP Extension Reference Documentation

CkGzip

GZip compression component.

Object Creation

$obj = new CkGzip();

Properties

bool get_AbortCurrent()
void put_AbortCurrent(bool boolVal);

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.)

string comment();
void put_Comment(string strVal);

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

int get_CompressionLevel()
void put_CompressionLevel(int intVal);

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.

string debugLogFilePath();
void put_DebugLogFilePath(string strVal);

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:

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

void get_ExtraData(CkByteData byteData)
void put_ExtraData(CkByteData byteData);

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

string filename();
void put_Filename(string strVal);

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.

(read-only)
string lastErrorHtml();

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.

(read-only)
string lastErrorText();

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.

Concept of LastErrorText

LastErrorText Standard Information

(read-only)
string lastErrorXml();

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.

bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);

Introduced in version 9.5.0.52

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.

string lastModStr();
void put_LastModStr(string strVal);

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

bool get_UseCurrentDate()
void put_UseCurrentDate(bool boolVal);

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.

bool get_Utf8()
void put_Utf8(bool boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

bool get_VerboseLogging()
void put_VerboseLogging(bool boolVal);

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.

(read-only)
string version();

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

Methods

bool CompressBd(CkBinData binDat);

Introduced in version 9.5.0.67

In-place gzip the contents of binDat.

Returns true for success, false for failure.

Gzip Compress In Memory and Base64 Encode

CkTask CompressBdAsync(CkBinData 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

How to Run an Asynchronous Task

bool CompressFile(string inFilename, string destPath);

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

Returns true for success, false for failure.

CkTask 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

How to Run an Asynchronous Task

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.

CkTask 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

How to Run an Asynchronous Task

bool CompressFileToMem(string inFilename, CkByteData outData);

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

Returns true for success, false for failure.

CkTask 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

How to Run an Asynchronous Task

bool CompressMemory(CkByteData inData, CkByteData outData);

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

Returns true for success, false for failure.

CkTask CompressMemoryAsync(CkByteData 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

How to Run an Asynchronous Task

bool CompressMemToFile(CkByteData inData, string destPath);

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

Returns true for success, false for failure.

CkTask CompressMemToFileAsync(CkByteData 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

How to Run an Asynchronous Task

bool CompressString(string inStr, string destCharset, CkByteData outBytes);

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 true for success, false for failure.

Full List of Charset Names

CkTask 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

How to Run an Asynchronous Task

bool CompressStringENC(string inStr, string charset, string encoding, CkString outStr);
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 true for success, false for failure.

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.

Full List of Charset Names

CkTask 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

How to Run an Asynchronous Task

bool Decode(string encodedStr, string encoding, CkByteData outBytes);

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 true for success, false for failure.

bool DeflateStringENC(string inString, string charsetName, string outputEncoding, CkString outStr);
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 true for success, false for failure.

Full List of Charset Names

bool Encode(CkByteData byteData, string encoding, CkString outStr);
string encode(CkByteData 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 true for success, false for failure.

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.

bool ExamineMemory(CkByteData inGzData);

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

CkDateTime GetDt();

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

Returns null on failure

bool InflateStringENC(string inString, string convertFromCharset, string inputEncoding, CkString outStr);
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 true for success, false for failure.

bool IsUnlocked();

Returns true if the component has been unlocked.

bool ReadFile(string path, CkByteData outBytes);

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 true for success, false for failure.

bool SaveLastError(string path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

bool SetDt(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.

bool UncompressBd(CkBinData binDat);

Introduced in version 9.5.0.67

In-place ungzip the contents of binDat.

Returns true for success, false for failure.

CkTask UncompressBdAsync(CkBinData 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

How to Run an Asynchronous Task

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.

GZip Decompress File

CkTask 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

How to Run an Asynchronous Task

bool UncompressFileToMem(string inFilename, CkByteData outData);

Un-Gzips a .gz file directly to memory.

Returns true for success, false for failure.

CkTask 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

How to Run an Asynchronous Task

bool UncompressFileToString(string gzFilename, string charset, CkString outStr);
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 true for success, false for failure.

List of Valid Charsets

CkTask 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

How to Run an Asynchronous Task

bool UncompressMemory(CkByteData inData, CkByteData outData);

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

Returns true for success, false for failure.

CkTask UncompressMemoryAsync(CkByteData 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

How to Run an Asynchronous Task

bool UncompressMemToFile(CkByteData inData, string destPath);

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

Returns true for success, false for failure.

CkTask UncompressMemToFileAsync(CkByteData 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

How to Run an Asynchronous Task

bool UncompressString(CkByteData inData, string inCharset, CkString outStr);
string uncompressString(CkByteData inData, string inCharset);

The reverse of CompressString.

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

Returns true for success, false for failure.

Full List of Charset Names

CkTask UncompressStringAsync(CkByteData 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

How to Run an Asynchronous Task

bool UncompressStringENC(string inStr, string charset, string encoding, CkString outStr);
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 true for success, false for failure.

bool UnlockComponent(string unlockCode);

Unlocks the component allowing for the full functionality to be used.

Returns true for success, false for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Purchased Unlock Code

LastErrorText Standard Information

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.

CkTask 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

How to Run an Asynchronous Task

bool WriteFile(string path, CkByteData binaryData);

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

Returns true for success, false for failure.

bool XfdlToXml(string xfldData, CkString outStr);
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 true for success, false for failure.