CkString PHP Extension Reference Documentation

CkString

Current Version: 9.5.0.75

The Chilkat string class.

Object Creation

$obj = new CkString();

Properties

NumArabic
(read-only)
int get_NumArabic()
Introduced in version 9.5.0.25

The number of Arabic characters contained in this string.

top
NumAscii
(read-only)
int get_NumAscii()
Introduced in version 9.5.0.25

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

top
NumCentralEuro
(read-only)
int get_NumCentralEuro()
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.

top
NumChinese
(read-only)
int get_NumChinese()
Introduced in version 9.5.0.25

The number of Chinese characters contained in this string.

top
NumCyrillic
(read-only)
int get_NumCyrillic()
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.

top
NumGreek
(read-only)
int get_NumGreek()
Introduced in version 9.5.0.25

The number of Greek characters contained in this string.

top
NumHebrew
(read-only)
int get_NumHebrew()
Introduced in version 9.5.0.25

The number of Hebrew characters contained in this string.

top
NumJapanese
(read-only)
int get_NumJapanese()
Introduced in version 9.5.0.25

The number of Japanese characters contained in this string.

top
NumKorean
(read-only)
int get_NumKorean()
Introduced in version 9.5.0.25

The number of Korean characters contained in this string.

top
NumLatin
(read-only)
int get_NumLatin()
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.

top
NumThai
(read-only)
int get_NumThai()
Introduced in version 9.5.0.25

The number of Thai characters contained in this string.

top

Methods

append
void append(string str);

The str is appended to end of this instance.

top
appendAnsi
void appendAnsi(string str);

Appends an ANSI string to the end of this instance. str should always be a null terminated ANSI string regardless of the Utf8 property setting.

top
appendChar
void appendChar(char c);

Appends a single ANSI character to the end of this instance.

top
appendCurrentDateRfc822
void appendCurrentDateRfc822();

Appends the current date/time to the end of this instance. The date/time is formatted according to the RFC822 standard, which is the typical format used in the "Date" header field of email. For example: "Fri, 27 Jul 2012 17:41:41 -0500"

top
appendEnc
void appendEnc(string str, string charsetEncoding);

Appends a string of any character encoding to the end of this instance. Examples of charsetEncoding are: Shift_JIS, windows-1255, iso-8859-2, gb2312, etc. The str should point to a null-terminated string that uses the charset specified by charsetEncoding.

More Information and Examples
top
appendHexData
void appendHexData((binary) string byteData, int numBytes);

Converts the binary data to a hexidecimal string representation and appends to the end of this instance.

top
appendInt
void appendInt(int n);

Appends the decimal string representation of an integer to the end of this instance.

top
appendN
void appendN(string str, int numBytes);

Appends N bytes of character data to the end of this instance. If the Utf8 property is set to true, then str should point to characters in the utf-8 encoding, otherwise it should point to characters using the ANSI encoding. Note: numBytes is not necessarily the number of characters. It is the length, in bytes, of the string to be appended. This method exists to allow for non-null terminated strings to be appended.

top
appendNU
void appendNU((utf-16) string wideStr, int numChars);

Append N Unicode characters to the end of this instance. The wideStr points to the 2-byte per char Unicode string. The numChars is the number of Unicode characters to be appended (not the number of bytes).

top
appendRandom
void appendRandom(int numBytes, string encoding);

Appends numBytes random bytes to the end of this instance. Because arbitrary byte values in the range 0 to 255 do not necessarily represent valid characters, the bytes must be encoded to a string friendly representation such as hex, base64, etc. The encoding specifies the encoding to be used. Possible values are "hex", "base64", "quoted-printable", "asc", or "url".

top
appendStr
void appendStr(CkString strObj);

Appends the contents of strObj to the end of this instance.

top
appendU
void appendU((utf-16) string unicode);

Append a Unicode string to the CkString object.

top
appendUtf8
void appendUtf8(string str);

Appends a utf-8 string to the existing contents of this instance. str should always be a null terminated utf-8 string regardless of the Utf8 property setting.

top
base64Decode
void base64Decode(string charsetEncoding);

In-place base64 decodes the string and inteprets the results according to the character encoding specified.

More Information and Examples
top
base64DecodeW
void base64DecodeW((utf-16) string charsetEncoding);

The utf-16 version of base64Decode.

top
base64Encode
void base64Encode(string charsetEncoding);

In-place base64 encodes the string. Internally, the string is first converted to the character encoding specified and then base-64 encoded. Typical charsetEncoding values are "utf-8", "ANSI", "iso-8859-1", etc.

More Information and Examples
top
base64EncodeW
void base64EncodeW((utf-16) string charsetEncoding);

The utf-16 version of base64Encode.

top
beginsWith
bool beginsWith(string substr);

Return true if this string begins with substr (case sensitive), otherwise returns false.

top
beginsWithStr
bool beginsWithStr(CkString strObj);

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

top
beginsWithW
bool beginsWithW((utf-16) string str);

The utf-16 version of beginsWith.

top
charAt
char charAt(int idx);

Returns the ANSI character at a specified index.The first character is at index 0.

top
charAtU
(utf-16) char charAtU(int idx);

Return the Nth character as a Unicode character.

top
chopAtFirstChar
void chopAtFirstChar(char ch);

Finds the first occurrence of ch and discards the characters at and following ch.

top
chopAtStr
void chopAtStr(CkString subStrObj);

Finds the first occurrence of a substring and chops it at that point. The result is that the substring and all subsequent characters are removed from the string.

top
clear
void clear();

Clears the string. The string contains 0 characters after calling this method.

top
clone
CkString clone();

Creates a copy of the string. As with any newly created Chilkat object instance returned by a Chilkat method, the returned CkString object must be deleted by the calling application.

Returns null on failure

top
compareStr
int compareStr(CkString str);

Compare two strings. A return value = 0 means they are equal. Return value = 1 indicates that calling object is lexicographically less than argument. Return value = -1 indicates that calling object is lexicographically greater than argument.

top
containsSubstring
bool containsSubstring(string substr);

Returns true if the string contains the specified substring, otherwise returns false. The string comparison is case-sensitive.

top
containsSubstringNoCase
bool containsSubstringNoCase(string substr);

Same as containsSubstring except the matching is case insensitive.

top
containsSubstringNoCaseW
bool containsSubstringNoCaseW((utf-16) string substr);

The utf-16 version of containsSubstringNoCase.

top
containsSubstringW
bool containsSubstringW((utf-16) string substr);

The utf-16 version of containsSubstring.

top
countCharOccurances
int countCharOccurances(char ch);

Returns the number of occurrences of the specified ANSI char.

top
decodeXMLSpecial
void decodeXMLSpecial();

Decodes XML special characters. For example, < is converted to '<'

top
doubleValue
double doubleValue();

Converts the string to a double and returns the value.

top
eliminateChar
void eliminateChar(char ansiChar, int startIndex);

Eliminate all occurrences of a particular ANSI character.

top
encodeXMLSpecial
void encodeXMLSpecial();

Encodes XML special characters. For example, '<' is converted to <

top
endsWith
bool endsWith(string substr);

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

top
endsWithStr
bool endsWithStr(CkString substrObj);

Returns true if the string ends with the specified substring, otherwise returns false.

top
endsWithW
bool endsWithW((utf-16) string s);

The utf-16 version of endsWith.

top
entityDecode
void entityDecode();

Decodes any HTML entities found within the string, replacing them with the characters represented.

top
entityEncode
void entityEncode();

HTML encodes any characters that are special to HTML or cannot be represented by 7-bit us-ascii.

top
equals
bool equals(string str);

Returns true if the strings are equal, otherwise returns false. (case-sensitive)

top
equalsIgnoreCase
bool equalsIgnoreCase(string str);

Returns true if the strings are equal, otherwise returns false. (case-insensitive)

top
equalsIgnoreCaseStr
bool equalsIgnoreCaseStr(CkString strObj);

Returns true if the strings are equal, otherwise returns false (case-insensitive)

top
equalsIgnoreCaseW
bool equalsIgnoreCaseW((utf-16) string s);

The utf-16 version of equalsIgnoreCase.

top
equalsStr
bool equalsStr(CkString strObj);

Returns true if the strings are equal, otherwise returns false. (case-sensitive)

top
equalsW
bool equalsW((utf-16) string s);

The utf-16 version of the "equals" method.

top
getChar
CkString getChar(int idx);

Returns a new CkString object containing the Nth character. (Note, it does not contain the Nth byte, but the Nth character.) For languages such as Chinese, Japanese, etc. individual characters are represented by multiple or varying number of bytes.

Returns null on failure

top
getEnc
string getEnc(string encoding);

Returns the string as a null-terminated byte sequence in the character encoding specified by encoding. The encoding can be any encoding specified at the link below, except for charsets that contain 0 (null) bytes in individual character byte representations, such as utf-16, utf-32, etc.

top
getNumChars
int getNumChars();

Returns the number of characters in the string.

top
getSizeAnsi
int getSizeAnsi();

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

top
getSizeUnicode
int getSizeUnicode();

Returns the size, in bytes, of the Unicode encoding of the string.

top
getSizeUtf8
int getSizeUtf8();

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

top
getString
string getString();

Returns the contents of this instance.

top
getStringAnsi
string getStringAnsi();

Returns the string as null-terminated ANSI.

top
getStringUtf8
string getStringUtf8();

Returns the string as null-terminated utf-8.

top
getUnicode
(utf-16) string getUnicode();

Return a pointer to memory containing the string in Unicode.

top
hexDecode
void hexDecode(string charsetEncoding);

Hex decodes a string and inteprets the bytes according to the character encoding specified.

More Information and Examples
top
hexDecodeW
void hexDecodeW((utf-16) string charsetEncoding);

The utf-16 version of hexDecode.

top
hexEncode
void hexEncode(string charsetEncoding);

Converts the string to the character encoding specified and replaces the string contents with the hex encoding of the character data.

More Information and Examples
top
hexEncodeW
void hexEncodeW((utf-16) string charsetEncoding);

The utf-16 version of hexEncode.

top
indexOf
int indexOf(string substr);

Returns the index of the first occurrence of a substring. Returns -1 if not found.

top
indexOfStr
int indexOfStr(CkString substrObj);

Returns the index of the first occurrence of a substring. Returns -1 if not found.

top
indexOfW
int indexOfW((utf-16) string s);

The utf-16 version of "indexOf".

top
intValue
int intValue();

Converts the string to an integer and returns the integer value.

top
isEmpty
bool isEmpty();

Returns true if the string object is empty, otherwise returns false.

top
lastChar
char lastChar();

Returns the last ANSI character in the string.

top
loadFile
bool loadFile(string path, string charsetEncoding);

Load the contents of a text file into the CkString object. The string is cleared before loading. 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.

Returns true for success, false for failure.

More Information and Examples
top
loadFileW
bool loadFileW((utf-16) string path, (utf-16) string charsetEncoding);

The utf-16 version of loadFile.

Returns true for success, false for failure.

top
matches
bool matches(string strPattern);

Returns true if the string matches the strPattern, which may contain one or more asterisk wildcard characters. Returns false if the string does not match. This method is case-sensitive.

top
matchesNoCase
bool matchesNoCase(string strPattern);

Returns true if the string matches the strPattern, which may contain one or more asterisk wildcard characters. Returns false if the string does not match. This method is case-insensitive.

top
matchesNoCaseW
bool matchesNoCaseW((utf-16) string s);

The utf-16 version of matchesNoCase.

top
matchesStr
bool matchesStr(CkString strPatternObj);

Returns true if the string matches a pattern, otherwise returns false. The pattern may contain any number of wildcard '*' characters which represent 0 or more occurrences of any character. This method is case-sensitive.

top
matchesW
bool matchesW((utf-16) string s);

The utf-16 version of the "matches" method.

top
minimizeMemory
void minimizeMemory();

Minimizes the amount of memory consumed by this object. For example, consider the following: A CkString object is loaded with the contents of a text file. The "replaceAllOccurances" method is called, replacing longer substrings with shorter replacements. The actual string length will become shorter than the internal buffer space that is allocated. The minimizeMemory method will, if necessary, allocate a new internal buffer that is exactly the size needed to hold the current contents of the string, copy the string to the new internal buffer, and deallocate the old buffer.

top
obfuscate
void obfuscate();

Obfuscates the string. (The unobfuscate method can be called to reverse the obfuscation to restore the original string.)

The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is not a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.

top
prepend
void prepend(string str);

Prepends str to this instance.

top
prependW
void prependW((utf-16) string s);

The utf-16 version of the "prepend" method.

top
punyDecode
void punyDecode();
Introduced in version 9.5.0.52

In-place decodes the string from punycode.

More Information and Examples
top
punyEncode
void punyEncode();
Introduced in version 9.5.0.52

In-place encodes the string to punycode.

More Information and Examples
top
qpDecode
void qpDecode(string charsetEncoding);

Quoted-printable decodes the string and interprets the resulting character data according to the specified character encoding. The result is that the quoted-printable string is in-place decoded.

More Information and Examples
top
qpDecodeW
void qpDecodeW((utf-16) string charset);

The utf-16 version of the qpDecode method.

top
qpEncode
void qpEncode(string charsetEncoding);

Quoted-printable encodes the string. The string is first converted to the charset specified, and those bytes are QP-encoded. The contents of the string are replaced with the QP-encoded result.

More Information and Examples
top
qpEncodeW
void qpEncodeW((utf-16) string charset);

The utf-16 version of the qpEncode method.

top
removeAll
int removeAll(CkString substr);

Removes all occurrences of substr.

top
removeCharOccurances
void removeCharOccurances(char ch);

Removes all occurrences of a specific ANSI character from the string.

top
removeChunk
void removeChunk(int charStartPos, int numChars);

Removes a chunk of characters specified by starting index and length.

top
removeDelimited
void removeDelimited(string beginDelim, string endDelim, bool caseSensitive);
Introduced in version 9.5.0.52

Remove all occurrences of strings delimited by beginDelim and endDelim. Also removes the delimiters.

top
removeFirst
bool removeFirst(CkString substr);

Removes the first occurrence of a substring.

top
replaceAll
int replaceAll(CkString findStrObj, CkString replaceStrObj);

Replaces all occurrences of a substring with another. The replacement string is allowed to be empty or different in length.

top
replaceAllOccurances
int replaceAllOccurances(string findStr, string replaceStr);

Replaces all occurrences of a substring with another substring. The replacement string is allowed to be empty or different in length.

top
replaceAllOccurancesW
int replaceAllOccurancesW((utf-16) string pattern, (utf-16) string replacement);

The utf-16 version of the replaceAllOccurances method.

top
replaceChar
void replaceChar(char findCh, char replaceCh);

Replaces all occurrences of a specified ANSI character with another.

top
replaceFirst
bool replaceFirst(CkString findStrObj, CkString replaceStrObj);

Replaces the first occurrence of a substring with another. The replacement string is allowed to be empty or different in length.

top
replaceFirstOccurance
bool replaceFirstOccurance(string findStr, string replaceStr);

Replaces the first occurrence of a substring with another. The replacement string is allowed to be empty or different in length. (Chilkat is aware of the misspelling of the word "occurrence", but unfortunately it is too late to change..)

top
replaceFirstOccuranceW
bool replaceFirstOccuranceW((utf-16) string pattern, (utf-16) string replacement);

The utf-16 version of replaceFirstOccurrance. (Chilkat is aware of the misspelling of the word "occurrence", but unfortunately it is too late to change..)

top
saveToFile
bool saveToFile(string path, string charsetEncoding);

Saves the string to a file using the character encoding specified by charsetEncoding. If a file of the same name exists, it is overwritten. For charsets such as "utf-8", "utf-16", or others that have a possible BOM/preamble, the preamble is output by default. To exclude the BOM/preamble, prepend "no-bom-" to the charset name. For example "no-bom-utf-8".

Returns true for success, false for failure.

More Information and Examples
top
saveToFileW
bool saveToFileW((utf-16) string path, (utf-16) string charset);

The utf-16 version of the saveToFile method.

Returns true for success, false for failure.

top
setStr
void setStr(CkString s);

Replaces the contents of the string with another.

top
setString
void setString(string str);

Clears the contents of this instance and appends str.

top
setStringAnsi
void setStringAnsi(string s);

Set the CkString object from an ANSI string.

top
setStringU
void setStringU((utf-16) string unicode);

Set the CkString object from a Unicode string.

top
setStringUtf8
void setStringUtf8(string s);

Set the string object from a utf-8 string.

top
shorten
void shorten(int n);

Discards the last N characters.

top
split
CkStringArray split(char delimiterChar, bool exceptDoubleQuoted, bool exceptEscaped, bool keepEmpty);

Splits a string into a collection of strings using a delimiter character. If exceptEscaped is true, then delimiter chars escaped with a backslash are ignored. If exceptDoubleQuoted is true, then delimiter chars inside quotes are ignored. If keepEmpty is false, then empty strings are excluded from being added to the returned CkStringArray object.

Returns null on failure

top
split2
CkStringArray split2(string delimiterChars, bool exceptDoubleQuoted, bool exceptEscaped, bool keepEmpty);

Same as "split", except a set of characters can be used for delimiters.

Returns null on failure

top
split2W
CkStringArray split2W((utf-16) string splitCharSet, bool exceptDoubleQuoted, bool exceptEscaped, bool keepEmpty);

The utf-16 version of the split2 method.

Returns null on failure

top
splitAtWS
CkStringArray splitAtWS();

Equivalent to split2(" \t\r\n",true,true,false)

Returns null on failure

top
substring
CkString substring(int startCharIndex, int numChars);

Returns a substring specified by starting character position and number of characters. (The 1st char is at index 0.)

Returns null on failure

top
toCRLF
void toCRLF();

Converts all line endings to CRLF.

top
tokenize
CkStringArray tokenize(string punctuation);

Tokenizes a string. The string is split at whitespace characters, and any single punctuation character is returned as a separate token. For example, this string:
CkStringArray *CkString::tokenize(char *punctuation) const

is tokenized to

CkStringArray
*
CkString
:
:
tokenize
(
*
punctuation
)
const

Returns null on failure

top
tokenizeW
CkStringArray tokenizeW((utf-16) string punctuation);

The utf-16 version of the "tokenize" method.

Returns null on failure

top
toLF
void toLF();

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

top
toLowerCase
void toLowerCase();

Converts the string to lowercase.

top
toUpperCase
void toUpperCase();

Converts the string to uppercase.

top
trim
void trim();

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

top
trim2
void trim2();

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

top
trimInsideSpaces
void trimInsideSpaces();

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

top
unobfuscate
void unobfuscate();

Unobfuscates the string.

The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is not a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.

top
urlDecode
void urlDecode(string charsetEncoding);

URL decodes the string and interprets the resulting byte data in the specified charset encoding.

More Information and Examples
top
urlDecodeW
void urlDecodeW((utf-16) string charsetEncoding);

The utf-16 version of the urlDecode method.

top
urlEncode
void urlEncode(string charsetEncoding);

URL encodes the string. The string is first converted to the specified charset encoding, and those bytes are URL-encoded. The contents of the string are replaced with the URL-encoded result.

More Information and Examples
top
urlEncodeW
void urlEncodeW((utf-16) string charsetEncoding);

The utf-16 version of the urlEncode method.

top