jfcherng/php-mb-string

A high performance multibytes sting implementation for frequently reading/writing operations.

2.0.1 2023-04-17 14:23 UTC

Requires

• php: >=8.1
• ext-iconv: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• phan/phan: ^5
• phpunit/phpunit: ^9 || ^10

Suggests

• ext-iconv: Either "ext-iconv" or "ext-mbstring" is requried.
• ext-mbstring: Either "ext-iconv" or "ext-mbstring" is requried.

MIT

• Jack Cherng

README

A high performance multibyte sting implementation for frequently reading/writing operations.

Why I Write This Package?

Consider that you have a LONG multibyte string and you want to do lots of following operations on it.

• Random reading/writing such as $char = $str[5]; or $str[5] = '許';.
• Replacement such as str_replace($search, $replace, $str);.
• Insertion such as substr_replace($insert, $str, $position, 0);.
• Get substring such as substr($str, $start, $length);.

Because strings in PHP are not UTF-8, to do operations above safely, you have to either use mb_*() functions or calculate the index by yourself. Using mb_*() functions frequently can be a performance loss because it has to re-decode the source string basing on the given encoding every time when you call it. The longer the string is, the severer the problem becomes.

Instead, this class internally stores the string in its UTF-32 form, which is fixed-width (1 char always occupies 4 bytes) so we are able to perform speedy random accesses. With the power of random access, we could use str_*() functions to do the job internally.

Installation

composer require jfcherng/php-mb-string

Example

See tests/MbStringTest.php.

Benchmark

See benchmark/_results.txt.

What Are You Doing With This Package?

I develop this for a PHP diff package, jfcherng/php-diff.