flaphl/string

String abstractions pulled from Flaphl elements.

v1.0.1 2025-10-17 19:38 UTC

Requires

• php: ^8.2
• flaphl/deprecation-contracts: ^2.1

Requires (Dev)

• phpunit/phpunit: ^10.0 || ^11.0

MIT

• Jade Phyressi

• php
• string
• unicode
• flaphl

README

A modern PHP string manipulation library with Unicode support, HTML safety, and thread-safe operations.

Installation

composer require flaphl/string

Quick Start

use Flaphl\Element\String\UnicodeString;
use Flaphl\Element\String\HtmlString;
use Flaphl\Element\String\StringBuilder;

// Unicode string operations
$text = UnicodeString::of('Hello 世界');
echo $text->length(); // 8 (characters, not bytes)
echo $text->toUpperCase(); // HELLO 世界

// HTML-safe strings
$html = HtmlString::safe('<script>alert("xss")</script><p>Safe content</p>');
echo $html->toString(); // <p>Safe content</p>

// Fast string building
$builder = new StringBuilder();
$result = $builder->append('Hello')
                 ->append(' ')
                 ->append('World')
                 ->getString(); // "Hello World"

Classes

• UnicodeString - Immutable Unicode string with full UTF-8 support
• HtmlString - HTML-safe string with XSS protection
• StringBuilder - Fast string concatenation for single-threaded use
• StringBuffer - Thread-safe string buffer with file locking

Features

• Full Unicode/UTF-8 character support
• HTML sanitization and XSS protection
• Thread-safe operations with file-based locking
• Immutable string operations
• Method chaining for fluent API
• High-performance string building with smart chunking and caching
• Memory-efficient buffering with automatic consolidation
• Zero-copy optimizations where possible

Testing

# Run tests
vendor/bin/phpunit

# With test documentation
vendor/bin/phpunit --testdox

Performance Optimizations

StringBuilder

• SplFixedArray-based chunking for efficient memory management
• Smart consolidation to prevent memory fragmentation
• Result caching to avoid repeated concatenation
• Configurable chunk sizes for different use cases

StringBuffer

• Intelligent buffering with automatic consolidation
• String result caching to minimize implode() calls
• Thread-safe operations with minimal locking overhead
• Memory-efficient chunk management

Best Practices

// For many small appends, use StringBuilder
$builder = new StringBuilder();
for ($i = 0; $i < 1000; $i++) {
    $builder->append("Item $i\n");
}

// For thread-safe operations, use StringBuffer
$buffer = new StringBuffer();
$buffer->append('Thread-safe content');

Requirements

• PHP 8.2 or higher
• mbstring extension
• Optional: intl extension for advanced normalization

License

MIT License. See LICENSE file for details.