CkStringBuilder PHP Extension Reference Documentation

CkStringBuilder

A simple class for building strings. (Represents a mutable string of characters.)

Note: This class was introduced in Chilkat v9.5.0.58.

Object Creation

$obj = new CkStringBuilder();

Properties

int get_IntValue()
void put_IntValue(int intVal);

Introduced in version 9.5.0.58

Returns the content of the string converted to an integer.

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.

(read-only)
int get_Length()

Introduced in version 9.5.0.58

The number of characters of the string contained within this instance.

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.

Methods

bool Append(string value);

Introduced in version 9.5.0.58

Appends a copy of the specified string to this instance.

Returns true for success, false for failure.

bool AppendBd(CkBinData binData, string charset, int offset, int numBytes);

Introduced in version 9.5.0.64

Appends the contents of binData. The charset specifies the character encoding of the bytes contained in binData. The charset can be any of the supported encodings listed at Chilkat Supported Character Encodings. To append the entire contents of binData, set offset and numBytes equal to zero. To append a range of binData, set the offset and numBytes to specify the range.

Returns true for success, false for failure.

bool AppendEncoded(CkByteData binaryData, string encoding);

Introduced in version 9.5.0.58

Appends binary data using the encoding specified by encoding, such as "base64", "hex", etc.

Returns true for success, false for failure.

Hash the Contents of a File (SHA256 and other hash algorithms)

bool AppendInt(int value);

Introduced in version 9.5.0.58

Appends the string representation of a specified 32-bit signed integer to this instance.

Returns true for success, false for failure.

bool AppendInt64(int64 value);

Introduced in version 9.5.0.58

Appends the string representation of a specified 64-bit signed integer to this instance.

Returns true for success, false for failure.

bool AppendLine(string value, bool crlf);

Introduced in version 9.5.0.65

Appends the value followed by a CRLF or LF to the end of the curent StringBuilder object. If crlf is true, then a CRLF line ending is used. Otherwise a LF line ending is used.

Returns true for success, false for failure.

bool AppendSb(CkStringBuilder sb);

Introduced in version 9.5.0.62

Appends the contents of another StringBuilder to this instance.

Returns true for success, false for failure.

void Clear();

Introduced in version 9.5.0.58

Removes all characters from the current StringBuilder instance.

bool Contains(string str, bool caseSensitive);

Introduced in version 9.5.0.58

Returns true if the str is contained within this object. For case sensitive matching, set caseSensitive equal to true. For case-insensitive, set caseSensitive equal to false.

bool ContainsWord(string word, bool caseSensitive);

Introduced in version 9.5.0.69

Returns true if the word is contained within this object, but only if it is a whole word. This method is limited to finding whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

For case sensitive matching, set caseSensitive equal to true. For case-insensitive, set caseSensitive equal to false.

bool ContentsEqual(string str, bool caseSensitive);

Introduced in version 9.5.0.62

Returns true if the contents of this object equals the str. Returns false if unequal. For case insensitive equality, set caseSensitive equal to false.

bool ContentsEqualSb(CkStringBuilder sb, bool caseSensitive);

Introduced in version 9.5.0.62

Returns true if the contents of this object equals the sb. Returns false if unequal. For case insensitive equality, set caseSensitive equal to false.

bool Decode(string encoding, string charset);

Introduced in version 9.5.0.62

Decodes and replaces the contents with the decoded string. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Note: This method can only be called if the encoded content decodes to a string. The charset indicates the charset to be used in intepreting the decoded bytes. For example, the charset can be "utf-8", "utf-16", "iso-8859-1", "shift_JIS", etc.

Returns true for success, false for failure.

JSON Escape and Unescape a String

bool Encode(string encoding, string charset);

Introduced in version 9.5.0.62

Encodes to base64, hex, quoted-printable, URL encoding, etc. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Returns true for success, false for failure.

Supported Binary Encodings

StringBuilder Encode

UN/EDIFACT Syntax Level A Encoding/Decoding

JSON Escape and Unescape a String

bool EndsWith(string substr, bool caseSensitive);

Introduced in version 9.5.0.62

Returns true if the string ends with substr. Otherwise returns false. The comparison is case sensitive if caseSensitive is true, and case insensitive if caseSensitive is false.

bool EntityDecode();

Introduced in version 9.5.0.62

Decodes HTML entities. See HTML entities for more information about HTML entities.

Returns true for success, false for failure.

StringBuilder EntityDecode

bool GetAfterBetween(string searchAfter, string beginMark, string endMark, CkString outStr);
string getAfterBetween(string searchAfter, string beginMark, string endMark);

Introduced in version 9.5.0.62

Begin searching after the 1st occurrence of searchAfter is found, and then return the substring found between the next occurrence of beginMark and the next occurrence of endMark.

Returns true for success, false for failure.

StringBuilder GetAfterBetween

Implement Preprocessor #include with StringBuilder

bool GetAsString(CkString outStr);
string getAsString();

Introduced in version 9.5.0.58

Returns the contents as a string.

Returns true for success, false for failure.

bool GetBetween(string beginMark, string endMark, CkString outStr);
string getBetween(string beginMark, string endMark);

Introduced in version 9.5.0.62

Returns the substring found between the 1st occurrence of beginMark and the next occurrence of endMark.

Returns true for success, false for failure.

StringBuilder GetBetween

bool GetDecoded(string encoding, CkByteData outBytes);

Introduced in version 9.5.0.62

Decodes and returns the decoded bytes. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Returns true for success, false for failure.

bool GetEncoded(string encoding, string charset, CkString outStr);
string getEncoded(string encoding, string charset);

Introduced in version 9.5.0.62

Returns the string contents encoded in an encoding such as base64, hex, quoted-printable, or URL-encoding. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Note: The Encode method modifies the content of this object. The GetEncoded method leaves this object's content unmodified.

Returns true for success, false for failure.

Supported Binary Encodings

StringBuilder GetEncoded

StringBuilder Encode Charset

bool GetNth(int index, string delimiterChar, bool exceptDoubleQuoted, bool exceptEscaped, CkString outStr);
string getNth(int index, string delimiterChar, bool exceptDoubleQuoted, bool exceptEscaped);

Introduced in version 9.5.0.62

Returns the Nth substring in string that is a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is true, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is true, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns true for success, false for failure.

StringBuilder GetNth

bool LastNLines(int numLines, bool bCrlf, CkString outStr);
string lastNLines(int numLines, bool bCrlf);

Introduced in version 9.5.0.62

Returns the last N lines of the text. If fewer than numLines lines exists, then all of the text is returned. If bCrlf is true, then the line endings of the returned string are converted to CRLF, otherwise the line endings are converted to LF-only.

Returns true for success, false for failure.

Get the Last N Lines of a StringBuilder

bool LoadFile(string path, string charset);

Introduced in version 9.5.0.62

Loads the contents of a file.

Returns true for success, false for failure.

bool Prepend(string value);

Introduced in version 9.5.0.61

Prepends a copy of the specified string to this instance.

Returns true for success, false for failure.

bool PunyDecode();

Introduced in version 9.5.0.71

In-place decodes the string from punycode.

Returns true for success, false for failure.

bool PunyEncode();

Introduced in version 9.5.0.71

In-place encodes the string to punycode.

Returns true for success, false for failure.

int Replace(string value, string replacement);

Introduced in version 9.5.0.58

Replaces all occurrences of a specified string in this instance with another specified string. Returns the number of replacements.

bool ReplaceAllBetween(string beginMark, string endMark, string replacement, bool replaceMarks);

Introduced in version 9.5.0.64

Replaces the first occurrence of the content found between beginMark and endMark with replacement. The beginMark and endMark are included in what is replaced if replaceMarks is true.

Returns true for success, false for failure.

Implement Preprocessor #include with StringBuilder

int ReplaceBetween(string beginMark, string endMark, string value, string replacement);

Introduced in version 9.5.0.62

Replaces all occurrences of value with replacement, but only where value is found between beginMark and endMark. Returns the number of replacements made.

StringBuilder ReplaceBetween

int ReplaceI(string value, int replacement);

Introduced in version 9.5.0.67

Replaces all occurrences of value with the decimal integer replacement. Returns the number of replacements.

int ReplaceWord(string value, string replacement);

Introduced in version 9.5.0.62

Replaces all word occurrences of a specified string in this instance with another specified string. Returns the number of replacements made.

Important: This method is limited to replacing whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

StringBuilder ReplaceWord

void SecureClear();

Introduced in version 9.5.0.67

Removes all characters from the current StringBuilder instance, and write zero bytes to the allocated memory before deallocating.

bool SetNth(int index, string value, string delimiterChar, bool exceptDoubleQuoted, bool exceptEscaped);

Introduced in version 9.5.0.62

Sets the Nth substring in string in a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is true, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is true, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns true for success, false for failure.

StringBuilder SetNth

bool SetString(string value);

Introduced in version 9.5.0.61

Sets this instance to a copy of the specified string.

Returns true for success, false for failure.

bool StartsWith(string substr, bool caseSensitive);

Introduced in version 9.5.0.62

Returns true if the string starts with substr. Otherwise returns false. The comparison is case sensitive if caseSensitive is true, and case insensitive if caseSensitive is false.

bool ToCRLF();

Introduced in version 9.5.0.62

Converts line endings to CRLF (Windows) format.

Returns true for success, false for failure.

bool ToLF();

Introduced in version 9.5.0.62

Converts line endings to LF-only (UNIX) format.

Returns true for success, false for failure.

bool ToLowercase();

Introduced in version 9.5.0.62

Converts the contents to lowercase.

Returns true for success, false for failure.

bool ToUppercase();

Introduced in version 9.5.0.62

Converts the contents to uppercase.

Returns true for success, false for failure.

bool Trim();

Introduced in version 9.5.0.62

Trims whitespace from both ends of the string.

Returns true for success, false for failure.

bool TrimInsideSpaces();

Introduced in version 9.5.0.62

Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no occurances of more than one SPACE char in a row.

Returns true for success, false for failure.

bool WriteFile(string path, string charset, bool emitBom);

Introduced in version 9.5.0.62

Writes the contents to a file. If emitBom is true, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)

Returns true for success, false for failure.