---
product: Chilkat
product_version: 11.7.0
language: phpext
language_label: PHP Extension
class: CkString
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/phpExtCkStringRef.html
---
# Chilkat CkString — PHP Extension — v11.7.0

> Chilkat 11.7.0 · language=phpext · class=CkString
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/CkString.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/guide.md`.

## Purpose

The Chilkat string class.

## Object creation, unlocking and error handling

**Object Creation**

```php
$obj = new CkString();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in PHP Extension.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Member index

| Member | Kind | Signature |
|---|---|---|
| `NumArabic` | property, read-only | `(read-only) int get_NumArabic()` |
| `NumAscii` | property, read-only | `(read-only) int get_NumAscii()` |
| `NumCentralEuro` | property, read-only | `(read-only) int get_NumCentralEuro()` |
| `NumChinese` | property, read-only | `(read-only) int get_NumChinese()` |
| `NumCyrillic` | property, read-only | `(read-only) int get_NumCyrillic()` |
| `NumGreek` | property, read-only | `(read-only) int get_NumGreek()` |
| `NumHebrew` | property, read-only | `(read-only) int get_NumHebrew()` |
| `NumJapanese` | property, read-only | `(read-only) int get_NumJapanese()` |
| `NumKorean` | property, read-only | `(read-only) int get_NumKorean()` |
| `NumLatin` | property, read-only | `(read-only) int get_NumLatin()` |
| `NumThai` | property, read-only | `(read-only) int get_NumThai()` |
| `append` | method | `void append(string $str);` |
| `appendAnsi` | method | `void appendAnsi(string $str);` |
| `appendChar` | method | `void appendChar(char $c);` |
| `appendCurrentDateRfc822` | method | `void appendCurrentDateRfc822();` |
| `appendEnc` | method | `void appendEnc(string $str, string $charsetEncoding);` |
| `appendInt` | method | `void appendInt(int $n);` |
| `appendN` | method | `void appendN(string $str, int $numBytes);` |
| `appendNU` | method | `void appendNU((utf-16) string $wideStr, int $numChars);` |
| `appendRandom` | method | `void appendRandom(int $numBytes, string $encoding);` |
| `appendStr` | method | `void appendStr(CkString $strObj);` |
| `appendU` | method | `void appendU((utf-16) string $unicode);` |
| `appendUtf8` | method | `void appendUtf8(string $str);` |
| `base64Decode` | method | `void base64Decode(string $charsetEncoding);` |
| `base64DecodeW` | method | `void base64DecodeW((utf-16) string $charsetEncoding);` |
| `base64Encode` | method | `void base64Encode(string $charsetEncoding);` |
| `base64EncodeW` | method | `void base64EncodeW((utf-16) string $charsetEncoding);` |
| `beginsWith` | method | `bool beginsWith(string $substr);` |
| `beginsWithStr` | method | `bool beginsWithStr(CkString $strObj);` |
| `beginsWithW` | method | `bool beginsWithW((utf-16) string $str);` |
| `charAt` | method | `char charAt(int $idx);` |
| `charAtU` | method | `(utf-16) char charAtU(int $idx);` |
| `chopAtFirstChar` | method | `void chopAtFirstChar(char $ch);` |
| `chopAtStr` | method | `void chopAtStr(CkString $subStrObj);` |
| `clear` | method | `void clear();` |
| `clone` | method | `CkString clone();` |
| `compareStr` | method | `int compareStr(CkString $str);` |
| `containsSubstring` | method | `bool containsSubstring(string $substr);` |
| `containsSubstringNoCase` | method | `bool containsSubstringNoCase(string $substr);` |
| `containsSubstringNoCaseW` | method | `bool containsSubstringNoCaseW((utf-16) string $substr);` |
| `containsSubstringW` | method | `bool containsSubstringW((utf-16) string $substr);` |
| `countCharOccurances` | method | `int countCharOccurances(char $ch);` |
| `decodeXMLSpecial` | method | `void decodeXMLSpecial();` |
| `doubleValue` | method | `double doubleValue();` |
| `eliminateChar` | method | `void eliminateChar(char $ansiChar, int $startIndex);` |
| `encodeXMLSpecial` | method | `void encodeXMLSpecial();` |
| `endsWith` | method | `bool endsWith(string $substr);` |
| `endsWithStr` | method | `bool endsWithStr(CkString $substrObj);` |
| `endsWithW` | method | `bool endsWithW((utf-16) string $s);` |
| `entityDecode` | method | `void entityDecode();` |
| `entityEncode` | method | `void entityEncode();` |
| `equals` | method | `bool equals(string $str);` |
| `equalsIgnoreCase` | method | `bool equalsIgnoreCase(string $str);` |
| `equalsIgnoreCaseStr` | method | `bool equalsIgnoreCaseStr(CkString $strObj);` |
| `equalsIgnoreCaseW` | method | `bool equalsIgnoreCaseW((utf-16) string $s);` |
| `equalsStr` | method | `bool equalsStr(CkString $strObj);` |
| `equalsW` | method | `bool equalsW((utf-16) string $s);` |
| `getChar` | method | `CkString getChar(int $idx);` |
| `getNumChars` | method | `int getNumChars();` |
| `getSizeAnsi` | method | `int getSizeAnsi();` |
| `getSizeUnicode` | method | `int getSizeUnicode();` |
| `getSizeUtf8` | method | `int getSizeUtf8();` |
| `getUnicode` | method | `(utf-16) string getUnicode();` |
| `hexDecode` | method | `void hexDecode(string $charsetEncoding);` |
| `hexDecodeW` | method | `void hexDecodeW((utf-16) string $charsetEncoding);` |
| `hexEncode` | method | `void hexEncode(string $charsetEncoding);` |
| `hexEncodeW` | method | `void hexEncodeW((utf-16) string $charsetEncoding);` |
| `indexOf` | method | `int indexOf(string $substr);` |
| `indexOfStr` | method | `int indexOfStr(CkString $substrObj);` |
| `indexOfW` | method | `int indexOfW((utf-16) string $s);` |
| `intValue` | method | `int intValue();` |
| `isEmpty` | method | `bool isEmpty();` |
| `lastChar` | method | `char lastChar();` |
| `loadFile` | method | `bool loadFile(string $path, string $charsetEncoding);` |
| `loadFileW` | method | `bool loadFileW((utf-16) string $path, (utf-16) string $charsetEncoding);` |
| `matches` | method | `bool matches(string $strPattern);` |
| `matchesNoCase` | method | `bool matchesNoCase(string $strPattern);` |
| `matchesNoCaseW` | method | `bool matchesNoCaseW((utf-16) string $s);` |
| `matchesStr` | method | `bool matchesStr(CkString $strPatternObj);` |
| `matchesW` | method | `bool matchesW((utf-16) string $s);` |
| `minimizeMemory` | method | `void minimizeMemory();` |
| `obfuscate` | method | `void obfuscate();` |
| `prepend` | method | `void prepend(string $str);` |
| `prependW` | method | `void prependW((utf-16) string $s);` |
| `punyDecode` | method | `void punyDecode();` |
| `punyEncode` | method | `void punyEncode();` |
| `qpDecode` | method | `void qpDecode(string $charsetEncoding);` |
| `qpDecodeW` | method | `void qpDecodeW((utf-16) string $charset);` |
| `qpEncode` | method | `void qpEncode(string $charsetEncoding);` |
| `qpEncodeW` | method | `void qpEncodeW((utf-16) string $charset);` |
| `removeAll` | method | `int removeAll(CkString $substr);` |
| `removeCharOccurances` | method | `void removeCharOccurances(char $ch);` |
| `removeChunk` | method | `void removeChunk(int $charStartPos, int $numChars);` |
| `removeDelimited` | method | `void removeDelimited(string $beginDelim, string $endDelim, bool $caseSensitive);` |
| `removeFirst` | method | `bool removeFirst(CkString $substr);` |
| `replaceAll` | method | `int replaceAll(CkString $findStrObj, CkString $replaceStrObj);` |
| `replaceAllOccurances` | method | `int replaceAllOccurances(string $findStr, string $replaceStr);` |
| `replaceAllOccurancesW` | method | `int replaceAllOccurancesW((utf-16) string $pattern, (utf-16) string $replacement);` |
| `replaceChar` | method | `void replaceChar(char $findCh, char $replaceCh);` |
| `replaceFirst` | method | `bool replaceFirst(CkString $findStrObj, CkString $replaceStrObj);` |
| `replaceFirstOccurance` | method | `bool replaceFirstOccurance(string $findStr, string $replaceStr);` |
| `replaceFirstOccuranceW` | method | `bool replaceFirstOccuranceW((utf-16) string $pattern, (utf-16) string $replacement);` |
| `saveToFile` | method | `bool saveToFile(string $path, string $charsetEncoding);` |
| `saveToFileW` | method | `bool saveToFileW((utf-16) string $path, (utf-16) string $charset);` |
| `setStr` | method | `void setStr(CkString $s);` |
| `setString` | method | `void setString(string $str);` |
| `setStringAnsi` | method | `void setStringAnsi(string $s);` |
| `setStringU` | method | `void setStringU((utf-16) string $unicode);` |
| `setStringUtf8` | method | `void setStringUtf8(string $s);` |
| `shorten` | method | `void shorten(int $n);` |
| `split` | method | `CkStringArray split(char $delimiterChar, bool $exceptDoubleQuoted, bool $exceptEscaped, bool $keepEmpty);` |
| `split2` | method | `CkStringArray split2(string $delimiterChars, bool $exceptDoubleQuoted, bool $exceptEscaped, bool $keepEmpty);` |
| `split2W` | method | `CkStringArray split2W((utf-16) string $splitCharSet, bool $exceptDoubleQuoted, bool $exceptEscaped, bool $keepEmpty);` |
| `splitAtWS` | method | `CkStringArray splitAtWS();` |
| `substring` | method | `CkString substring(int $startCharIndex, int $numChars);` |
| `toCRLF` | method | `void toCRLF();` |
| `tokenize` | method | `CkStringArray tokenize(string $punctuation);` |
| `tokenizeW` | method | `CkStringArray tokenizeW((utf-16) string $punctuation);` |
| `toLF` | method | `void toLF();` |
| `toLowerCase` | method | `void toLowerCase();` |
| `toUpperCase` | method | `void toUpperCase();` |
| `trim` | method | `void trim();` |
| `trim2` | method | `void trim2();` |
| `trimInsideSpaces` | method | `void trimInsideSpaces();` |
| `unobfuscate` | method | `void unobfuscate();` |
| `urlDecode` | method | `void urlDecode(string $charsetEncoding);` |
| `urlDecodeW` | method | `void urlDecodeW((utf-16) string $charsetEncoding);` |
| `urlEncode` | method | `void urlEncode(string $charsetEncoding);` |
| `urlEncodeW` | method | `void urlEncodeW((utf-16) string $charsetEncoding);` |

## Properties

### CkString.NumArabic

`Chilkat 11.7.0 · phpext · CkString · NumArabic · property · read-only · since 9.5.0.25`

```php
(read-only)

int get_NumArabic()
```

The number of Arabic characters contained in this string.

### CkString.NumAscii

`Chilkat 11.7.0 · phpext · CkString · NumAscii · property · read-only · since 9.5.0.25`

```php
(read-only)

int get_NumAscii()
```

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

### CkString.NumCentralEuro

`Chilkat 11.7.0 · phpext · CkString · NumCentralEuro · property · read-only · since 9.5.0.25`

```php
(read-only)

int get_NumCentralEuro()
```

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.

### CkString.NumChinese

`Chilkat 11.7.0 · phpext · CkString · NumChinese · property · read-only · since 9.5.0.25`

```php
(read-only)

int get_NumChinese()
```

The number of Chinese characters contained in this string.

### CkString.NumCyrillic

`Chilkat 11.7.0 · phpext · CkString · NumCyrillic · property · read-only · since 9.5.0.25`

```php
(read-only)

int get_NumCyrillic()
```

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.

### CkString.NumGreek

`Chilkat 11.7.0 · phpext · CkString · NumGreek · property · read-only · since 9.5.0.25`

```php
(read-only)

int get_NumGreek()
```

The number of Greek characters contained in this string.

### CkString.NumHebrew

`Chilkat 11.7.0 · phpext · CkString · NumHebrew · property · read-only · since 9.5.0.25`

```php
(read-only)

int get_NumHebrew()
```

The number of Hebrew characters contained in this string.

### CkString.NumJapanese

`Chilkat 11.7.0 · phpext · CkString · NumJapanese · property · read-only · since 9.5.0.25`

```php
(read-only)

int get_NumJapanese()
```

The number of Japanese characters contained in this string.

### CkString.NumKorean

`Chilkat 11.7.0 · phpext · CkString · NumKorean · property · read-only · since 9.5.0.25`

```php
(read-only)

int get_NumKorean()
```

The number of Korean characters contained in this string.

### CkString.NumLatin

`Chilkat 11.7.0 · phpext · CkString · NumLatin · property · read-only · since 9.5.0.25`

```php
(read-only)

int get_NumLatin()
```

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.

**Note:** This is the number of chars that are Latin characters that do not fall in the us-ascii range. In other words, the 8bit Latin chars.

### CkString.NumThai

`Chilkat 11.7.0 · phpext · CkString · NumThai · property · read-only · since 9.5.0.25`

```php
(read-only)

int get_NumThai()
```

The number of Thai characters contained in this string.

## Methods

### CkString.append

`Chilkat 11.7.0 · phpext · CkString · append · method`

```php
void append(string $str);
```

The `str` is appended to end of this instance.

### CkString.appendAnsi

`Chilkat 11.7.0 · phpext · CkString · appendAnsi · method`

```php
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.

### CkString.appendChar

`Chilkat 11.7.0 · phpext · CkString · appendChar · method`

```php
void appendChar(char $c);
```

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

### CkString.appendCurrentDateRfc822

`Chilkat 11.7.0 · phpext · CkString · appendCurrentDateRfc822 · method`

```php
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`

### CkString.appendEnc

`Chilkat 11.7.0 · phpext · CkString · appendEnc · method`

```php
void appendEnc(string $str, string $charsetEncoding);
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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

### CkString.appendInt

`Chilkat 11.7.0 · phpext · CkString · appendInt · method`

```php
void appendInt(int $n);
```

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

### CkString.appendN

`Chilkat 11.7.0 · phpext · CkString · appendN · method`

```php
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.

### CkString.appendNU

`Chilkat 11.7.0 · phpext · CkString · appendNU · method`

```php
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).

### CkString.appendRandom

`Chilkat 11.7.0 · phpext · CkString · appendRandom · method`

```php
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`.

### CkString.appendStr

`Chilkat 11.7.0 · phpext · CkString · appendStr · method`

```php
void appendStr(CkString $strObj);
```

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

### CkString.appendU

`Chilkat 11.7.0 · phpext · CkString · appendU · method`

```php
void appendU((utf-16) string $unicode);
```

Append a Unicode string to the CkString object.

### CkString.appendUtf8

`Chilkat 11.7.0 · phpext · CkString · appendUtf8 · method`

```php
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.

### CkString.base64Decode

`Chilkat 11.7.0 · phpext · CkString · base64Decode · method`

```php
void base64Decode(string $charsetEncoding);
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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

### CkString.base64DecodeW

`Chilkat 11.7.0 · phpext · CkString · base64DecodeW · method`

```php
void base64DecodeW((utf-16) string $charsetEncoding);
```

The utf-16 version of base64Decode.

### CkString.base64Encode

`Chilkat 11.7.0 · phpext · CkString · base64Encode · method`

```php
void base64Encode(string $charsetEncoding);
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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.

### CkString.base64EncodeW

`Chilkat 11.7.0 · phpext · CkString · base64EncodeW · method`

```php
void base64EncodeW((utf-16) string $charsetEncoding);
```

The utf-16 version of base64Encode.

### CkString.beginsWith

`Chilkat 11.7.0 · phpext · CkString · beginsWith · method`

```php
bool beginsWith(string $substr);
```

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

### CkString.beginsWithStr

`Chilkat 11.7.0 · phpext · CkString · beginsWithStr · method`

```php
bool beginsWithStr(CkString $strObj);
```

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

### CkString.beginsWithW

`Chilkat 11.7.0 · phpext · CkString · beginsWithW · method`

```php
bool beginsWithW((utf-16) string $str);
```

The utf-16 version of beginsWith.

### CkString.charAt

`Chilkat 11.7.0 · phpext · CkString · charAt · method`

```php
char charAt(int $idx);
```

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

### CkString.charAtU

`Chilkat 11.7.0 · phpext · CkString · charAtU · method`

```php
(utf-16) char charAtU(int $idx);
```

Return the Nth character as a Unicode character.

### CkString.chopAtFirstChar

`Chilkat 11.7.0 · phpext · CkString · chopAtFirstChar · method`

```php
void chopAtFirstChar(char $ch);
```

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

### CkString.chopAtStr

`Chilkat 11.7.0 · phpext · CkString · chopAtStr · method`

```php
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.

### CkString.clear

`Chilkat 11.7.0 · phpext · CkString · clear · method`

```php
void clear();
```

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

### CkString.clone

`Chilkat 11.7.0 · phpext · CkString · clone · method`

```php
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

### CkString.compareStr

`Chilkat 11.7.0 · phpext · CkString · compareStr · method`

```php
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.

### CkString.containsSubstring

`Chilkat 11.7.0 · phpext · CkString · containsSubstring · method`

```php
bool containsSubstring(string $substr);
```

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

### CkString.containsSubstringNoCase

`Chilkat 11.7.0 · phpext · CkString · containsSubstringNoCase · method`

```php
bool containsSubstringNoCase(string $substr);
```

Same as containsSubstring except the matching is case insensitive.

### CkString.containsSubstringNoCaseW

`Chilkat 11.7.0 · phpext · CkString · containsSubstringNoCaseW · method`

```php
bool containsSubstringNoCaseW((utf-16) string $substr);
```

The utf-16 version of containsSubstringNoCase.

### CkString.containsSubstringW

`Chilkat 11.7.0 · phpext · CkString · containsSubstringW · method`

```php
bool containsSubstringW((utf-16) string $substr);
```

The utf-16 version of containsSubstring.

### CkString.countCharOccurances

`Chilkat 11.7.0 · phpext · CkString · countCharOccurances · method`

```php
int countCharOccurances(char $ch);
```

Returns the number of occurrences of the specified ANSI char.

### CkString.decodeXMLSpecial

`Chilkat 11.7.0 · phpext · CkString · decodeXMLSpecial · method`

```php
void decodeXMLSpecial();
```

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

### CkString.doubleValue

`Chilkat 11.7.0 · phpext · CkString · doubleValue · method`

```php
double doubleValue();
```

Converts the string to a double and returns the value.

### CkString.eliminateChar

`Chilkat 11.7.0 · phpext · CkString · eliminateChar · method`

```php
void eliminateChar(char $ansiChar, int $startIndex);
```

Eliminate all occurrences of a particular ANSI character.

### CkString.encodeXMLSpecial

`Chilkat 11.7.0 · phpext · CkString · encodeXMLSpecial · method`

```php
void encodeXMLSpecial();
```

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

### CkString.endsWith

`Chilkat 11.7.0 · phpext · CkString · endsWith · method`

```php
bool endsWith(string $substr);
```

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

### CkString.endsWithStr

`Chilkat 11.7.0 · phpext · CkString · endsWithStr · method`

```php
bool endsWithStr(CkString $substrObj);
```

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

### CkString.endsWithW

`Chilkat 11.7.0 · phpext · CkString · endsWithW · method`

```php
bool endsWithW((utf-16) string $s);
```

The utf-16 version of endsWith.

### CkString.entityDecode

`Chilkat 11.7.0 · phpext · CkString · entityDecode · method`

```php
void entityDecode();
```

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

### CkString.entityEncode

`Chilkat 11.7.0 · phpext · CkString · entityEncode · method`

```php
void entityEncode();
```

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

### CkString.equals

`Chilkat 11.7.0 · phpext · CkString · equals · method`

```php
bool equals(string $str);
```

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

### CkString.equalsIgnoreCase

`Chilkat 11.7.0 · phpext · CkString · equalsIgnoreCase · method`

```php
bool equalsIgnoreCase(string $str);
```

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

### CkString.equalsIgnoreCaseStr

`Chilkat 11.7.0 · phpext · CkString · equalsIgnoreCaseStr · method`

```php
bool equalsIgnoreCaseStr(CkString $strObj);
```

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

### CkString.equalsIgnoreCaseW

`Chilkat 11.7.0 · phpext · CkString · equalsIgnoreCaseW · method`

```php
bool equalsIgnoreCaseW((utf-16) string $s);
```

The utf-16 version of equalsIgnoreCase.

### CkString.equalsStr

`Chilkat 11.7.0 · phpext · CkString · equalsStr · method`

```php
bool equalsStr(CkString $strObj);
```

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

### CkString.equalsW

`Chilkat 11.7.0 · phpext · CkString · equalsW · method`

```php
bool equalsW((utf-16) string $s);
```

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

### CkString.getChar

`Chilkat 11.7.0 · phpext · CkString · getChar · method`

```php
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

### CkString.getNumChars

`Chilkat 11.7.0 · phpext · CkString · getNumChars · method`

```php
int getNumChars();
```

Returns the number of characters in the string.

### CkString.getSizeAnsi

`Chilkat 11.7.0 · phpext · CkString · getSizeAnsi · method`

```php
int getSizeAnsi();
```

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

### CkString.getSizeUnicode

`Chilkat 11.7.0 · phpext · CkString · getSizeUnicode · method`

```php
int getSizeUnicode();
```

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

### CkString.getSizeUtf8

`Chilkat 11.7.0 · phpext · CkString · getSizeUtf8 · method`

```php
int getSizeUtf8();
```

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

### CkString.getUnicode

`Chilkat 11.7.0 · phpext · CkString · getUnicode · method`

```php
(utf-16) string getUnicode();
```

Return a pointer to memory containing the string in Unicode.

### CkString.hexDecode

`Chilkat 11.7.0 · phpext · CkString · hexDecode · method`

```php
void hexDecode(string $charsetEncoding);
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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

### CkString.hexDecodeW

`Chilkat 11.7.0 · phpext · CkString · hexDecodeW · method`

```php
void hexDecodeW((utf-16) string $charsetEncoding);
```

The utf-16 version of hexDecode.

### CkString.hexEncode

`Chilkat 11.7.0 · phpext · CkString · hexEncode · method`

```php
void hexEncode(string $charsetEncoding);
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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

### CkString.hexEncodeW

`Chilkat 11.7.0 · phpext · CkString · hexEncodeW · method`

```php
void hexEncodeW((utf-16) string $charsetEncoding);
```

The utf-16 version of hexEncode.

### CkString.indexOf

`Chilkat 11.7.0 · phpext · CkString · indexOf · method`

```php
int indexOf(string $substr);
```

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

### CkString.indexOfStr

`Chilkat 11.7.0 · phpext · CkString · indexOfStr · method`

```php
int indexOfStr(CkString $substrObj);
```

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

### CkString.indexOfW

`Chilkat 11.7.0 · phpext · CkString · indexOfW · method`

```php
int indexOfW((utf-16) string $s);
```

The utf-16 version of `indexOf`.

### CkString.intValue

`Chilkat 11.7.0 · phpext · CkString · intValue · method`

```php
int intValue();
```

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

### CkString.isEmpty

`Chilkat 11.7.0 · phpext · CkString · isEmpty · method`

```php
bool isEmpty();
```

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

### CkString.lastChar

`Chilkat 11.7.0 · phpext · CkString · lastChar · method`

```php
char lastChar();
```

Returns the last ANSI character in the string.

### CkString.loadFile

`Chilkat 11.7.0 · phpext · CkString · loadFile · method`

```php
bool loadFile(string $path, string $charsetEncoding);
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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.

### CkString.loadFileW

`Chilkat 11.7.0 · phpext · CkString · loadFileW · method`

```php
bool loadFileW((utf-16) string $path, (utf-16) string $charsetEncoding);
```

The utf-16 version of loadFile.

Returns true for success, false for failure.

### CkString.matches

`Chilkat 11.7.0 · phpext · CkString · matches · method`

```php
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.

### CkString.matchesNoCase

`Chilkat 11.7.0 · phpext · CkString · matchesNoCase · method`

```php
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.

### CkString.matchesNoCaseW

`Chilkat 11.7.0 · phpext · CkString · matchesNoCaseW · method`

```php
bool matchesNoCaseW((utf-16) string $s);
```

The utf-16 version of matchesNoCase.

### CkString.matchesStr

`Chilkat 11.7.0 · phpext · CkString · matchesStr · method`

```php
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.

### CkString.matchesW

`Chilkat 11.7.0 · phpext · CkString · matchesW · method`

```php
bool matchesW((utf-16) string $s);
```

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

### CkString.minimizeMemory

`Chilkat 11.7.0 · phpext · CkString · minimizeMemory · method`

```php
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.

### CkString.obfuscate

`Chilkat 11.7.0 · phpext · CkString · obfuscate · method`

```php
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.

### CkString.prepend

`Chilkat 11.7.0 · phpext · CkString · prepend · method`

```php
void prepend(string $str);
```

Prepends `str` to this instance.

### CkString.prependW

`Chilkat 11.7.0 · phpext · CkString · prependW · method`

```php
void prependW((utf-16) string $s);
```

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

### CkString.punyDecode

`Chilkat 11.7.0 · phpext · CkString · punyDecode · method · since 9.5.0.52`

```php
void punyDecode();
```

In-place decodes the string from punycode.

### CkString.punyEncode

`Chilkat 11.7.0 · phpext · CkString · punyEncode · method · since 9.5.0.52`

```php
void punyEncode();
```

In-place encodes the string to punycode.

### CkString.qpDecode

`Chilkat 11.7.0 · phpext · CkString · qpDecode · method`

```php
void qpDecode(string $charsetEncoding);
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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.

### CkString.qpDecodeW

`Chilkat 11.7.0 · phpext · CkString · qpDecodeW · method`

```php
void qpDecodeW((utf-16) string $charset);
```

The utf-16 version of the qpDecode method.

### CkString.qpEncode

`Chilkat 11.7.0 · phpext · CkString · qpEncode · method`

```php
void qpEncode(string $charsetEncoding);
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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.

### CkString.qpEncodeW

`Chilkat 11.7.0 · phpext · CkString · qpEncodeW · method`

```php
void qpEncodeW((utf-16) string $charset);
```

The utf-16 version of the qpEncode method.

### CkString.removeAll

`Chilkat 11.7.0 · phpext · CkString · removeAll · method`

```php
int removeAll(CkString $substr);
```

Removes all occurrences of `substr`.

### CkString.removeCharOccurances

`Chilkat 11.7.0 · phpext · CkString · removeCharOccurances · method`

```php
void removeCharOccurances(char $ch);
```

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

### CkString.removeChunk

`Chilkat 11.7.0 · phpext · CkString · removeChunk · method`

```php
void removeChunk(int $charStartPos, int $numChars);
```

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

### CkString.removeDelimited

`Chilkat 11.7.0 · phpext · CkString · removeDelimited · method · since 9.5.0.52`

```php
void removeDelimited(string $beginDelim, string $endDelim, bool $caseSensitive);
```

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

### CkString.removeFirst

`Chilkat 11.7.0 · phpext · CkString · removeFirst · method`

```php
bool removeFirst(CkString $substr);
```

Removes the first occurrence of a substring.

### CkString.replaceAll

`Chilkat 11.7.0 · phpext · CkString · replaceAll · method`

```php
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.

### CkString.replaceAllOccurances

`Chilkat 11.7.0 · phpext · CkString · replaceAllOccurances · method`

```php
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.

### CkString.replaceAllOccurancesW

`Chilkat 11.7.0 · phpext · CkString · replaceAllOccurancesW · method`

```php
int replaceAllOccurancesW((utf-16) string $pattern, (utf-16) string $replacement);
```

The utf-16 version of the replaceAllOccurances method.

### CkString.replaceChar

`Chilkat 11.7.0 · phpext · CkString · replaceChar · method`

```php
void replaceChar(char $findCh, char $replaceCh);
```

Replaces all occurrences of a specified ANSI character with another.

### CkString.replaceFirst

`Chilkat 11.7.0 · phpext · CkString · replaceFirst · method`

```php
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.

### CkString.replaceFirstOccurance

`Chilkat 11.7.0 · phpext · CkString · replaceFirstOccurance · method`

```php
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..)

### CkString.replaceFirstOccuranceW

`Chilkat 11.7.0 · phpext · CkString · replaceFirstOccuranceW · method`

```php
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..)

### CkString.saveToFile

`Chilkat 11.7.0 · phpext · CkString · saveToFile · method`

```php
bool saveToFile(string $path, string $charsetEncoding);
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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.

### CkString.saveToFileW

`Chilkat 11.7.0 · phpext · CkString · saveToFileW · method`

```php
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.

### CkString.setStr

`Chilkat 11.7.0 · phpext · CkString · setStr · method`

```php
void setStr(CkString $s);
```

Replaces the contents of the string with another.

### CkString.setString

`Chilkat 11.7.0 · phpext · CkString · setString · method`

```php
void setString(string $str);
```

Clears the contents of this instance and appends `str`.

### CkString.setStringAnsi

`Chilkat 11.7.0 · phpext · CkString · setStringAnsi · method`

```php
void setStringAnsi(string $s);
```

Set the CkString object from an ANSI string.

### CkString.setStringU

`Chilkat 11.7.0 · phpext · CkString · setStringU · method`

```php
void setStringU((utf-16) string $unicode);
```

Set the CkString object from a Unicode string.

### CkString.setStringUtf8

`Chilkat 11.7.0 · phpext · CkString · setStringUtf8 · method`

```php
void setStringUtf8(string $s);
```

Set the string object from a utf-8 string.

### CkString.shorten

`Chilkat 11.7.0 · phpext · CkString · shorten · method`

```php
void shorten(int $n);
```

Discards the last N characters.

### CkString.split

`Chilkat 11.7.0 · phpext · CkString · split · method`

```php
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

### CkString.split2

`Chilkat 11.7.0 · phpext · CkString · split2 · method`

```php
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

### CkString.split2W

`Chilkat 11.7.0 · phpext · CkString · split2W · method`

```php
CkStringArray split2W((utf-16) string $splitCharSet, bool $exceptDoubleQuoted, bool $exceptEscaped, bool $keepEmpty);
```

The utf-16 version of the split2 method.

Returns `null` on failure

### CkString.splitAtWS

`Chilkat 11.7.0 · phpext · CkString · splitAtWS · method`

```php
CkStringArray splitAtWS();
```

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

Returns `null` on failure

### CkString.substring

`Chilkat 11.7.0 · phpext · CkString · substring · method`

```php
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

### CkString.toCRLF

`Chilkat 11.7.0 · phpext · CkString · toCRLF · method`

```php
void toCRLF();
```

Converts all line endings to CRLF.

### CkString.tokenize

`Chilkat 11.7.0 · phpext · CkString · tokenize · method`

```php
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

### CkString.tokenizeW

`Chilkat 11.7.0 · phpext · CkString · tokenizeW · method`

```php
CkStringArray tokenizeW((utf-16) string $punctuation);
```

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

Returns `null` on failure

### CkString.toLF

`Chilkat 11.7.0 · phpext · CkString · toLF · method`

```php
void toLF();
```

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

### CkString.toLowerCase

`Chilkat 11.7.0 · phpext · CkString · toLowerCase · method`

```php
void toLowerCase();
```

Converts the string to lowercase.

### CkString.toUpperCase

`Chilkat 11.7.0 · phpext · CkString · toUpperCase · method`

```php
void toUpperCase();
```

Converts the string to uppercase.

### CkString.trim

`Chilkat 11.7.0 · phpext · CkString · trim · method`

```php
void trim();
```

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

### CkString.trim2

`Chilkat 11.7.0 · phpext · CkString · trim2 · method`

```php
void trim2();
```

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

### CkString.trimInsideSpaces

`Chilkat 11.7.0 · phpext · CkString · trimInsideSpaces · method`

```php
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.

### CkString.unobfuscate

`Chilkat 11.7.0 · phpext · CkString · unobfuscate · method`

```php
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.

### CkString.urlDecode

`Chilkat 11.7.0 · phpext · CkString · urlDecode · method`

```php
void urlDecode(string $charsetEncoding);
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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

### CkString.urlDecodeW

`Chilkat 11.7.0 · phpext · CkString · urlDecodeW · method`

```php
void urlDecodeW((utf-16) string $charsetEncoding);
```

The utf-16 version of the urlDecode method.

### CkString.urlEncode

`Chilkat 11.7.0 · phpext · CkString · urlEncode · method`

```php
void urlEncode(string $charsetEncoding);
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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.

### CkString.urlEncodeW

`Chilkat 11.7.0 · phpext · CkString · urlEncodeW · method`

```php
void urlEncodeW((utf-16) string $charsetEncoding);
```

The utf-16 version of the urlEncode method.

## Related classes

[`StringArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/StringArray.md)

