CkBz2 PHP Extension Reference Documentation

CkBz2

Current Version: 10.1.0

Requires Chilkat Bundle License

Provides the ability to create and unzip .bz2 compressed files using the BZip2 compression algorithm.

Object Creation

$obj = new CkBz2();

Properties

AbortCurrent

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

DebugLogFilePath

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

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

(read-only)
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.

LastErrorText

(read-only)
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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

(read-only)
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.

LastMethodSuccess

bool get_LastMethodSuccess()
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.

Utf8

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.

VerboseLogging

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.

Version

(read-only)
string version();

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

CompressFile

bool CompressFile(string inFilename, string toPath);

Compresses a file to create a BZip2 compressed file (.bz2).

Note: Both inFilename and toPath should be relative or absolute file paths (not just a path to a directory). For example "someDir1/someDir2/myFile.txt" or "c:/someDir1/myFile.bz2".

Returns true for success, false for failure.

More Information and Examples

bz2 Compress File

CompressFileAsync ⁽¹⁾

CkTask CompressFileAsync(string inFilename, string toPath);

Creates an asynchronous task to call the CompressFile method with the arguments provided.

Returns null on failure

CompressFileToMem

bool CompressFileToMem(string inFilename, CkByteData outBytes);

BZip2 compresses a file to an in-memory image of a .bz2 file.

Returns true for success, false for failure.

CompressFileToMemAsync ⁽¹⁾

CkTask CompressFileToMemAsync(string inFilename);

Creates an asynchronous task to call the CompressFileToMem method with the arguments provided.

Returns null on failure

CompressMemory

bool CompressMemory(CkByteData inData, CkByteData outBytes);

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

Returns true for success, false for failure.

CompressMemoryAsync ⁽¹⁾

CkTask CompressMemoryAsync(CkByteData inData);

Creates an asynchronous task to call the CompressMemory method with the arguments provided.

Returns null on failure

CompressMemToFile

bool CompressMemToFile(CkByteData inData, string toPath);

BZip2 compresses and creates a .bz2 file from in-memory data.

Returns true for success, false for failure.

CompressMemToFileAsync ⁽¹⁾

CkTask CompressMemToFileAsync(CkByteData inData, string toPath);

Creates an asynchronous task to call the CompressMemToFile method with the arguments provided.

Returns null on failure

LoadTaskCaller

bool LoadTaskCaller(CkTask task);

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

UncompressFile

bool UncompressFile(string inFilename, string toPath);

Unzips a .bz2 file.

Returns true for success, false for failure.

UncompressFileAsync ⁽¹⁾

CkTask UncompressFileAsync(string inFilename, string toPath);

Creates an asynchronous task to call the UncompressFile method with the arguments provided.

Returns null on failure

UncompressFileToMem

bool UncompressFileToMem(string inFilename, CkByteData outBytes);

Unzips a .bz2 file directly to memory.

Returns true for success, false for failure.

UncompressFileToMemAsync ⁽¹⁾

CkTask UncompressFileToMemAsync(string inFilename);

Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided.

Returns null on failure

UncompressMemory

bool UncompressMemory(CkByteData inData, CkByteData outBytes);

Unzips from an in-memory image of a .bz2 file directly into memory.

Returns true for success, false for failure.

UncompressMemoryAsync ⁽¹⁾

CkTask UncompressMemoryAsync(CkByteData inData);

Creates an asynchronous task to call the UncompressMemory method with the arguments provided.

Returns null on failure

UncompressMemToFile

bool UncompressMemToFile(CkByteData inData, string toPath);

Unzips from an in-memory image of a .bz2 file to a file.

Returns true for success, false for failure.

UncompressMemToFileAsync ⁽¹⁾

CkTask UncompressMemToFileAsync(CkByteData inData, string toPath);

Creates an asynchronous task to call the UncompressMemToFile method with the arguments provided.

Returns null on failure