CkBinData PHP Extension Reference Documentation

CkBinData

Current Version: 9.5.0.75

Container for binary data. Provides methods for getting, setting, appending, etc. in binary and string encoded formats.

Object Creation

$obj = new CkBinData();

Properties

LastMethodSuccess
bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);

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.

top
NumBytes
(read-only)
int get_NumBytes()
Introduced in version 9.5.0.51

The number of bytes contained within the object.

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

top

Methods

AppendBd
bool AppendBd(CkBinData binData);
Introduced in version 9.5.0.62

Appends the contents of another BinData to this object.

Returns true for success, false for failure.

top
AppendBinary
bool AppendBinary(CkByteData data);
Introduced in version 9.5.0.51

Appends binary data to the current contents, if any.

Returns true for success, false for failure.

top
AppendBom
bool AppendBom(string charset);
Introduced in version 9.5.0.62

Appends the appropriate BOM (byte order mark), also known as a "preamble", for the given charset. If the charset has no defined BOM, then nothing is appended. An application would typically call this to append the utf-8, utf-16, or utf-32 BOM.

Returns true for success, false for failure.

More Information and Examples
top
AppendEncoded
bool AppendEncoded(string encData, string encoding);
Introduced in version 9.5.0.51

Appends encoded binary data to the current data. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

top
AppendEncodedSb
bool AppendEncodedSb(CkStringBuilder sb, string encoding);
Introduced in version 9.5.0.62

Decodes the contents of sb and appends the decoded bytes to this object. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

top
AppendSb
bool AppendSb(CkStringBuilder sb, string charset);
Introduced in version 9.5.0.62

Appends the contents of a StringBuilder to this object.

Returns true for success, false for failure.

More Information and Examples
top
AppendString
bool AppendString(string str, string charset);
Introduced in version 9.5.0.62

Appends a string to this object. (This does not append the BOM. If a BOM is required, the AppendBom method can be called to append the appropriate BOM.)

Returns true for success, false for failure.

More Information and Examples
top
Clear
bool Clear();
Introduced in version 9.5.0.51

Clears the contents.

Returns true for success, false for failure.

top
ContentsEqual
bool ContentsEqual(CkBinData binData);
Introduced in version 9.5.0.62

Return true if the contents of this object equals the contents of binData.

top
GetBinary
bool GetBinary(CkByteData outBytes);
Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns true for success, false for failure.

top
GetBinaryChunk
bool GetBinaryChunk(int offset, int numBytes, CkByteData outBytes);
Introduced in version 9.5.0.51

Retrieves a chunk of the binary data contained within the object.

Returns true for success, false for failure.

top
GetEncoded
bool GetEncoded(string encoding, CkString outStr);
string getEncoded(string encoding);
Introduced in version 9.5.0.51

Retrieves the binary data as an encoded string. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

top
GetEncodedChunk
bool GetEncodedChunk(int offset, int numBytes, string encoding, CkString outStr);
string getEncodedChunk(int offset, int numBytes, string encoding);
Introduced in version 9.5.0.51

Retrieves a chunk of the binary data and returns it in encoded form. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

More Information and Examples
top
GetEncodedSb
bool GetEncodedSb(string encoding, CkStringBuilder sb);
Introduced in version 9.5.0.64

Writes the encoded data to a StringBuilder. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

More Information and Examples
top
GetString
bool GetString(string charset, CkString outStr);
string getString(string charset);
Introduced in version 9.5.0.67

Interprets the bytes according to charset and returns the string. The charset can be "utf-8", "utf-16", "ansi", "iso-8859-*", "windows-125*", or any of the supported character encodings listed in the link below.

Returns true for success, false for failure.

More Information and Examples
top
LoadBinary
bool LoadBinary(CkByteData data);
Introduced in version 9.5.0.51

Loads binary data and replaces the current contents, if any.

Returns true for success, false for failure.

top
LoadEncoded
bool LoadEncoded(string encData, string encoding);
Introduced in version 9.5.0.51

Loads binary data from an encoded string, replacing the current contents, if any. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

top
LoadFile
bool LoadFile(string path);
Introduced in version 9.5.0.51

Loads data from a file.

Returns true for success, false for failure.

top
RemoveChunk
bool RemoveChunk(int offset, int numBytes);
Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

More Information and Examples
top
SecureClear
bool SecureClear();
Introduced in version 9.5.0.67

Securely clears the contents by writing 0 bytes to the memory prior to deallocating the internal memory.

Returns true for success, false for failure.

top
WriteFile
bool WriteFile(string path);
Introduced in version 9.5.0.62

Writes the contents to a file.

Returns true for success, false for failure.

top