CkByteData PHP Extension Reference Documentation

CkByteData

Current Version: 9.5.0.75

Represents a chunk of byte data and provides methods for accessing it, adding to it, or saving and loading from files.

Object Creation

$obj = new CkByteData();

Properties

SecureClear
bool get_SecureClear()
void put_SecureClear(bool boolVal);
Introduced in version 9.5.0.73

If set to true, then memory is always first overwritten with zero bytes prior to deallocation. The default value of this property is false.

top

Methods

append
void append(CkByteData db);

Appends byte data to the data already contained in the object.

top
append2
void append2((binary) string pByteData, int szByteData);

Appends bytes to the data already contained in the object.

top
appendChar
void appendChar(char ch);

Appends a single byte.

top
appendCharN
void appendCharN(char ch, int numTimes);

Appends a single char N times. The equivalent of calling appendChar N times.

top
appendEncoded
void appendEncoded(string str, string encoding);

Appends binary data from an encoded string. The encoding can be specified as "hex", "base64", "url", "quoted-printable", "modBase64", "base58", or "base32". The input string is decoded from the specified encoding and the binary data is appended to the calling object's content.

top
appendEncodedW
void appendEncodedW((utf-16) string str, (utf-16) string encoding);

To be documented soon...

top
appendFile
bool appendFile(string path);

Opens a file for binary read, appends the file contents, and closes the file.

top
appendFileW
bool appendFileW((utf-16) string path);

To be documented soon...

top
appendInt
void appendInt(int intValue, bool littleEndian);

Appends a 32-bit signed integer (4 bytes) to the data already contained in the object. littleEndian determines whether the big endian or little endian byte ordering is used.

top
appendRandom
void appendRandom(int numBytes);

Appends numBytes random bytes to the data already contained within the object.

top
appendRange
void appendRange(CkByteData byteData, int index, int numBytes);

Appends a range of bytes from byteData to the data contained withing the caller. The first byte is at index 0.

top
appendShort
void appendShort(int shortValue, bool littleEndian);

Appends a 16-bit signed integer (2 bytes) to the data already contained in the object. littleEndian determines whether the big endian or little endian byte ordering is used.

top
appendStr
void appendStr(string str);

Appends a null-terminated string to the data, without including the terminating null.

top
appendStrW
void appendStrW((utf-16) string str, (utf-16) string charset);

To be documented soon...

top
beginsWith
bool beginsWith(CkByteData byteDataObj);

Returns true if the caller's data begins with the exact bytes contained within byteDataObj.

top
beginsWith2
bool beginsWith2((binary) string pByteData, int szByteData);

Returns true if the caller's data begins with specified bytes.

top
byteSwap4321
void byteSwap4321();

4321 byte swaps the data contained within the object.

top
clear
void clear();

Clears the CkByteData object of all data.

top
encode
void encode(string encoding, CkString str);

Encodes binary data according to the encoding requested. The encoding can be specified as "hex", "base64", "url", "quoted-printable", "modBase64", "base58", "base32", "qp-", "url_rfc1738", "url_rfc2396", or "url_rfc3986".

top
encodeW
void encodeW((utf-16) string encoding, CkString str);

To be documented soon...

top
ensureBuffer
bool ensureBuffer(int expectedNumBytes);

This method can be called to help optimize internal memory re-allocation. If, for example, many calls will be made to append data, and the total size is approximately known, then this method can be called to pre-allocate the internal buffer to the expected total size.

Returns true for success, false for failure.

top
equals
bool equals(CkByteData compareBytes);

Returns true if compareBytes contains exactly the same content as the caller. Otherwise returns false.

top
equals2
bool equals2((binary) string pCompareBytes, int numBytes);

Returns true if the bytes pointed to by pCompareBytes contains exactly the same content as the caller. Otherwise returns false.

top
findBytes
int findBytes(CkByteData byteDataObj);

Locates the first occurrence of the bytes contained in byteDataObj and returns the index of where these bytes occur in the caller's data. Returns -1 if not found.

top
findBytes2
int findBytes2((binary) string findBytes, int findBytesLen);

Locates the first occurrence of the specified bytes and returns the index of where these bytes occur in the caller's data. Returns -1 if not found.

top
getByte
byte getByte(int byteIndex);

Returns the Nth byte of the binary data. The 1st byte is at index 0.

top
getChar
char getChar(int byteIndex);

Returns the Nth byte of the binary content as a "char". The 1st byte is at index 0.

top
getData
(binary) string getData();

Returns a pointer to the internal buffer. Be careful with this method because if additional data is appended, the data within the object may be relocated and the pointer may cease to be valid.

top
getDataAt
(binary) string getDataAt(int byteIndex);

Same as getData, except it gets a pointer to the data at a byte offset. (0 = the start of buffer)

top
getEncoded
string getEncoded(string encoding);
Introduced in version 9.5.0.47

Returns the binary data as an encoded string. The encoding may be "base64", "hex", "quoted-printable" (or "qp"), "url", "asc", "url_rfc1738", "url_rfc2396", "url_rfc3986", or "url_oauth".

top
getEncodedW
(utf-16) string getEncodedW((utf-16) string encoding);

The utf-16 version of getEncoded.

top
getInt
int getInt(int byteIndex);

Returns the 4-byte integer located at a specific byte index.

top
getRange
(binary) string getRange(int byteIndex, int numBytes);

Copies a range of bytes to a separate internal memory buffer and returns the pointer to the bytes. The returned pointer is only valid while the object exists. Also, any subsequent calls to getRange, getRangeStr, or to_s will invalidate the buffer.

top
getSize
int getSize();

Returns the number of bytes in the data buffer.

top
is7bit
bool is7bit();

Returns true if all the bytes are in the range 0x00 to 0x7F.

top
loadFile
bool loadFile(string path);

Equivalent to clear() followed by appendFile().

top
loadFileW
bool loadFileW((utf-16) string path);

To be documented soon...

top
pad
void pad(int blockSize, int paddingScheme);

Pads the data to a multiple of the blockSize using a cryptographic padding scheme specified by paddingScheme. The possible integer values for paddingScheme are the same as those listed for the PaddingScheme property of the CkCrypt2 class.

top
removeChunk
void removeChunk(int startIndex, int numBytes);

Removes (discards) a range from the data.

top
replaceChar
void replaceChar(byte existingByteValue, byte replacementByteValue);

Replaces all occurrences of existingByteValue with replacementByteValue.

top
saveFile
bool saveFile(string path);

Saves the byte data to a file. If the file already exists, it will be overwritten.

top
saveFileW
bool saveFileW((utf-16) string path);

To be documented soon...

top
shorten
void shorten(int numBytes);

Discards N bytes from the end of the data.

top
to_ws
(utf-16) string to_ws(string charset);

To be documented soon...

top
unpad
void unpad(int blockSize, int paddingScheme);

Unpads the data from a multiple of the blockSize to the original data size using a cryptographic padding scheme specified by paddingScheme. The possible integer values for paddingScheme are the same as those listed for the PaddingScheme property of the CkCrypt2 class.

top