StringTable Chilkat2 PHP Reference Documentation

StringTable

Current Version: 11.7.0

Markdown version of this page for AI tools (v 11.7.0) · all AI docs

Chilkat.StringTable

Store, load, search, sort, split, retrieve, and save ordered lists of strings.

Chilkat.StringTable is a simple ordered collection of strings. It can append strings directly, load one string per line from files or StringBuilder, search for substrings or wildcard matches, sort the collection, split strings into entries, retrieve strings by index, export the table as line-delimited text, and save the result to a file.

Ordered string collection

Store a list of strings in insertion order and retrieve individual entries by zero-based index.

Append and import

Add strings directly, append strings from a file, or load line-delimited text from a StringBuilder.

Search strings

Find entries containing a substring or matching a wildcard pattern when filtering or locating text values.

Sort entries

Sort the string collection when deterministic ordering or user-facing display order is needed.

Split into entries

Split delimited text into separate string-table entries for easier indexing, searching, sorting, or saving.

Export and save

Convert the table back to line-delimited text, copy it to a StringBuilder, or save the collection to a file.

Common pattern: Use StringTable when application code needs a lightweight ordered list of text values. Append or load the strings, search or sort as needed, retrieve entries by index with StringAt or StringAtSb, then export the final list as line-delimited text or save it to a file.

For an extended overview, see StringTable Class Overview.

Object Creation

use Chilkat2\StringTable;

try {
    $stringTable = new StringTable();
    // ... use $stringTable ...
} catch (\Chilkat2\Exception $e) {
    echo $e->getClass(), '::', $e->getMethod(), " failed\n";
    echo $e->getMessage(), "\n";              // the LastErrorText of the failed call
}

public function __construct(array $properties = [])

Creates the object. The optional array sets properties in order, as if assigned one by one (new StringTable(['VerboseLogging' => true, 'RaiseError' => false])); an unknown or read-only name throws Error. The class is defined by the chilkat2 extension (extension=chilkat2 in php.ini): there is no PHP file to include.

There is no close(): PHP frees the object when its last reference goes (unset($stringTable), $stringTable = null, or the end of the function or request). Objects returned by methods are independent and freed the same way. The class may be extended (class MyStringTable extends \Chilkat2\StringTable); objects cannot be cloned or serialized.

public bool $RaiseError;

When true (the default), a method that fails throws Chilkat2\Exception. When false, it returns false (or null) instead, and the reason is in LastErrorText. Objects returned by a method inherit the value of the object that returned them.

Errors

Chilkat2\Exception extends RuntimeException: getMessage() is the failed call's full LastErrorText, getClass() its class ('Chilkat2\StringTable') and getMethod() the method name. The object remains usable. Methods that look something up and find nothing return null without throwing (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain bool, and property reads and writes do not throw for Chilkat reasons.

Misuse always throws, whatever RaiseError is: a wrong argument type is a TypeError (exact types under declare(strict_types=1)), a missing or extra argument an ArgumentCountError, a string containing a NUL byte or an out-of-range integer a ValueError, and an unknown property (properties are case-sensitive) or a write to a read-only one an Error. Named arguments work with the parameter names shown.

Strings are passed and returned as UTF-8; binary data is a PHP string of bytes. Unlocking: call (new \Chilkat2\GlobalSettings())->UnlockBundle('...') once at startup.

Properties

Count

public readonly int $Count;

Introduced in version 9.5.0.62

The number of strings in the table.

StringTable Chilkat2 PHP Reference Documentation

StringTable

Current Version: 11.7.0

Store, load, search, sort, split, retrieve, and save ordered lists of strings.

Ordered string collection

Append and import

Search strings

Sort entries

Split into entries

Export and save

Object Creation

Errors

Properties

Count

DebugLogFilePath

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

VerboseLogging

Version

Methods

Append

AppendFromFile

AppendFromSb

Clear

FindMatch

FindSubstring

GetStrings

IntAt

SaveToFile

Sort

SplitAndAppend

StringAt

StringAtSb

ToSb

WordFollowing