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

> Chilkat 11.7.0 · language=phpx · 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/phpx/guide.md`.

## Purpose

The Chilkat string class.

## Object creation, unlocking and error handling

**Object Creation**

```php
Chilkat v10.0.0 or greater:
$obj = new COM("Chilkat.CkString");
Chilkat v9.5.0.*:
$obj = new COM("Chilkat_9_5_0.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 ActiveX.

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 | `int NumArabic (read-only)` |
| `NumAscii` | property, read-only | `int NumAscii (read-only)` |
| `NumCentralEuro` | property, read-only | `int NumCentralEuro (read-only)` |
| `NumChars` | property, read-only | `int NumChars (read-only)` |
| `NumChinese` | property, read-only | `int NumChinese (read-only)` |
| `NumCyrillic` | property, read-only | `int NumCyrillic (read-only)` |
| `NumGreek` | property, read-only | `int NumGreek (read-only)` |
| `NumHebrew` | property, read-only | `int NumHebrew (read-only)` |
| `NumJapanese` | property, read-only | `int NumJapanese (read-only)` |
| `NumKorean` | property, read-only | `int NumKorean (read-only)` |
| `NumLatin` | property, read-only | `int NumLatin (read-only)` |
| `NumThai` | property, read-only | `int NumThai (read-only)` |
| `SizeAnsi` | property, read-only | `int SizeAnsi (read-only)` |
| `SizeUtf8` | property, read-only | `int SizeUtf8 (read-only)` |
| `Str` | property, read/write | `string Str` |
| `AnsiCharAt` | method | `int AnsiCharAt(int index)` |
| `Append` | method | `void Append(string str)` |
| `AppendEncoded` | method | `void AppendEncoded(string str, string encoding, string charset)` |
| `AppendMultibyte` | method | `void AppendMultibyte(VARIANT mbtext, string charsetEncoding)` |
| `AppendToFile` | method | `bool AppendToFile(string path, string charsetEncoding)` |
| `BeginsWith` | method | `bool BeginsWith(string str)` |
| `ChopAfter` | method | `void ChopAfter(string findStr)` |
| `ChopBefore` | method | `void ChopBefore(string findStr)` |
| `Clear` | method | `void Clear()` |
| `Contains` | method | `bool Contains(string substr)` |
| `EmitMultibyte` | method | `VARIANT EmitMultibyte(string charsetEncoding)` |
| `EndsWith` | method | `bool EndsWith(string substr)` |
| `GetEncoded` | method | `string GetEncoded(string binaryEncoding, string charsetEncoding)` |
| `HtmlEntityDecode` | method | `void HtmlEntityDecode()` |
| `HtmlEntityEncode` | method | `void HtmlEntityEncode()` |
| `LastAnsiChar` | method | `int LastAnsiChar()` |
| `Left` | method | `string Left(int numChars)` |
| `Length` | method | `int Length()` |
| `LoadFile` | method | `bool LoadFile(string path, string charsetEncoding)` |
| `LoadXmlDoc` | method | `void LoadXmlDoc(VARIANT xmlDocumentBytes)` |
| `Matches` | method | `bool Matches(string strPattern, bool caseSensitive)` |
| `Mid` | method | `string Mid(int index, int numChars)` |
| `Pluralize` | method | `void Pluralize()` |
| `Prepend` | method | `void Prepend(string str)` |
| `PunyDecode` | method | `void PunyDecode()` |
| `PunyEncode` | method | `void PunyEncode()` |
| `RemoveAnsiChar` | method | `void RemoveAnsiChar(int ch)` |
| `ReplaceAll` | method | `void ReplaceAll(string findStr, string replaceStr)` |
| `ReplaceAnsiChar` | method | `void ReplaceAnsiChar(int findCh, int replaceCh)` |
| `ReplaceFirst` | method | `void ReplaceFirst(string findStr, string replaceStr)` |
| `Right` | method | `string Right(int numChars)` |
| `SaveToFile` | method | `bool SaveToFile(string path, string charsetEncoding)` |
| `Shorten` | method | `void Shorten(int numChars)` |
| `StrComp` | method | `int StrComp(string str, bool caseSensitive)` |
| `StripHtml` | method | `void StripHtml()` |
| `ToCRLF` | method | `void ToCRLF()` |
| `ToLF` | method | `void ToLF()` |
| `Trim` | method | `void Trim()` |
| `Trim2` | method | `void Trim2()` |
| `TrimInside` | method | `void TrimInside()` |
| `Unpluralize` | method | `void Unpluralize()` |

## Properties

### CkString.NumArabic

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

```php
int NumArabic (read-only)
```

The number of Arabic characters contained in this string.

### CkString.NumAscii

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

```php
int NumAscii (read-only)
```

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

### CkString.NumCentralEuro

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

```php
int NumCentralEuro (read-only)
```

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

`Chilkat 11.7.0 · phpx · CkString · NumChars · property · read-only`

```php
int NumChars (read-only)
```

The number of characters in the string.

### CkString.NumChinese

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

```php
int NumChinese (read-only)
```

The number of Chinese characters contained in this string.

### CkString.NumCyrillic

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

```php
int NumCyrillic (read-only)
```

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 · phpx · CkString · NumGreek · property · read-only · since 9.5.0.25`

```php
int NumGreek (read-only)
```

The number of Greek characters contained in this string.

### CkString.NumHebrew

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

```php
int NumHebrew (read-only)
```

The number of Hebrew characters contained in this string.

### CkString.NumJapanese

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

```php
int NumJapanese (read-only)
```

The number of Japanese characters contained in this string.

### CkString.NumKorean

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

```php
int NumKorean (read-only)
```

The number of Korean characters contained in this string.

### CkString.NumLatin

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

```php
int NumLatin (read-only)
```

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 · phpx · CkString · NumThai · property · read-only · since 9.5.0.25`

```php
int NumThai (read-only)
```

The number of Thai characters contained in this string.

### CkString.SizeAnsi

`Chilkat 11.7.0 · phpx · CkString · SizeAnsi · property · read-only`

```php
int SizeAnsi (read-only)
```

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

### CkString.SizeUtf8

`Chilkat 11.7.0 · phpx · CkString · SizeUtf8 · property · read-only`

```php
int SizeUtf8 (read-only)
```

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

### CkString.Str

`Chilkat 11.7.0 · phpx · CkString · Str · property · read/write`

```php
string Str
```

The string value of this object.

## Methods

### CkString.AnsiCharAt

`Chilkat 11.7.0 · phpx · CkString · AnsiCharAt · method`

```php
int AnsiCharAt(int index)
```

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

### CkString.Append

`Chilkat 11.7.0 · phpx · CkString · Append · method`

```php
void Append(string str)
```

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

### CkString.AppendEncoded

`Chilkat 11.7.0 · phpx · CkString · AppendEncoded · method`

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

**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 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)
```

### CkString.AppendMultibyte

`Chilkat 11.7.0 · phpx · CkString · AppendMultibyte · method`

```php
void AppendMultibyte(VARIANT mbtext, 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 characters from a byte array. `mbtext` contains the character data. The input bytes are interpreted according to the character encoding specified by `charsetEncoding`.

### CkString.AppendToFile

`Chilkat 11.7.0 · phpx · CkString · AppendToFile · method`

```php
bool AppendToFile(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)

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.

### CkString.BeginsWith

`Chilkat 11.7.0 · phpx · CkString · BeginsWith · method`

```php
bool BeginsWith(string str)
```

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

### CkString.ChopAfter

`Chilkat 11.7.0 · phpx · CkString · ChopAfter · method`

```php
void ChopAfter(string findStr)
```

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

### CkString.ChopBefore

`Chilkat 11.7.0 · phpx · CkString · ChopBefore · method`

```php
void ChopBefore(string findStr)
```

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

### CkString.Clear

`Chilkat 11.7.0 · phpx · CkString · Clear · method`

```php
void Clear()
```

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

### CkString.Contains

`Chilkat 11.7.0 · phpx · CkString · Contains · method`

```php
bool Contains(string substr)
```

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

### CkString.EmitMultibyte

`Chilkat 11.7.0 · phpx · CkString · EmitMultibyte · method`

```php
VARIANT EmitMultibyte(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 a byte array using the character encoding specified by `charsetEncoding`.

Returns `null` on failure

### CkString.EndsWith

`Chilkat 11.7.0 · phpx · CkString · EndsWith · method`

```php
bool EndsWith(string substr)
```

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

### CkString.GetEncoded

`Chilkat 11.7.0 · phpx · CkString · GetEncoded · method`

```php
string GetEncoded(string binaryEncoding, 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)

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

### CkString.HtmlEntityDecode

`Chilkat 11.7.0 · phpx · CkString · HtmlEntityDecode · method`

```php
void HtmlEntityDecode()
```

Decodes any HTML entities found in the string.

### CkString.HtmlEntityEncode

`Chilkat 11.7.0 · phpx · CkString · HtmlEntityEncode · method`

```php
void HtmlEntityEncode()
```

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

### CkString.LastAnsiChar

`Chilkat 11.7.0 · phpx · CkString · LastAnsiChar · method`

```php
int LastAnsiChar()
```

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

### CkString.Left

`Chilkat 11.7.0 · phpx · CkString · Left · method`

```php
string Left(int numChars)
```

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

Returns `null` on failure

### CkString.Length

`Chilkat 11.7.0 · phpx · CkString · Length · method`

```php
int Length()
```

Returns the length, in characters, of the string.

### CkString.LoadFile

`Chilkat 11.7.0 · phpx · 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)

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.

### CkString.LoadXmlDoc

`Chilkat 11.7.0 · phpx · CkString · LoadXmlDoc · method`

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

### CkString.Matches

`Chilkat 11.7.0 · phpx · CkString · Matches · method`

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

### CkString.Mid

`Chilkat 11.7.0 · phpx · CkString · Mid · method`

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

### CkString.Pluralize

`Chilkat 11.7.0 · phpx · CkString · Pluralize · method`

```php
void Pluralize()
```

Pluralizes an English word.

### CkString.Prepend

`Chilkat 11.7.0 · phpx · CkString · Prepend · method`

```php
void Prepend(string str)
```

Prepends `str` to this instance.

### CkString.PunyDecode

`Chilkat 11.7.0 · phpx · CkString · PunyDecode · method · since 9.5.0.52`

```php
void PunyDecode()
```

In-place decodes the string from punycode.

### CkString.PunyEncode

`Chilkat 11.7.0 · phpx · CkString · PunyEncode · method · since 9.5.0.52`

```php
void PunyEncode()
```

In-place encodes the string to punycode.

### CkString.RemoveAnsiChar

`Chilkat 11.7.0 · phpx · CkString · RemoveAnsiChar · method`

```php
void RemoveAnsiChar(int ch)
```

Removes all occurrences of `ch` from the string.

### CkString.ReplaceAll

`Chilkat 11.7.0 · phpx · CkString · ReplaceAll · method`

```php
void ReplaceAll(string findStr, string replaceStr)
```

Replaces all occurrences of `findStr` with `replaceStr`. (case sensitive)

### CkString.ReplaceAnsiChar

`Chilkat 11.7.0 · phpx · CkString · ReplaceAnsiChar · method`

```php
void ReplaceAnsiChar(int findCh, int replaceCh)
```

Replaces all occurrences of `findCh` with `replaceCh`.

### CkString.ReplaceFirst

`Chilkat 11.7.0 · phpx · CkString · ReplaceFirst · method`

```php
void ReplaceFirst(string findStr, string replaceStr)
```

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

### CkString.Right

`Chilkat 11.7.0 · phpx · CkString · Right · method`

```php
string Right(int numChars)
```

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

Returns `null` on failure

### CkString.SaveToFile

`Chilkat 11.7.0 · phpx · 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`. 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.

### CkString.Shorten

`Chilkat 11.7.0 · phpx · CkString · Shorten · method`

```php
void Shorten(int numChars)
```

Removes the final `numChars` from the string.

### CkString.StrComp

`Chilkat 11.7.0 · phpx · CkString · StrComp · method`

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

### CkString.StripHtml

`Chilkat 11.7.0 · phpx · CkString · StripHtml · method`

```php
void StripHtml()
```

Strips HTML tags from a string.

### CkString.ToCRLF

`Chilkat 11.7.0 · phpx · CkString · ToCRLF · method`

```php
void ToCRLF()
```

Converts all line endings to CRLF.

### CkString.ToLF

`Chilkat 11.7.0 · phpx · CkString · ToLF · method`

```php
void ToLF()
```

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

### CkString.Trim

`Chilkat 11.7.0 · phpx · CkString · Trim · method`

```php
void Trim()
```

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

### CkString.Trim2

`Chilkat 11.7.0 · phpx · CkString · Trim2 · method`

```php
void Trim2()
```

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

### CkString.TrimInside

`Chilkat 11.7.0 · phpx · CkString · TrimInside · method`

```php
void TrimInside()
```

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

`Chilkat 11.7.0 · phpx · CkString · Unpluralize · method`

```php
void Unpluralize()
```

Unpluralizes an English word.

