Chilkat_9_5_0.CkString PHP ActiveX Reference Documentation

Chilkat_9_5_0.CkString

The Chilkat string class.

Object Creation

$obj = new COM("Chilkat_9_5_0.CkString");

Properties

int NumArabic (read-only)

Introduced in version 9.5.0.25

The number of Arabic characters contained in this string.

int NumAscii (read-only)

Introduced in version 9.5.0.25

The number of us-ascii characters contained in this string.

int NumCentralEuro (read-only)

Introduced in version 9.5.0.25

The number of Central European and Eastern European characters found in this string. These are characters specific to Polish, Czech, Slovak, Hungarian, Slovene, Croatian, Serbian (Latin script), Romanian and Albanian.

int NumChars (read-only)

To be documented soon...

int NumChinese (read-only)

Introduced in version 9.5.0.25

The number of Chinese characters contained in this string.

int NumCyrillic (read-only)

Introduced in version 9.5.0.25

The number of Cyrillic characters contained in this string. The Cyrillic alphabet also called azbuka, from the old name of the first two letters) is actually a family of alphabets, subsets of which are used by certain East and South Slavic languages "” Belarusian, Bulgarian, Macedonian, Russian, Rusyn, Serbian and Ukrainian"”as well as many other languages of the former Soviet Union, Asia and Eastern Europe.

int NumGreek (read-only)

Introduced in version 9.5.0.25

The number of Greek characters contained in this string.

int NumHebrew (read-only)

Introduced in version 9.5.0.25

The number of Hebrew characters contained in this string.

int NumJapanese (read-only)

Introduced in version 9.5.0.25

The number of Japanese characters contained in this string.

int NumKorean (read-only)

Introduced in version 9.5.0.25

The number of Korean characters contained in this string.

int NumLatin (read-only)

Introduced in version 9.5.0.25

The number of Latin characters contained in this string. Latin characters include all major Western European languages, such as German, Spanish, French, Italian, Nordic languages, etc.

int NumThai (read-only)

Introduced in version 9.5.0.25

The number of Thai characters contained in this string.

int SizeAnsi (read-only)

The size, in bytes, of the ANSI encoding of the string.

int SizeUtf8 (read-only)

The size, in bytes, of the utf-8 encoding of the string.

string Str

The string value of this object.

Methods

int AnsiCharAt(int index)

Returns the ASCII value of the Nth char in the string. The 1st char is at index 0.

void Append(string str)

The str is appended to end of this instance.

void AppendDateRfc3339(Date dt)

Appends a date/time string in RFC 3339 format to the end of this instance.

void AppendDateRfc822(Date dateTime)

The dateTime is appended in RFC 822 format to the end of this instance.

void AppendEncoded(string str, string encoding, string charset)

Appends characters from an encoded string. The encoding may be "base64", "hex", "url", or "quoted-printable". For example, to append "ABC 123" from a URL-encoded string, call:

strObj.AppendEncoded("ABC+123","url","iso-8859-1")

Supported Character Encodings

void AppendMultibyte(VARIANT mbtext, string charsetEncoding)

Appends characters from a byte array. mbtext contains the character data. The input bytes are interpreted according to the character encoding specified by charsetEncoding.

Supported Character Encodings

bool AppendToFile(string path, string charsetEncoding)

Appends the contents of the string to a file. The string is first converted to the character encoding specified by charsetEncoding before being appended to the file.

Supported Character Encodings

bool BeginsWith(string str)

Returns true if the string begins with str. Otherwise returns false. This method is case sensitive.

void ChopAfter(string findStr)

Truncates the string after the 1st occurance of findStr. If findStr is not present, nothing is truncated.

void ChopBefore(string findStr)

Truncates the string before the 1st occurance of findStr. If findStr is not present, nothing is truncated.

void Clear()

Clears the string. After calling this method, the string contains 0 characters.

bool Contains(string substr)

Returns true if substr is present in the string (case sensitive), otherwise returns false.

VARIANT EmitMultibyte(string charsetEncoding)

Converts the string to a byte array using the character encoding specified by charsetEncoding.

Returns null on failure

Demystifying ASP Code Pages, Response.Write, Response.BinaryWrite, Strings, and Charsets

Supported Character Encodings

bool EndsWith(string substr)

Returns true if the string ends with substr (case-sensitive). Otherwise returns false.

string GetEncoded(string binaryEncoding, string charsetEncoding)

Returns the character string in an encoding use the charsetEncoding specified. The binaryEncoding may be "base64", "hex", "url", or "quoted-printable". For example:

(Visual Basic 6.0)

Dim s As New CkString

s.Str = "èèè"
Text1.Text = s.GetEncoded("hex", "iso-8859-1") & vbCrLf
Text1.Text = Text.Text & s.GetEncoded("hex", "utf-8") & vbCrLf
Text1.Text = Text1.Text & s.GetEncoded("hex", "unicode")

'Output:
'E8E8E8
'C3A8C3A8C3A8
'E800E800E800

Returns null on failure

Supported Character Encodings

void HtmlEntityDecode()

Decodes any HTML entities found in the string.

HTML Entity Decode ASP Example

void HtmlEntityEncode()

HTML entity encodes all special characters. (Those characters that might require HTML entity encoding.)

ASP HTML Entity Encode Example

int LastAnsiChar()

Returns the ASCII value of the last character in the string.

string Left(int numChars)

Returns a string that is the leftmost numChars of this instance.

Returns null on failure

int Length()

Returns the length, in characters, of the string.

bool LoadFile(string path, string charsetEncoding)

Loads an entire text file into the string object. The character encoding of the text file is specified by charsetEncoding. This method allows for text files in any charset to be loaded: utf-8, Unicode, Shift_JIS, iso-8859-1, etc.

Supported Character Encodings

void LoadXmlDoc(VARIANT xmlDocumentBytes)

Loads an XML document into the CkString. The xmlDocumentBytes contains the raw bytes of the XML document. The reason for providing a separate method for loading an XML document is because the charset encoding is usually specified using a "charset" attribute at the beginning of the XML document. The LoadXmlDoc method reads just enough of the XML document to get the charset, and then it knows how to read and interpret the bytes of the entire XML document, so that the bytes of the characters are properly interpeted and loaded into the CkString object.

bool Matches(string strPattern, bool caseSensitive)

Returns true if the string matches the strPattern, which may contain one or more asterisk wildcard characters. Case-sensitivity is controlled by , where 1 = case sensitive, 0 = case insensitive.

ASP String Patttern Matching

string Mid(int index, int numChars)

Same as the VB/VBScript "Mid" function, except that the 1st char is at index 0 (i.e. it is not 1-based). Returns a substring of length numChars starting at index.

Returns null on failure

Date ParseDateRfc3339()

Converts the date string (in RFC 3339 format) to a Date type.

Convert RFC 3339 Date to String and back

Date ParseDateRfc822()

Converts the date string (in RFC 822 format) to a Date type.

Convert RFC 822 Date to String and back

void Pluralize()

Pluralizes an English word.

Pluralize English Word

void Prepend(string str)

Prepends str to this instance.

void PunyDecode()

Introduced in version 9.5.0.52

In-place decodes the string from punycode.

Punycode Encoding / Decoding

void PunyEncode()

Introduced in version 9.5.0.52

In-place encodes the string to punycode.

Punycode Encoding / Decoding

void RemoveAnsiChar(int ch)

Removes all occurances of ch from the string.

void ReplaceAll(string findStr, string replaceStr)

Replaces all occurances of findStr with replaceStr. (case sensitive)

void ReplaceAnsiChar(int findCh, int replaceCh)

Replaces all occurances of findCh with replaceCh.

void ReplaceFirst(string findStr, string replaceStr)

Replaces the first occurance of findStr with replaceStr. (case sensitive)

string Right(int numChars)

Returns a string that is the rightmost numChars of this instance.

Returns null on failure

bool SaveToFile(string path, string charsetEncoding)

Saves the string to a file, using the character encoding specified by charsetEncoding. This method allows for the string to be saved using character encodings such as "utf-8", "Unicode", "Shift-JIS", or anything else...

Returns true for success, false for failure.

Supported Character Encodings

void Shorten(int numChars)

Removes the final numChars from the string.

int StrComp(string str, bool caseSensitive)

Lexicographically compares two strings. Returns 0 if both strings are equal. A value greater than zero indicates that the first character that does not match has a greater value in the caller's string than in str; And a value less than zero indicates the opposite.

void StripHtml()

Strips HTML tags from a string.

Strip HTML from a String

void ToCRLF()

Converts all line endings to CRLF.

void ToLF()

Converts all line endings to bare-LF (Unix/Linux style).

void Trim()

Trim SPACE and Tab characters from both ends of the string.

void Trim2()

Trim SPACE, Tab, CR, and LF characters from both ends of the string.

void TrimInside()

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.

Trim Inside SPACE/TAB Characters

void Unpluralize()

Unpluralizes an English word.

Unpluralize English Word