Yii Strings

The package provides:

• StringHelper that has static methods to work with strings;
• NumericHelper that has static methods to work with numeric strings;
• Inflector provides methods such as toPlural() or toSlug() that derive a new string based on the string given;
• WildcardPattern is a shell wildcard pattern to match strings against;
• CombinedRegexp is a wrapper that optimizes multiple regular expressions matching and MemoizedCombinedRegexp is a decorator that caches results of CombinedRegexp to speed up matching.

Requirements

• PHP 8.0 or higher.
• mbstring PHP extension.

Installation

StringHelper usage

String helper methods are static so usage is like the following:

Overall the helper has the following method groups.

Bytes

• byteLength
• byteSubstring

File paths

• baseName
• directoryName

Substrings

• substring
• replaceSubstring
• startsWith
• startsWithIgnoringCase
• endsWith
• endsWithIgnoringCase
• findBetween
• findBetweenFirst
• findBetweenLast

Truncation

• truncateBegin
• truncateMiddle
• truncateEnd
• truncateWords
• trim
• ltrim
• rtrim

Counting

• length
• countWords

Lowercase and uppercase

• lowercase
• uppercase
• uppercaseFirstCharacter
• uppercaseFirstCharacterInEachWord

URL friendly base64

• base64UrlEncode
• base64UrlDecode

Other

• parsePath
• split

NumericHelper usage

Numeric helper methods are static so usage is like the following:

The following methods are available:

• toOrdinal
• normalize
• isInteger

Inflector usage

Overall the inflector has the following method groups.

Plurals and singulars

• toPlural
• toSingular

Transliteration

• toTransliterated

Case conversion

• pascalCaseToId
• toPascalCase
• toCamelCase

Words and sentences

• toSentence
• toWords
• toHumanReadable

Classes and database tables

• classToTable
• tableToClass

URLs

• toSlug

WildcardPattern usage

WildcardPattern allows a simple POSIX-style string matching.

The following characters are special in the pattern:

• \ escapes other special characters if usage of escape character is not turned off.
• * matches any string, including the empty string, except delimiters (/ and \ by default).
• ** matches any string, including the empty string and delimiters.
• ? matches any single character.
• [seq] matches any character in seq.
• [a-z] matches any character from a to z.
• [!seq] matches any character not in seq.
• [[:alnum:]] matches POSIX style character classes.

ignoreCase() could be called before doing a match() to get a case-insensitive match:

CombinedRegexp usage

CombinedRegexp optimizes matching multiple regular expressions.

MemoizedCombinedRegexp usage

MemoizedCombinedRegexp caches results of CombinedRegexp in memory. It is useful when the same incoming string are matching multiple times or different methods of CombinedRegexp are called.

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

Code style

Use Rector to make codebase follow some specific rules or use either newest or any specific version of PHP:

Dependencies

Use ComposerRequireChecker to detect transitive Composer dependencies.

License

The Yii Strings is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Follow updates