Compression PHP Extension Reference Documentation
CkCompression
Current Version: 11.4.0
Provides a flexible and efficient API for compressing and decompressing data in memory, files, and streams. It supports multiple compression algorithms, chunked processing for large data, and optional encoding for easy transport or storage.
Key Features
- Multiple Compression Algorithms
deflatezlib(deflate with header)bzip2lzw
- Flexible Data Types
- Byte arrays
- Strings (with configurable charset)
BinDataandStringBuilder- Files and streams
- Streaming Support
- Compress/decompress arbitrarily large data with constant memory usage
- Ideal for files, sockets, or continuous data streams
- Chunked Processing
- Process data incrementally using
FirstChunkandLastChunk - Replace older Begin/More/End patterns
- Process data incrementally using
- Encoded Output Options
- Return compressed data as:
- Base64
- Hex
- 20+ other encodings
- Return compressed data as:
- Integrated Compression + Encryption
- Combine compression and encryption in a single operation
Object Creation
$obj = new CkCompression();
Properties
Algorithm
void put_Algorithm(string strVal);
Specifies the compression algorithm to use. Supported values are
deflate, zlib, bzip2, and lzw.
The zlib option is the deflate algorithm with a zlib header.
Note: ppmd is deprecated and should not be used.
It was only available on 32-bit systems and specifically used the J variant.
New applications should use one of the supported algorithms listed above.
Charset
void put_Charset(string strVal);
Specifies the character encoding used when converting text to bytes before compression, and bytes back to text after decompression.
The current default is the computer’s ANSI charset, such as Windows-1252 on many
Western Windows systems. However, most modern applications should explicitly set
this property to utf-8.
Recommendation: Set Charset = "utf-8" unless you
specifically need compatibility with another encoding.
DebugLogFilePath
void put_DebugLogFilePath(string strVal);
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.
DeflateLevel
void put_DeflateLevel(int intVal);
Sets the compression level used by the deflate and zlib
algorithms.
0means no compression.9means maximum compression.- The default value is
6.
Higher values may produce smaller output but can require more processing time.
topEncodingMode
void put_EncodingMode(string strVal);
Specifies the text encoding used by methods whose names end in ENC,
such as CompressBytesENC and DecompressStringENC.
Compression methods ending in ENC return compressed binary data as
an encoded string. Decompression methods ending in ENC expect the
input string to use this same encoding.
Valid values include:
base64hexurlquoted-printable
FirstChunk
void put_FirstChunk(bool boolVal);
Indicates that the next chunk-aware compression or decompression call is the first chunk in a sequence.
The default value is true
When both FirstChunk and LastChunk are
true
LastChunk
void put_LastChunk(bool boolVal);
Indicates that the next chunk-aware compression or decompression call is the final chunk in a sequence.
The default value is true
When both FirstChunk and LastChunk are
true
LastErrorHtml
string 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
string lastErrorText();
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
string 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
void put_LastMethodSuccess(bool boolVal);
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.
UncommonOptions
void put_UncommonOptions(string strVal);
Provides a way to enable specialized or uncommon behavior. This property normally remains empty.
It may be set to a comma-separated list of keywords.
Supported option:
-
Crypt2CompressHdr— Duplicates the compression/decompression header behavior used by the deprecated and removed Crypt2 compression functions.
Utf8
void put_Utf8(bool boolVal);
When set to true, all string arguments and return values are interpreted as UTF-8 strings. When set to false, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is true. Before v11.0.0, it was false.
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.
Version
string version();
Methods
CompressBd
Compresses the data contained in a BinData object.
The BinData object is modified to contain the compressed result.
This method is not FirstChunk / LastChunk aware.
Returns true for success, false for failure.
CompressBdAsync (1)
Creates an asynchronous task to call the CompressBd method with the arguments provided.
Returns null on failure
CompressBd2
Compresses the data in one BinData object and appends the
compressed output to another BinData object.
The input BinData is not modified.
This method is FirstChunk / LastChunk aware.
Returns true for success, false for failure.
CompressBd2Async (1)
Creates an asynchronous task to call the CompressBd2 method with the arguments provided.
Returns null on failure
CompressEncryptFile
Compresses and encrypts a file, writing the result to a destination file.
The compression and encryption are performed internally in streaming mode, so files of any size can be processed without loading the entire file into memory.
Returns true for success, false for failure.
CompressEncryptFileAsync (1)
Creates an asynchronous task to call the CompressEncryptFile method with the arguments provided.
Returns null on failure
CompressFile
Compresses a source file and writes the compressed data to a destination file.
The file is processed internally in streaming mode, allowing files of any size to be compressed with stable memory usage.
Returns true for success, false for failure.
CompressFileAsync (1)
Creates an asynchronous task to call the CompressFile method with the arguments provided.
Returns null on failure
CompressSb
Compresses the text contained in a StringBuilder and appends the
compressed bytes to a BinData object.
Text is converted to bytes according to the Charset property.
This method is FirstChunk / LastChunk aware.
Returns true for success, false for failure.
CompressSbAsync (1)
Creates an asynchronous task to call the CompressSb method with the arguments provided.
Returns null on failure
CompressStream
Compresses data from a stream source and writes the compressed data to the stream sink.
The operation is performed in streaming mode, making it suitable for very large or even continuous streams while maintaining stable memory usage.
Returns true for success, false for failure.
CompressStreamAsync (1)
Creates an asynchronous task to call the CompressStream method with the arguments provided.
Returns null on failure
CompressStringENC
Compresses a string and returns the compressed result as an encoded string.
The string is first converted to bytes using Charset, then
compressed, and finally encoded according to EncodingMode.
This method is not FirstChunk / LastChunk aware.
Returns true for success, false for failure.
CompressStringENCAsync (1)
Creates an asynchronous task to call the CompressStringENC method with the arguments provided.
Returns null on failure
DecompressBd
Decompresses the compressed data contained in a BinData object.
The BinData object is modified to contain the decompressed result.
This method is not FirstChunk / LastChunk aware.
Returns true for success, false for failure.
DecompressBdAsync (1)
Creates an asynchronous task to call the DecompressBd method with the arguments provided.
Returns null on failure
DecompressBd2
Decompresses the data in one BinData object and appends the
decompressed output to another BinData object.
The input BinData is not modified.
This method is FirstChunk / LastChunk aware.
Returns true for success, false for failure.
DecompressBd2Async (1)
Creates an asynchronous task to call the DecompressBd2 method with the arguments provided.
Returns null on failure
DecompressFile
Decompresses a source file and writes the decompressed data to a destination file.
The file is processed internally in streaming mode, allowing files of any size to be decompressed without loading the entire file into memory.
Returns true for success, false for failure.
DecompressFileAsync (1)
Creates an asynchronous task to call the DecompressFile method with the arguments provided.
Returns null on failure
DecompressSb
Decompresses compressed data from a BinData object and appends the
resulting text to a StringBuilder.
The decompressed bytes are converted to text using the Charset
property.
This method is FirstChunk / LastChunk aware.
Returns true for success, false for failure.
DecompressSbAsync (1)
Creates an asynchronous task to call the DecompressSb method with the arguments provided.
Returns null on failure
DecompressStream
Decompresses data from a stream source and writes the decompressed data to the stream sink.
The operation is performed in streaming mode, making it suitable for very large or continuous streams while maintaining stable memory usage.
Returns true for success, false for failure.
DecompressStreamAsync (1)
Creates an asynchronous task to call the DecompressStream method with the arguments provided.
Returns null on failure
DecompressStringENC
string decompressStringENC(string encodedCompressedData);
Decompresses compressed data supplied as an encoded string and returns the resulting text.
The input string is decoded according to EncodingMode, then
decompressed. The resulting bytes are converted to text using
Charset.
This method is not FirstChunk / LastChunk aware.
Returns true for success, false for failure.
DecompressStringENCAsync (1)
Creates an asynchronous task to call the DecompressStringENC method with the arguments provided.
Returns null on failure
DecryptDecompressFile
Decrypts and decompresses a file, writing the restored data to a destination file.
This is the reverse operation of CompressEncryptFile.
Returns true for success, false for failure.
DecryptDecompressFileAsync (1)
Creates an asynchronous task to call the DecryptDecompressFile method with the arguments provided.
Returns null on failure
LoadTaskCaller
Deprecated
BeginCompressBytes
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2 .
Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytes, followed by 0 or more calls to MoreCompressedBytes, and ending with a final call to EndCompressBytes. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).
Returns true for success, false for failure.
BeginCompressBytesENC
string beginCompressBytesENC(CkByteData data);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytesENC, followed by 0 or more calls to MoreCompressedBytesENC, and ending with a final call to EndCompressBytesENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).
Returns true for success, false for failure.
topBeginCompressString
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Large amounts of string data may be compressed in chunks by first calling BeginCompressString, followed by 0 or more calls to MoreCompressedString, and ending with a final call to EndCompressString. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).
Returns true for success, false for failure.
BeginCompressStringENC
string beginCompressStringENC(string str);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Large amounts of string data may be compressed in chunks by first calling BeginCompressStringENC, followed by 0 or more calls to MoreCompressedStringENC, and ending with a final call to EndCompressStringENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).
Returns true for success, false for failure.
BeginDecompressBytes
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytes, followed by 0 or more calls to MoreDecompressedBytes, and ending with a final call to EndDecompressBytes. Each call returns 0 or more bytes of decompressed data.
Returns true for success, false for failure.
BeginDecompressBytesENC
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.
A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytesENC, followed by 0 or more calls to MoreDecompressedBytesENC, and ending with a final call to EndDecompressBytesENC. Each call returns 0 or more bytes of decompressed data.
Returns true for success, false for failure.
topBeginDecompressString
string beginDecompressString(CkByteData data);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
A compressed data stream may be decompressed in chunks by first calling BeginDecompressString, followed by 0 or more calls to MoreDecompressedString, and ending with a final call to EndDecompressString. Each call returns 0 or more characters of decompressed text.
Returns true for success, false for failure.
BeginDecompressStringENC
string beginDecompressStringENC(string str);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.
A compressed data stream may be decompressed in chunks by first calling BeginDecompressStringENC, followed by 0 or more calls to MoreDecompressedStringENC, and ending with a final call to EndDecompressStringENC. Each call returns 0 or more characters of decompressed text.
Returns true for success, false for failure.
topCompressBytes Deprecated
Compresses a byte array and returns the compressed bytes.
This method is FirstChunk / LastChunk aware.
Returns true for success, false for failure.
topCompressBytesAsync Deprecated (1)
Creates an asynchronous task to call the CompressBytes method with the arguments provided.
Returns null on failure
CompressBytesENC Deprecated
Compresses a byte array and returns the compressed result as an encoded string.
The output encoding is controlled by EncodingMode.
This method is not FirstChunk / LastChunk aware.
Returns true for success, false for failure.
topCompressBytesENCAsync Deprecated (1)
Creates an asynchronous task to call the CompressBytesENC method with the arguments provided.
Returns null on failure
CompressStr Deprecated
Compresses a string and appends the compressed bytes to a BinData
object.
The string is converted to bytes using the charset specified by the
Charset property.
This method is FirstChunk / LastChunk aware.
Returns true for success, false for failure.
topCompressStrAsync Deprecated (1)
Creates an asynchronous task to call the CompressStr method with the arguments provided.
Returns null on failure
CompressString Deprecated
Compresses a string and returns the compressed bytes.
The string is converted to bytes using the Charset property.
This method is FirstChunk / LastChunk aware.
Returns true for success, false for failure.
topCompressStringAsync Deprecated (1)
Creates an asynchronous task to call the CompressString method with the arguments provided.
Returns null on failure
DecompressBytes Deprecated
Decompresses compressed byte data and returns the decompressed bytes.
This method is FirstChunk / LastChunk aware.
Returns true for success, false for failure.
topDecompressBytesAsync Deprecated (1)
Creates an asynchronous task to call the DecompressBytes method with the arguments provided.
Returns null on failure
DecompressBytesENC Deprecated
Decompresses compressed data supplied as an encoded string and returns the decompressed bytes.
The input string is decoded according to EncodingMode before being
decompressed.
Returns true for success, false for failure.
topDecompressBytesENCAsync Deprecated (1)
Creates an asynchronous task to call the DecompressBytesENC method with the arguments provided.
Returns null on failure
DecompressString Deprecated
Decompresses compressed byte data and returns the resulting string.
The decompressed bytes are converted to text using the Charset
property.
This method is FirstChunk / LastChunk aware.
Returns true for success, false for failure.
topEndCompressBytes
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressBytes)
Returns true for success, false for failure.
EndCompressBytesENC
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressBytesENC)
Returns true for success, false for failure.
topEndCompressString
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressString)
Returns true for success, false for failure.
EndCompressStringENC
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressStringENC)
Returns true for success, false for failure.
EndDecompressBytes
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
(See BeginDecompressBytes)
Returns true for success, false for failure.
EndDecompressBytesENC
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.
(See BeginDecompressBytesENC)
Returns true for success, false for failure.
topEndDecompressString
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
(See BeginDecompressString)
Returns true for success, false for failure.
EndDecompressStringENC
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.
(See BeginDecompressStringENC)
Returns true for success, false for failure.
topMoreCompressBytes
(See BeginCompressBytes)
Returns true for success, false for failure.
MoreCompressBytesENC
string moreCompressBytesENC(CkByteData data);
MoreCompressString
(See BeginCompressString)
Returns true for success, false for failure.
MoreCompressStringENC
(See BeginCompressStringENC)
Returns true for success, false for failure.
MoreDecompressBytes
(See BeginDecompressBytes)
Returns true for success, false for failure.
MoreDecompressBytesENC
The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.
(See BeginDecompressBytesENC)
Returns true for success, false for failure.
topMoreDecompressString
string moreDecompressString(CkByteData data);
(See BeginDecompressString)
Returns true for success, false for failure.
MoreDecompressStringENC
string moreDecompressStringENC(string str);
The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.
(See BeginDecompressStringENC)
Returns true for success, false for failure.
top