Stars: 190
Forks: 12
Pull Requests: 23
Issues: 14
Watchers: 6
Last Updated: 2021-03-21 19:50:05
A fast, solid and strong typed string manipulation library with multibyte support
License: MIT License
Languages: PHP, Makefile
$str = new Str('Hello, 世界');
$str->last(2); // 世界
$str->chars(); // ['世', '界']
$str
->ensureLeft('Hello, ') // Hello, 世界
->ensureRight('!!!') // Hello, 世界!!!
->trimRight('!') // Hello, 世界
->prepend('Str say - '); // Str say - Hello, 世界
$send = function (string $s) {};
$send((string)$str); // same
$send($str->getString()); // same
Requirements:
composer require str/str
A fast string manipulation library with multi-byte support. Inspired by the "Stringy" library, with focus on speed.
Lib uses php7 features and does not throw any exceptions (because all input parameters are strongly typed). The code is completely covered by unit tests.
A
B
C
D
E
F
G
H
I
J
L
M
O
P
Q
R
S
T
U
W
Inserts given $substr $times into the original string after the first occurrence of $needle.
$str = new Str('foo bar baz');
echo (string)$str->afterFirst('a', 'duh', 2);
// foo baduhduhr baz
Parameters:
Return:
Inserts given $substr $times into the original string after the last occurrence of $needle.
$str = new Str('foo bar baz');
echo (string)$str->afterLast('a', 'duh', 2);
// foo bar baduhduhz
Parameters:
Return:
Append $sub to the string.
$str = new Str('/Acme');
echo (string)$str->append('/');
// /Acme/
Parameters:
Return:
Appends a random string consisting of $possibleChars, if specified, of given $size or random length between $size and $sizeMax to the original string.
$str = new Str('foo');
echo $str->appendUniqueIdentifier(3, -1, 'foba_rz');
// foozro
Parameters:
Return:
Returns the character at $pos, with indexes starting at 0.
$str = new Str('/Acme/');
echo (string)$str->at(2);
// c
Parameters:
Return:
Inserts given $substr $times into the original string before the first occurrence of $needle.
$str = new Str('foo bar baz');
echo (string)$str->beforeFirst('a', 'duh');
// foo bduhar baz
Parameters:
Return:
Inserts given $substr $times into the original string before the last occurrence of $needle.
$str = new Str('foo bar baz');
echo (string)$str->beforeLast('a', 'duh');
// foo bar bduhaz
Parameters:
Return:
Returns the substring between $start and $end, if found, or an empty string. An optional $offset may be supplied from which to begin the search for the start string.
$str = new Str('/Acme/');
echo (string)$str->between('/', '/');
// Acme
Parameters:
Return:
Returns a camelCase version of the string. Trims surrounding spaces, capitalizes letters following digits, spaces, dashes and underscores, and removes spaces, dashes, as well as underscores.
$str = new Str('ac me');
echo (string)$str->camelize();
// acMe
Parameters: nothing
Return:
Returns an array consisting of the characters in the string.
$str = new Str('/Acme/');
echo (string)$str->chars();
// ['/', 'A', 'c', 'm', 'e', '/']
Parameters: nothing
Return:
Cuts the original string in pieces of $step size.
$str = new Str('foo bar baz');
echo $str->chop(2);
// ['fo', 'o ', 'ba', 'r ', 'ba', 'z']
Parameters:
Return:
Trims the string and replaces consecutive whitespace characters with a single space. This includes tabs and newline characters, as well as multi-byte whitespace such as the thin space and ideographic space.
$str = new Str('foo bar baz');
echo (string)$str->collapseWhitespace();
// foo bar baz
Parameters: nothing
Return:
Check if the string contains $needle substring.
$str = new Str('/Acme/');
echo $str->contains('/');
// true
$str = new Str('/Acme/');
echo $str->contains('a', false);
// true
Parameters:
Return:
Returns true if the string contains all $needles, false otherwise. By default the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false.
$str = new Str('/Accmme/');
echo $str->containsAll(['m', 'c', '/']);
// true
Parameters:
Return:
Returns true if the string contains any $needles, false otherwise. By default the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false.
$str = new Str('/Accmme/');
echo $str->containsAny(['foo', 'c', 'bar']);
// true
Parameters:
Return:
Returns the number of occurrences of $needle in the given string. By default the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false.
$str = new Str('/Accmme/');
echo $str->countSubstr('m');
// 2
Parameters:
Return:
Returns a lowercase and trimmed string separated by dashes. Dashes are inserted before uppercase characters (with the exception of the first character of the string), and in place of spaces as well as underscores.
$str = new Str('Ac me');
echo (string)$str->dasherize();
// ac-me
Parameters: nothing
Return:
Returns a lowercase and trimmed string separated by the given $delimiter. Delimiters are inserted before uppercase characters (with the exception of the first character of the string), and in place of spaces, dashes, and underscores. Alpha delimiters are not converted to lowercase.
$str = new Str('Ac me');
echo (string)$str->delimit('#');
// ac#me
Parameters:
Return:
Returns true if the string ends with $substring, false otherwise. By default the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false.
$str = new Str('/Accmme/');
echo $str->endsWith('e/');
// true
Parameters:
Return:
Returns true if the string ends with any of $substrings, false otherwise. By default the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false.
$str = new Str('/Accmme/');
echo $str->endsWithAny(['foo', 'e/', 'bar']);
// true
Parameters:
Return:
Check whether $prefix exists in the string, and prepend $prefix to the string if it doesn't.
$str = new Str('Acme/');
echo (string)$str->ensureLeft('/');
// /Acme/
$str = new Str('/Acme/');
echo (string)$str->ensureLeft('/');
// /Acme/
Parameters:
Return:
Check whether $suffix exists in the string, and append $suffix to the string if it doesn't.
$str = new Str('/Acme');
echo (string)$str->ensureRight('/'); // /Acme/
$str = new Str('/Acme/');
echo (string)$str->ensureRight('/'); // /Acme/
Parameters:
Return:
Returns the first $length characters of the string.
$str = new Str('/Acme/');
echo (string)$str->first(2);
// /A
Parameters:
Return:
Parameters: nothing
Return:
Returns true if the string contains a lower case char, false otherwise.
$str = new Str('Acme');
echo $str->hasLowerCase();
// true
Parameters: nothing
Return:
Check if the string has $prefix at the start.
$str = new Str('/Acme/');
echo $str->hasPrefix('/');
// true
Parameters:
Return:
Check if the string has $suffix at the end.
$str = new Str('/Acme/');
echo $str->hasSuffix('/');
// true
Parameters:
Return:
Returns true if the string contains an upper case char, false otherwise.
$str = new Str('Acme');
echo $str->hasUpperCase();
// true
Parameters: nothing
Return:
Convert all HTML entities to their applicable characters. An alias of html_entity_decode. For a list of flags, refer to PHP documentation.
$str = new Str('<Acme>');
echo (string)$str->htmlDecode();
// <Acme>
Parameters:
Return:
Convert all applicable characters to HTML entities. An alias of htmlentities. Refer to PHP documentation for a list of flags.
$str = new Str('<Acme>');
echo (string)$str->htmlEncode();
// <Acme>
Parameters:
Return:
Capitalizes the first word of the string, replaces underscores with spaces.
$str = new Str('foo_id');
echo (string)$str->humanize();
// Foo
Parameters: nothing
Return:
Returns the index of the first occurrence of $needle in the string, and -1 if not found. Accepts an optional $offset from which to begin the search.
$str = new Str('/Accmme/');
echo $str->indexOf('m');
// 4
Parameters:
Return:
Returns the index of the last occurrence of $needle in the string, and false if not found. Accepts an optional $offset from which to begin the search. Offsets may be negative to count from the last character in the string.
$str = new Str('/Accmme/');
echo $str->indexOfLast('m');
// 5
Parameters:
Return:
Inserts $substring into the string at the $index provided.
$str = new Str('/Ace/');
echo (string)$str->insert('m', 3);
// /Acme/
Parameters:
Return:
Returns true if the string contains only alphabetic chars, false otherwise.
$str = new Str('Acme');
echo $str->isAlpha();
// true
Parameters: nothing
Return:
Returns true if the string contains only alphabetic and numeric chars, false otherwise.
$str = new Str('Acme1');
echo $str->isAlphanumeric();
// true
Parameters: nothing
Return:
Check if this string is valid base64 encoded data. Function do encode(decode(s)) === s, so this is not so fast.
Parameters: nothing
Return:
Returns true if the string contains only whitespace chars, false otherwise.
$str = new Str('Acme');
echo $str->isBlank();
// false
Parameters: nothing
Return:
Splits the original string in pieces by '@' delimiter and returns true in case the resulting array consists of 2 parts.
$str = new Str('test@[email protected]');
echo $str->isEmail();
// false
Parameters: nothing
Return:
Returns true if the string contains only hexadecimal chars, false otherwise.
$str = new Str('Acme');
echo $str->isHexadecimal();
// false
Parameters: nothing
Return:
Return true if this is valid ipv4 address
$str = new Str('1.0.1.0');
echo $str->isIpV4();
// true
Parameters: nothing
Return:
Return true if this is valid ipv6 address
$str = new Str('2001:cdba::3257:9652');
echo $str->isIpV6();
// true
Parameters: nothing
Return:
Returns true if the string is JSON, false otherwise. Unlike json_decode in PHP 5.x, this method is consistent with PHP 7 and other JSON parsers, in that an empty string is not considered valid JSON.
$str = new Str('Acme');
echo $str->isJson();
// false
Parameters: nothing
Return:
Returns true if the string contains only lower case chars, false otherwise.
$str = new Str('Acme');
echo $str->isLowerCase();
// false
Parameters: nothing
Return:
Returns true if the string is serialized, false otherwise.
$str = new Str('Acme');
echo $str->isSerialized();
// false
Parameters: nothing
Return:
It doesn't matter whether the given UUID has dashes.
$str = new Str('76d7cac8-1bd7-11e8-accf-0ed5f89f718b');
echo $str->isUUIDv4();
// false
$str = new Str('ae815123-537f-4eb3-a9b8-35881c29e1ac');
echo $str->isUUIDv4();
// true
Parameters: nothing
Return:
Returns true if the string contains only upper case chars, false otherwise.
$str = new Str('Acme');
echo $str->isUpperCase();
// false
Parameters: nothing
Return:
Joins the original string with an array of other strings with the given $separator.
$str = new Str('foo');
echo $str->join('*', ['bar', 'baz']);
// foo*bar*baz
Parameters:
Return:
Returns the first $length characters of the string.
$str = new Str('/Acme/');
echo (string)$str->last(2);
// e/
Parameters:
Return:
Returns the length of the string.
$str = new Str('/Acme/');
echo $str->length();
// 6
Parameters: nothing
Return:
Splits on newlines and carriage returns, returning an array of strings corresponding to the lines in the string.
$str = new Str("Acme\r\nAcme");
echo $str->lines();
// ['Acme', 'Acme']
Parameters: nothing
Return:
Returns the longest common prefix between the string and $otherStr.
$str = new Str('Acme');
echo (string)$str->longestCommonPrefix('Accurate');
// Ac
Parameters:
Return:
Returns the longest common substring between the string and $otherStr. In the case of ties, it returns that which occurs first.
$str = new Str('Acme');
echo (string)$str->longestCommonSubstring('meh');
// me
Parameters:
Return:
Returns the longest common suffix between the string and $otherStr.
$str = new Str('Acme');
echo (string)$str->longestCommonSuffix('Do believe me');
// me
Parameters:
Return:
Converts the first character of the string to lower case.
$str = new Str('Acme Foo');
echo (string)$str->lowerCaseFirst();
// acme Foo
Parameters: nothing
Return:
Create a new Str object using static method for it.
$str = Str::make('Acme');
echo (string)$str; // Acme
Parameters:
Return:
Returns true if the string match regexp pattern
$s = new Str('foo baR');
echo $str->matchesPattern('.*aR');
// true
Parameters:
Return:
Move substring of desired $length to $destination index of the original string. In case $destination is less than $length returns the string untouched.
$str = new Str('/Acme/');
echo (string)$str->move(0, 2, 4);
// cm/Ae/
Parameters:
Return:
Replaces substring in the original string of $length with given $substr.
$str = new Str('/Acme/');
echo (string)$str->overwrite(0, 2, 'BAR');
// BARcme/
Parameters:
Return:
Returns a new string of a given length such that both sides of the string are padded.
$str = new Str('Acme');
echo (string)$str->padBoth(6, '/');
// /Acme/
Parameters:
Return:
Returns a new string of a given length such that the beginning of the string is padded.
$str = new Str('Acme/');
echo (string)$str->padLeft(6, '/');
// /Acme/
Parameters:
Return:
Returns a new string of a given length such that the end of the string is padded.
$str = new Str('/Acme');
echo (string)$str->padRight(6, '/');
// /Acme/
Parameters:
Return:
Returns the substring of the string from the last occurrence of $delimiter to the end.
$str = new Str('Acme/foo');
echo $str->pop('/');
// foo
Parameters:
Return:
Returns the substring of the original string from the beginning to the last occurrence of $delimiter.
$str = new Str('Acme/foo/bar');
echo $str->popReversed('/');
// Acme/foo
Parameters:
Return:
Prepend $sub to the string.
$str = new Str('Acme/');
echo (string)$str->prepend('/');
// /Acme/
Parameters:
Return:
Wraps each word in the string with specified $quote.
$str = new Str('foo bar baz');
echo $str->quote('*');
// *foo* *bar* *baz*
Parameters:
Return:
Generates a random string consisting of $possibleChars, if specified, of given $size or random length between $size and $sizeMax. If $possibleChars is not specified, the generated string will consist of ASCII alphanumeric chars.
$str = new Str('foo bar');
echo $str->random(3, -1, 'fobarz');
// zfa
$str = new Str('');
echo $str->random(3);
// 1ho
Parameters:
Return:
Replaces all occurrences of $pattern in the string by $replacement. An alias for mb_ereg_replace(). Note that the 'i' option with multi-byte patterns in mb_ereg_replace() requires PHP 5.6+ for correct results. This is due to a lack of support in the bundled version of Oniguruma in PHP < 5.6, and current versions of HHVM (3.8 and below).
$str = new Str('Acme Foo');
echo (string)$str->regexReplace('A', 'a');
// acme Foo
Parameters:
Return:
Returns the string with the prefix $substring removed, if present.
$str = new Str('/Acme/');
echo (string)$str->removeLeft('/');
// Acme/
Parameters:
Return:
Returns the string with the suffix $substring removed, if present.
$str = new Str('/Acme/');
echo (string)$str->removeRight('/');
// /Acme
Parameters:
Return:
Returns a repeated string given a $multiplier. An alias for str_repeat.
$str = new Str('Acme/');
echo (string)$str->repeat(2);
// Acme/Acme/
Parameters:
Return:
Replaces all occurrences of $old in the string by $new.
$str = new Str('/Acme/');
echo (string)$str->replace('/', '#');
// #Acme#
Parameters:
Return:
Replace returns a copy of the string s with the first n non-overlapping instances of old replaced by new. If old is empty, it matches at the beginning of the string and after each UTF-8 sequence, yielding up to k+1 replacements for a k-rune string. If n < 0, there is no limit on the number of replacements.
$str = new Str('/Acme/');
echo (string)$str->replaceWithLimit('/', '#', 1);
// #Acme/
Parameters:
Return:
Returns a reversed string. A multi-byte version of strrev().
$str = new Str('/Acme/');
echo (string)$str->reverse();
// /emcA/
Parameters: nothing
Return:
Truncates the string to a given $length, while ensuring that it does not split words. If $substring is provided, and truncating occurs, the string is further truncated so that the $substring may be appended without exceeding the desired length.
$str = new Str('What are your plans today?');
echo (string)$str->safeTruncate(22, '...');
// What are your plans...
Parameters:
Return:
Returns the substring of the original string from beginning to the first occurrence of $delimiter.
$str = new Str('Acme/foo');
echo $str->shift('/');
// Acme
Parameters:
Return:
Returns the substring of the original string from the first occurrence of $delimiter to the end.
$str = new Str('Acme/foo/bar');
echo $str->shiftReversed('/');
// foo/bar
Parameters:
Return:
A multi-byte str_shuffle() function. It returns a string with its characters in random order.
$str = new Str('/Acme/');
echo (string)$str->shuffle();
// mAe//c
Parameters: nothing
Return:
Returns the substring beginning at $start, and up to, but not including the index specified by $end. If $end is omitted, the function extracts the remaining string. If $end is negative, it is computed from the end of the string.
$str = new Str('Acme');
echo (string)$str->slice(2);
// me
Parameters:
Return:
Converts the string into an URL slug. This includes replacing non-ASCII characters with their closest ASCII equivalents, removing remaining non-ASCII and non-alphanumeric characters, and replacing whitespace with $replacement. The $replacement defaults to a single dash, and the string is also converted to lowercase. The $language of the source string can also be supplied for language-specific transliteration.
$str = new Str('Acme foo bar!');
echo (string)$str->slugify();
// acme-foo-bar
Parameters:
Return:
Returns a snake_case version of the string.
$str = new Str('Foo Bar');
echo (string)$str->snakeize();
// foo_bar
Parameters: nothing
Return:
Splits the string with the provided $pattern, returning an array of strings. An optional integer $limit will truncate the results.
$str = new Str('Acme#Acme');
echo $str->split('#', 1);
// ['Acme']
Parameters:
Return:
Returns true if the string begins with $substring, false otherwise. By default the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false.
$str = new Str('/Accmme/');
echo $str->startsWith('/A');
// true
Parameters:
Return:
Returns true if the string begins with any of $substrings, false otherwise. By default the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false.
$str = new Str('/Accmme/');
echo $str->startsWithAny(['foo', '/A', 'bar']);
// true
Parameters:
Return:
Strip all whitespace characters. This includes tabs and newline characters, as well as multi-byte whitespace such as the thin space and ideographic space.
$str = new Str('Acme foo');
echo (string)$str->stripWhitespace();
// Acmefoo
Parameters: nothing
Return:
Returns the substring beginning at $start with the specified $length. It differs from the mb_substr() function in that providing a $length of 0 will return the rest of the string, rather than an empty string.
$str = new Str('/Acme/');
echo (string)$str->substr(1, 4);
// Acme
Parameters:
Return:
Surrounds the string with the given $substring.
$str = new Str('Acme');
echo (string)$str->surround('/');
// /Acme/
Parameters:
Return:
Returns a case swapped version of the string.
$str = new Str('foObARbAz');
echo (string)$str->swapCase();
// FOoBarBaZ
Parameters: nothing
Return:
Returns a string with smart quotes, ellipsis characters, and dashes from Windows-1252 (commonly used in Word documents) replaced by their ASCII equivalents.
$str = new Str('“I see…”');
echo (string)$str->tidy();
// "I see..."
Parameters: nothing
Return:
Returns a trimmed string with the first letter of each word capitalized. Also accepts an array, $ignore, allowing you to list words not to be capitalized.
$str = new Str('i like to watch DVDs at home');
echo (string)$str->titleize(['at', 'to', 'the']);
// I Like to Watch Dvds at Home
Parameters:
Return:
Returns an ASCII version of the string. A set of non-ASCII characters are replaced with their closest ASCII counterparts, and the rest are removed by default. The $language or locale of the source string can be supplied for language-specific transliteration in any of the following formats: en, en_GB, or en-GB. For example, passing "de" results in "äöü" mapping to "aeoeue" rather than "aou" as in other languages.
$str = new Str('Äcmế');
echo (string)$str->toAscii();
// Acme
Parameters:
Return:
Returns a boolean representation of the given logical string value. For example, 'true', '1', 'on' and 'yes' will return true. 'false', '0', 'off', and 'no' will return false. In all instances, case is ignored. For other numeric strings, their sign will determine the return value. In addition, blank strings consisting of only whitespace will return false. For all other strings, the return value is a result of a boolean cast.
$str = new Str('yes');
echo $str->toBoolean();
// true
Parameters: nothing
Return:
Make the string lowercase.
$str = new Str('/Acme/');
echo (string)$str->toLowerCase();
// /acme/
Parameters: nothing
Return:
Converts each tab in the string to some number of spaces, as defined by $tabLength. By default, each tab is converted to 4 consecutive spaces.
$str = new Str('foo bar');
echo (string)$str->toSpaces(0);
// foobar
Parameters:
Return:
Converts each occurrence of some consecutive number of spaces, as defined by $tabLength, to a tab. By default, each 4 consecutive spaces are converted to a tab.
$str = new Str('foo bar');
echo (string)$str->toTabs();
// foo bar
Parameters:
Return:
Converts the first character of each word in the string to uppercase.
$str = new Str('foo bar baz');
echo (string)$str->toTitleCase();
// Foo Bar Baz
Parameters: nothing
Return:
Make the string uppercase.
$str = new Str('/Acme/');
echo (string)$str->toUpperCase();
// /ACME/
Parameters: nothing
Return:
Returns a string with whitespace removed from the start and end of the string. Supports the removal of unicode whitespace. Accepts an optional string of characters to strip instead of the defaults.
$str = new Str('/Acme/');
echo (string)$str->trim('/');
// Acme
Parameters:
Return:
Returns a string with whitespace removed from the start of the string. Supports the removal of unicode whitespace. Accepts an optional string of characters to strip instead of the defaults.
$str = new Str('/Acme/');
echo (string)$str->trimLeft('/');
// Acme/
Parameters:
Return:
Returns a string with whitespace removed from the end of the string. Supports the removal of unicode whitespace. Accepts an optional string of characters to strip instead of the defaults.
$str = new Str('/Acme/');
echo (string)$str->trimRight('/');
// /Acme
Parameters:
Return:
Truncates the string to a given $length. If $substring is provided, and truncating occurs, the string is further truncated so that the substring may be appended without exceeding the desired length.
$str = new Str('What are your plans today?');
echo (string)$str->truncate(19, '...');
// What are your pl...
Parameters:
Return:
Returns a lowercase and trimmed string separated by underscores. Underscores are inserted before uppercase characters (with the exception of the first character of the string), and in place of spaces as well as dashes.
$str = new Str('foo Bar baz');
echo (string)$str->underscored();
// foo_bar_baz
Parameters: nothing
Return:
Unwraps each word in the original string, deleting the specified $quote.
$str = new Str('*foo* bar* ***baz*');
echo $str->unquote('*');
// foo bar baz
Parameters:
Return:
Returns an UpperCamelCase version of the string. It trims surrounding spaces, capitalizes letters following digits, spaces, dashes and underscores, and removes spaces, dashes, underscores.
$str = new Str('foo bar baz');
echo (string)$str->upperCamelize();
// FooBarBaz
Parameters: nothing
Return:
Converts the first character of the string to upper case.
$str = new Str('acme foo');
echo (string)$str->upperCaseFirst();
// Acme foo
Parameters: nothing
Return:
Splits on whitespace, returning an array of strings corresponding to the words in the string.
$str = new Str('foo bar baz');
echo $str->words();
// ['foo', 'bar', 'baz']
Parameters: nothing
Return:
lib code tests (versus):
make lib-code-tests
how to get total RANK:
make rank
generate md:
make md
run tests:
make test
Test subjects:
RANK (sum time of all benchmarks): smaller - is better!
Target | Total Time | Diff |
---|---|---|
Str | 5.505 s. | 1x |
Stringy | 10.840 s. | 2.0x |
subject | mode | mem_peak | diff |
---|---|---|---|
bench_common_Str | 811.098μs | 1,929,728b | 1.00x |
bench_common_Stringy | 5,310.290μs | 1,879,272b | 6.55x |
Please use php cs fixer before commit: https://github.com/FriendsOfPHP/PHP-CS-Fixer
you can add watcher in any IDE for automatic fix code style on save.