wuzzitor/string-util

Provides a consistent, self-explaining layer to accomplish common string operations.

StringUtil

, _(*1)

Overview

This library provides a consistent, self-explaining layer to accomplish string related tasks., _(*2)

Speaking method names make string operations more readable and reveal the intention clearly. Please compare the following, common snippets regarding readability:, _(*3)

// Native:
if (strpos($log, 'failure') !== false) {
    // [...]
}

// With StringUtil:
if (StringUtil::contains($log, 'failure')) {
    // [...]
}

In contrast to the built-in PHP string functions, the library provides methods with consistent signatures, which always expect the subject string as first parameter., _(*4)

Known Restrictions

This library is meant for common, light-weight string operations. It is currently not designed for heavy, complex string tasks such as transparent charset handling., _(*5)

Installation

Add the following to your composer.json (see getcomposer.org):, _(*6)

"require" :  {
    // ...
    "wuzzitor/string-util": "~1.0"
}

Concept

The library provides a single class (Wuzzitor\StringUtil), whose static methods are the entry points for all string operations., _(*7)

All methods are stateless to ensure full testability and to avoid code that is hard to debug., _(*8)

Usage

Example:, _(*9)

use Wuzzitor\StringUtil;

$filename = 'example.php';
$withoutExtension = StringUtil::removeSuffix($filename, '.php);
// $withoutExtension == 'example'

The following signatures show all available operations:, _(*10)

• StringUtil::startsWith(string $subject, string $prefix) : boolean
• StringUtil::endsWith(string $subject, string $suffix) : boolean
• StringUtil::contains(string $subject, string $needle) : boolean
• StringUtil::containsAny(string $subject, string[] $needles) : boolean
• StringUtil::containsAll(string $subject, string[] $needles) : boolean
• StringUtil::removePrefix(string $subject, string $prefix) : string
• StringUtil::removeSuffix(string $subject, string $suffix) : string
• StringUtil::replace(string $subject, string $search, string $replace) : string
• StringUtil::replace(string $subject, array<string, string> $searchReplaceMapping) : string

License

Code released under the MIT license., _(*11)