Strings

Introduction

Hypervel includes a variety of functions for manipulating string values. Many of these functions are used by the framework itself; however, you are free to use them in your own applications if you find them convenient.

Available Methods

Strings

__class_basenameepreg_replace_arrayStr::afterStr::afterLastStr::apaStr::asciiStr::beforeStr::beforeLastStr::betweenStr::betweenFirstStr::camelStr::charAtStr::chopStartStr::chopEndStr::containsStr::containsAllStr::doesntContainStr::endsWithStr::excerptStr::finishStr::headlineStr::isStr::isAsciiStr::isJsonStr::isUlidStr::isUrlStr::isUuidStr::kebabStr::lcfirstStr::lengthStr::limitStr::lowerStr::maskStr::orderedUuidStr::padBothStr::padLeftStr::padRightStr::passwordStr::pluralStr::pluralStudlyStr::positionStr::randomStr::removeStr::repeatStr::replaceStr::replaceArrayStr::replaceFirstStr::replaceLastStr::replaceMatchesStr::replaceStartStr::replaceEndStr::reverseStr::singularStr::slugStr::snakeStr::squishStr::startStr::startsWithStr::studlyStr::substrStr::substrCountStr::substrReplaceStr::swapStr::takeStr::titleStr::toBase64Str::trimStr::ltrimStr::rtrimStr::ucfirstStr::ucsplitStr::upperStr::ulidStr::unwrapStr::uuidStr::wordCountStr::wordWrapStr::wordsStr::wrapstrtranstrans_choice

Fluent Strings

afterafterLastapaappendasciibasenamebeforebeforeLastbetweenbetweenFirstcamelcharAtclassBasenamechopStartchopEndcontainscontainsAlldirnameendsWithexactlyexcerptexplodefinishheadlineisisAsciiisEmptyisNotEmptyisJsonisUlidisUrlisUuidkebablcfirstlengthlimitlowermaskmatchmatchAllisMatchnewLinepadBothpadLeftpadRightpipepluralpositionprependremoverepeatreplacereplaceArrayreplaceFirstreplaceLastreplaceMatchesreplaceStartreplaceEndscansingularslugsnakesplitsquishstartstartsWithstripTagsstudlysubstrsubstrReplaceswaptaketaptesttitletoBase64trimltrimrtrimucfirstucsplitunwrapupperwhenwhenContainswhenContainsAllwhenEmptywhenNotEmptywhenStartsWithwhenEndsWithwhenExactlywhenNotExactlywhenIswhenIsAsciiwhenIsUlidwhenIsUuidwhenTestwordCountwordswrap

Strings

__()

The __ function translates the given translation string or translation key using your language files:

echo __('Welcome to our application');

echo __('messages.welcome');

If the specified translation string or key does not exist, the __ function will return the given value. So, using the example above, the __ function would return messages.welcome if that translation key does not exist.

class_basename()

The class_basename function returns the class name of the given class with the class's namespace removed:

$class = class_basename('Foo\Bar\Baz');

// Baz

e()

The e function runs PHP's htmlspecialchars function with the double_encode option set to true by default:

echo e('<html>foo</html>');

// &lt;html&gt;foo&lt;/html&gt;

preg_replace_array()

The preg_replace_array function replaces a given pattern in the string sequentially using an array:

$string = 'The event will take place between :start and :end';

$replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string);

// The event will take place between 8:30 and 9:00

Str::after()

The Str::after method returns everything after the given value in a string. The entire string will be returned if the value does not exist within the string:

use Hypervel\Support\Str;

$slice = Str::after('This is my name', 'This is');

// ' my name'

Str::afterLast()

The Str::afterLast method returns everything after the last occurrence of the given value in a string. The entire string will be returned if the value does not exist within the string:

use Hypervel\Support\Str;

$slice = Str::afterLast('App\Http\Controllers\Controller', '\\');

// 'Controller'

Str::apa()

The Str::apa method converts the given string to title case following the APA guidelines:

use Hypervel\Support\Str;

$title = Str::apa('Creating A Project');

// 'Creating a Project'

Str::ascii()

The Str::ascii method will attempt to transliterate the string into an ASCII value:

use Hypervel\Support\Str;

$slice = Str::ascii('รป');

// 'u'

Str::before()

The Str::before method returns everything before the given value in a string:

use Hypervel\Support\Str;

$slice = Str::before('This is my name', 'my name');

// 'This is '

Str::beforeLast()

The Str::beforeLast method returns everything before the last occurrence of the given value in a string:

use Hypervel\Support\Str;

$slice = Str::beforeLast('This is my name', 'is');

// 'This '

Str::between()

The Str::between method returns the portion of a string between two values:

use Hypervel\Support\Str;

$slice = Str::between('This is my name', 'This', 'name');

// ' is my '

Str::betweenFirst()

The Str::betweenFirst method returns the smallest possible portion of a string between two values:

use Hypervel\Support\Str;

$slice = Str::betweenFirst('[a] bc [d]', '[', ']');

// 'a'

Str::camel()

The Str::camel method converts the given string to camelCase:

use Hypervel\Support\Str;

$converted = Str::camel('foo_bar');

// 'fooBar'

Str::charAt()

The Str::charAt method returns the character at the specified index. If the index is out of bounds, false is returned:

use Hypervel\Support\Str;

$character = Str::charAt('This is my name.', 6);

// 's'

Str::chopStart()

The Str::chopStart method removes the first occurrence of the given value only if the value appears at the start of the string:

use Hypervel\Support\Str;

$url = Str::chopStart('https://laravel.com', 'https://');

// 'laravel.com'

You may also pass an array as the second argument. If the string starts with any of the values in the array then that value will be removed from string:

use Hypervel\Support\Str;

$url = Str::chopStart('http://laravel.com', ['https://', 'http://']);

// 'laravel.com'

Str::chopEnd()

The Str::chopEnd method removes the last occurrence of the given value only if the value appears at the end of the string:

use Hypervel\Support\Str;

$url = Str::chopEnd('app/Models/Photograph.php', '.php');

// 'app/Models/Photograph'

You may also pass an array as the second argument. If the string ends with any of the values in the array then that value will be removed from string:

use Hypervel\Support\Str;

$url = Str::chopEnd('laravel.com/index.php', ['/index.html', '/index.php']);

// 'laravel.com'

Str::contains()

The Str::contains method determines if the given string contains the given value. By default this method is case sensitive:

use Hypervel\Support\Str;

$contains = Str::contains('This is my name', 'my');

// true

You may also pass an array of values to determine if the given string contains any of the values in the array:

use Hypervel\Support\Str;

$contains = Str::contains('This is my name', ['my', 'foo']);

// true

You may disable case sensitivity by setting the ignoreCase argument to true:

use Hypervel\Support\Str;

$contains = Str::contains('This is my name', 'MY', ignoreCase: true);

// true

Str::containsAll()

The Str::containsAll method determines if the given string contains all of the values in a given array:

use Hypervel\Support\Str;

$containsAll = Str::containsAll('This is my name', ['my', 'name']);

// true

You may disable case sensitivity by setting the ignoreCase argument to true:

use Hypervel\Support\Str;

$containsAll = Str::containsAll('This is my name', ['MY', 'NAME'], ignoreCase: true);

// true

Str::doesntContain()

The Str::doesntContain method determines if the given string doesn't contain the given value. By default this method is case sensitive:

use Hypervel\Support\Str;

$doesntContain = Str::doesntContain('This is name', 'my');

// true

You may also pass an array of values to determine if the given string doesn't contain any of the values in the array:

use Hypervel\Support\Str;

$doesntContain = Str::doesntContain('This is name', ['my', 'foo']);

// true

You may disable case sensitivity by setting the ignoreCase argument to true:

use Hypervel\Support\Str;

$doesntContain = Str::doesntContain('This is name', 'MY', ignoreCase: true);

// true

Str::endsWith()

The Str::endsWith method determines if the given string ends with the given value:

use Hypervel\Support\Str;

$result = Str::endsWith('This is my name', 'name');

// true

You may also pass an array of values to determine if the given string ends with any of the values in the array:

use Hypervel\Support\Str;

$result = Str::endsWith('This is my name', ['name', 'foo']);

// true

$result = Str::endsWith('This is my name', ['this', 'foo']);

// false

Str::excerpt()

The Str::excerpt method extracts an excerpt from a given string that matches the first instance of a phrase within that string:

use Hypervel\Support\Str;

$excerpt = Str::excerpt('This is my name', 'my', [
    'radius' => 3
]);

// '...is my na...'

The radius option, which defaults to 100, allows you to define the number of characters that should appear on each side of the truncated string.

In addition, you may use the omission option to define the string that will be prepended and appended to the truncated string:

use Hypervel\Support\Str;

$excerpt = Str::excerpt('This is my name', 'name', [
    'radius' => 3,
    'omission' => '(...) '
]);

// '(...) my name'

Str::finish()

The Str::finish method adds a single instance of the given value to a string if it does not already end with that value:

use Hypervel\Support\Str;

$adjusted = Str::finish('this/string', '/');

// this/string/

$adjusted = Str::finish('this/string/', '/');

// this/string/

Str::headline()

The Str::headline method will convert strings delimited by casing, hyphens, or underscores into a space delimited string with each word's first letter capitalized:

use Hypervel\Support\Str;

$headline = Str::headline('steve_jobs');

// Steve Jobs

$headline = Str::headline('EmailNotificationSent');

// Email Notification Sent

Str::is()

The Str::is method determines if a given string matches a given pattern. Asterisks may be used as wildcard values:

use Hypervel\Support\Str;

$matches = Str::is('foo*', 'foobar');

// true

$matches = Str::is('baz*', 'foobar');

// false

You may disable case sensitivity by setting the ignoreCase argument to true:

use Hypervel\Support\Str;

$matches = Str::is('*.jpg', 'photo.JPG', ignoreCase: true);

// true

Str::isAscii()

The Str::isAscii method determines if a given string is 7 bit ASCII:

use Hypervel\Support\Str;

$isAscii = Str::isAscii('Taylor');

// true

$isAscii = Str::isAscii('รผ');

// false

Str::isJson()

The Str::isJson method determines if the given string is valid JSON:

use Hypervel\Support\Str;

$result = Str::isJson('[1,2,3]');

// true

$result = Str::isJson('{"first": "John", "last": "Doe"}');

// true

$result = Str::isJson('{first: "John", last: "Doe"}');

// false

Str::isUrl()

The Str::isUrl method determines if the given string is a valid URL:

use Hypervel\Support\Str;

$isUrl = Str::isUrl('http://example.com');

// true

$isUrl = Str::isUrl('laravel');

// false

The isUrl method considers a wide range of protocols as valid. However, you may specify the protocols that should be considered valid by providing them to the isUrl method:

$isUrl = Str::isUrl('http://example.com', ['http', 'https']);

Str::isUlid()

The Str::isUlid method determines if the given string is a valid ULID:

use Hypervel\Support\Str;

$isUlid = Str::isUlid('01gd6r360bp37zj17nxb55yv40');

// true

$isUlid = Str::isUlid('laravel');

// false

Str::isUuid()

The Str::isUuid method determines if the given string is a valid UUID:

use Hypervel\Support\Str;

$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');

// true

$isUuid = Str::isUuid('laravel');

// false

Str::kebab()

The Str::kebab method converts the given string to kebab-case:

use Hypervel\Support\Str;

$converted = Str::kebab('fooBar');

// foo-bar

Str::lcfirst()

The Str::lcfirst method returns the given string with the first character lowercased:

use Hypervel\Support\Str;

$string = Str::lcfirst('Foo Bar');

// foo Bar

Str::length()

The Str::length method returns the length of the given string:

use Hypervel\Support\Str;

$length = Str::length('Laravel');

// 7

Str::limit()

The Str::limit method truncates the given string to the specified length:

use Hypervel\Support\Str;

$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);

// The quick brown fox...

You may pass a third argument to the method to change the string that will be appended to the end of the truncated string:

$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');

// The quick brown fox (...)

If you would like to preserve complete words when truncating the string, you may utilize the preserveWords argument. When this argument is true, the string will be truncated to the nearest complete word boundary:

$truncated = Str::limit('The quick brown fox', 12, preserveWords: true);

// The quick...

Str::lower()

The Str::lower method converts the given string to lowercase:

use Hypervel\Support\Str;

$converted = Str::lower('LARAVEL');

// laravel

Str::mask()

The Str::mask method masks a portion of a string with a repeated character, and may be used to obfuscate segments of strings such as email addresses and phone numbers:

use Hypervel\Support\Str;

$string = Str::mask('[email protected]', '*', 3);

// tay***************

If needed, you provide a negative number as the third argument to the mask method, which will instruct the method to begin masking at the given distance from the end of the string:

$string = Str::mask('[email protected]', '*', -15, 3);

// tay***@example.com

Str::orderedUuid()

The Str::orderedUuid method generates a "timestamp first" UUID that may be efficiently stored in an indexed database column. Each UUID that is generated using this method will be sorted after UUIDs previously generated using the method:

use Hypervel\Support\Str;

return (string) Str::orderedUuid();

Str::padBoth()

The Str::padBoth method wraps PHP's str_pad function, padding both sides of a string with another string until the final string reaches a desired length:

use Hypervel\Support\Str;

$padded = Str::padBoth('James', 10, '_');

// '__James___'

$padded = Str::padBoth('James', 10);

// '  James   '

Str::padLeft()

The Str::padLeft method wraps PHP's str_pad function, padding the left side of a string with another string until the final string reaches a desired length:

use Hypervel\Support\Str;

$padded = Str::padLeft('James', 10, '-=');

// '-=-=-James'

$padded = Str::padLeft('James', 10);

// '     James'

Str::padRight()

The Str::padRight method wraps PHP's str_pad function, padding the right side of a string with another string until the final string reaches a desired length:

use Hypervel\Support\Str;

$padded = Str::padRight('James', 10, '-');

// 'James-----'

$padded = Str::padRight('James', 10);

// 'James     '

Str::password()

The Str::password method may be used to generate a secure, random password of a given length. The password will consist of a combination of letters, numbers, symbols, and spaces. By default, passwords are 32 characters long:

use Hypervel\Support\Str;

$password = Str::password();

// 'EbJo2vE-AS:U,$%_gkrV4n,q~1xy/-_4'

$password = Str::password(12);

// 'qwuar>#V|i]N'

Str::plural()

The Str::plural method converts a singular word string to its plural form. This function supports any of the languages support by Laravel's pluralizer:

use Hypervel\Support\Str;

$plural = Str::plural('car');

// cars

$plural = Str::plural('child');

// children

You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:

use Hypervel\Support\Str;

$plural = Str::plural('child', 2);

// children

$singular = Str::plural('child', 1);

// child

Str::pluralStudly()

The Str::pluralStudly method converts a singular word string formatted in studly caps case to its plural form. This function supports any of the languages support by Laravel's pluralizer:

use Hypervel\Support\Str;

$plural = Str::pluralStudly('VerifiedHuman');

// VerifiedHumans

$plural = Str::pluralStudly('UserFeedback');

// UserFeedback

You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:

use Hypervel\Support\Str;

$plural = Str::pluralStudly('VerifiedHuman', 2);

// VerifiedHumans

$singular = Str::pluralStudly('VerifiedHuman', 1);

// VerifiedHuman

Str::position()

The Str::position method returns the position of the first occurrence of a substring in a string. If the substring does not exist in the given string, false is returned:

use Hypervel\Support\Str;

$position = Str::position('Hello, World!', 'Hello');

// 0

$position = Str::position('Hello, World!', 'W');

// 7

Str::random()

The Str::random method generates a random string of the specified length. This function uses PHP's random_bytes function:

use Hypervel\Support\Str;

$random = Str::random(40);

During testing, it may be useful to "fake" the value that is returned by the Str::random method. To accomplish this, you may use the createRandomStringsUsing method:

Str::createRandomStringsUsing(function () {
    return 'fake-random-string';
});

To instruct the random method to return to generating random strings normally, you may invoke the createRandomStringsNormally method:

Str::createRandomStringsNormally();

Str::remove()

The Str::remove method removes the given value or array of values from the string:

use Hypervel\Support\Str;

$string = 'Peter Piper picked a peck of pickled peppers.';

$removed = Str::remove('e', $string);

// Ptr Pipr pickd a pck of pickld ppprs.

You may also pass false as a third argument to the remove method to ignore case when removing strings.

Str::repeat()

The Str::repeat method repeats the given string:

use Hypervel\Support\Str;

$string = 'a';

$repeat = Str::repeat($string, 5);

// aaaaa

Str::replace()

The Str::replace method replaces a given string within the string:

use Hypervel\Support\Str;

$string = 'Laravel 11.x';

$replaced = Str::replace('11.x', '12.x', $string);

// Laravel 12.x

The replace method also accepts a caseSensitive argument. By default, the replace method is case sensitive:

Str::replace('Framework', 'Laravel', caseSensitive: false);

Str::replaceArray()

The Str::replaceArray method replaces a given value in the string sequentially using an array:

use Hypervel\Support\Str;

$string = 'The event will take place between ? and ?';

$replaced = Str::replaceArray('?', ['8:30', '9:00'], $string);

// The event will take place between 8:30 and 9:00

Str::replaceFirst()

The Str::replaceFirst method replaces the first occurrence of a given value in a string:

use Hypervel\Support\Str;

$replaced = Str::replaceFirst('the', 'a', 'the quick brown fox jumps over the lazy dog');

// a quick brown fox jumps over the lazy dog

Str::replaceLast()

The Str::replaceLast method replaces the last occurrence of a given value in a string:

use Hypervel\Support\Str;

$replaced = Str::replaceLast('the', 'a', 'the quick brown fox jumps over the lazy dog');

// the quick brown fox jumps over a lazy dog

Str::replaceMatches()

The Str::replaceMatches method replaces all portions of a string matching a pattern with the given replacement string:

use Hypervel\Support\Str;

$replaced = Str::replaceMatches(
    pattern: '/[^A-Za-z0-9]++/',
    replace: '',
    subject: '(+1) 501-555-1000'
)

// '15015551000'

The replaceMatches method also accepts a closure that will be invoked with each portion of the string matching the given pattern, allowing you to perform the replacement logic within the closure and return the replaced value:

use Hypervel\Support\Str;

$replaced = Str::replaceMatches('/\d/', function (array $matches) {
    return '['.$matches[0].']';
}, '123');

// '[1][2][3]'

Str::replaceStart()

The Str::replaceStart method replaces the first occurrence of the given value only if the value appears at the start of the string:

use Hypervel\Support\Str;

$replaced = Str::replaceStart('Hello', 'Laravel', 'Hello World');

// Laravel World

$replaced = Str::replaceStart('World', 'Laravel', 'Hello World');

// Hello World

Str::replaceEnd()

The Str::replaceEnd method replaces the last occurrence of the given value only if the value appears at the end of the string:

use Hypervel\Support\Str;

$replaced = Str::replaceEnd('World', 'Laravel', 'Hello World');

// Hello Laravel

$replaced = Str::replaceEnd('Hello', 'Laravel', 'Hello World');

// Hello World

Str::reverse()

The Str::reverse method reverses the given string:

use Hypervel\Support\Str;

$reversed = Str::reverse('Hello World');

// dlroW olleH

Str::singular()

The Str::singular method converts a string to its singular form. This function supports any of the languages support by Laravel's pluralizer:

use Hypervel\Support\Str;

$singular = Str::singular('cars');

// car

$singular = Str::singular('children');

// child

Str::slug()

The Str::slug method generates a URL friendly "slug" from the given string:

use Hypervel\Support\Str;

$slug = Str::slug('Laravel 5 Framework', '-');

// laravel-5-framework

Str::snake()

The Str::snake method converts the given string to snake_case:

use Hypervel\Support\Str;

$converted = Str::snake('fooBar');

// foo_bar

$converted = Str::snake('fooBar', '-');

// foo-bar

Str::squish()

The Str::squish method removes all extraneous white space from a string, including extraneous white space between words:

use Hypervel\Support\Str;

$string = Str::squish('    Hypervel    framework    ');

// Hypervel framework

Str::start()

The Str::start method adds a single instance of the given value to a string if it does not already start with that value:

use Hypervel\Support\Str;

$adjusted = Str::start('this/string', '/');

// /this/string

$adjusted = Str::start('/this/string', '/');

// /this/string

Str::startsWith()

The Str::startsWith method determines if the given string begins with the given value:

use Hypervel\Support\Str;

$result = Str::startsWith('This is my name', 'This');

// true

If an array of possible values is passed, the startsWith method will return true if the string begins with any of the given values:

$result = Str::startsWith('This is my name', ['This', 'That', 'There']);

// true

Str::studly()

The Str::studly method converts the given string to StudlyCase:

use Hypervel\Support\Str;

$converted = Str::studly('foo_bar');

// FooBar

Str::substr()

The Str::substr method returns the portion of string specified by the start and length parameters:

use Hypervel\Support\Str;

$converted = Str::substr('The Laravel Framework', 4, 7);

// Laravel

Str::substrCount()

The Str::substrCount method returns the number of occurrences of a given value in the given string:

use Hypervel\Support\Str;

$count = Str::substrCount('If you like ice cream, you will like snow cones.', 'like');

// 2

Str::substrReplace()

The Str::substrReplace method replaces text within a portion of a string, starting at the position specified by the third argument and replacing the number of characters specified by the fourth argument. Passing 0 to the method's fourth argument will insert the string at the specified position without replacing any of the existing characters in the string:

use Hypervel\Support\Str;

$result = Str::substrReplace('1300', ':', 2);
// 13:

$result = Str::substrReplace('1300', ':', 2, 0);
// 13:00

Str::swap()

The Str::swap method replaces multiple values in the given string using PHP's strtr function:

use Hypervel\Support\Str;

$string = Str::swap([
    'Tacos' => 'Burritos',
    'great' => 'fantastic',
], 'Tacos are great!');

// Burritos are fantastic!

Str::take()

The Str::take method returns a specified number of characters from the beginning of a string:

use Hypervel\Support\Str;

$taken = Str::take('Build something amazing!', 5);

// Build

Str::title()

The Str::title method converts the given string to Title Case:

use Hypervel\Support\Str;

$converted = Str::title('a nice title uses the correct case');

// A Nice Title Uses The Correct Case

Str::toBase64()

The Str::toBase64 method converts the given string to Base64:

use Hypervel\Support\Str;

$base64 = Str::toBase64('Laravel');

// TGFyYXZlbA==

Str::trim()

The Str::trim method strips whitespace (or other characters) from the beginning and end of the given string. Unlike PHP's native trim function, the Str::trim method also removes unicode whitespace characters:

use Hypervel\Support\Str;

$string = Str::trim(' foo bar ');

// 'foo bar'

Str::ltrim()

The Str::ltrim method strips whitespace (or other characters) from the beginning of the given string. Unlike PHP's native ltrim function, the Str::ltrim method also removes unicode whitespace characters:

use Hypervel\Support\Str;

$string = Str::ltrim('  foo bar  ');

// 'foo bar  '

Str::rtrim()

The Str::rtrim method strips whitespace (or other characters) from the end of the given string. Unlike PHP's native rtrim function, the Str::rtrim method also removes unicode whitespace characters:

use Hypervel\Support\Str;

$string = Str::rtrim('  foo bar  ');

// '  foo bar'

Str::ucfirst()

The Str::ucfirst method returns the given string with the first character capitalized:

use Hypervel\Support\Str;

$string = Str::ucfirst('foo bar');

// Foo bar

Str::ucsplit()

The Str::ucsplit method splits the given string into an array by uppercase characters:

use Hypervel\Support\Str;

$segments = Str::ucsplit('FooBar');

// [0 => 'Foo', 1 => 'Bar']

Str::upper()

The Str::upper method converts the given string to uppercase:

use Hypervel\Support\Str;

$string = Str::upper('laravel');

// LARAVEL

Str::ulid()

The Str::ulid method generates a ULID, which is a compact, time-ordered unique identifier:

use Hypervel\Support\Str;

return (string) Str::ulid();

// 01gd6r360bp37zj17nxb55yv40

If you would like to retrieve a Hypervel\Support\Carbon date instance representing the date and time that a given ULID was created, you may use the createFromId method provided by Laravel's Carbon integration:

use Hypervel\Support\Carbon;
use Hypervel\Support\Str;

$date = Carbon::createFromId((string) Str::ulid());

During testing, it may be useful to "fake" the value that is returned by the Str::ulid method. To accomplish this, you may use the createUlidsUsing method:

use Symfony\Component\Uid\Ulid;

Str::createUlidsUsing(function () {
    return new Ulid('01HRDBNHHCKNW2AK4Z29SN82T9');
});

To instruct the ulid method to return to generating ULIDs normally, you may invoke the createUlidsNormally method:

Str::createUlidsNormally();

Str::unwrap()

The Str::unwrap method removes the specified strings from the beginning and end of a given string:

use Hypervel\Support\Str;

Str::unwrap('-Laravel-', '-');

// Laravel

Str::unwrap('{framework: "Laravel"}', '{', '}');

// framework: "Laravel"

Str::uuid()

The Str::uuid method generates a UUID (version 4):

use Hypervel\Support\Str;

return (string) Str::uuid();

During testing, it may be useful to "fake" the value that is returned by the Str::uuid method. To accomplish this, you may use the createUuidsUsing method:

use Ramsey\Uuid\Uuid;

Str::createUuidsUsing(function () {
    return Uuid::fromString('eadbfeac-5258-45c2-bab7-ccb9b5ef74f9');
});

To instruct the uuid method to return to generating UUIDs normally, you may invoke the createUuidsNormally method:

Str::createUuidsNormally();

Str::wordCount()

The Str::wordCount method returns the number of words that a string contains:

use Hypervel\Support\Str;

Str::wordCount('Hello, world!'); // 2

Str::wordWrap()

The Str::wordWrap method wraps a string to a given number of characters:

use Hypervel\Support\Str;

$text = "The quick brown fox jumped over the lazy dog."

Str::wordWrap($text, characters: 20, break: "<br />\n");

/*
The quick brown fox<br />
jumped over the lazy<br />
dog.
*/

Str::words()

The Str::words method limits the number of words in a string. An additional string may be passed to this method via its third argument to specify which string should be appended to the end of the truncated string:

use Hypervel\Support\Str;

return Str::words('Perfectly balanced, as all things should be.', 3, ' >>>');

// Perfectly balanced, as >>>

Str::wrap()

The Str::wrap method wraps the given string with an additional string or pair of strings:

use Hypervel\Support\Str;

Str::wrap('Laravel', '"');

// "Laravel"

Str::wrap('is', before: 'This ', after: ' Laravel!');

// This is Laravel!

str()

The str function returns a new Hypervel\Support\Stringable instance of the given string. This function is equivalent to the Str::of method:

$string = str('Taylor')->append(' Otwell');

// 'Taylor Otwell'

If no argument is provided to the str function, the function returns an instance of Hypervel\Support\Str:

$snake = str()->snake('FooBar');

// 'foo_bar'

trans()

The trans function translates the given translation key using your language files:

echo trans('messages.welcome');

If the specified translation key does not exist, the trans function will return the given key. So, using the example above, the trans function would return messages.welcome if the translation key does not exist.

trans_choice()

The trans_choice function translates the given translation key with inflection:

echo trans_choice('messages.notifications', $unreadCount);

If the specified translation key does not exist, the trans_choice function will return the given key. So, using the example above, the trans_choice function would return messages.notifications if the translation key does not exist.

Fluent Strings

Fluent strings provide a more fluent, object-oriented interface for working with string values, allowing you to chain multiple string operations together using a more readable syntax compared to traditional string operations.

after

The after method returns everything after the given value in a string. The entire string will be returned if the value does not exist within the string:

use Hypervel\Support\Str;

$slice = Str::of('This is my name')->after('This is');

// ' my name'

afterLast

The afterLast method returns everything after the last occurrence of the given value in a string. The entire string will be returned if the value does not exist within the string:

use Hypervel\Support\Str;

$slice = Str::of('App\Http\Controllers\Controller')->afterLast('\\');

// 'Controller'

apa

The apa method converts the given string to title case following the APA guidelines:

use Hypervel\Support\Str;

$converted = Str::of('a nice title uses the correct case')->apa();

// A Nice Title Uses the Correct Case

append

The append method appends the given values to the string:

use Hypervel\Support\Str;

$string = Str::of('Taylor')->append(' Otwell');

// 'Taylor Otwell'

ascii

The ascii method will attempt to transliterate the string into an ASCII value:

use Hypervel\Support\Str;

$string = Str::of('รผ')->ascii();

// 'u'

basename

The basename method will return the trailing name component of the given string:

use Hypervel\Support\Str;

$string = Str::of('/foo/bar/baz')->basename();

// 'baz'

If needed, you may provide an "extension" that will be removed from the trailing component:

use Hypervel\Support\Str;

$string = Str::of('/foo/bar/baz.jpg')->basename('.jpg');

// 'baz'

before

The before method returns everything before the given value in a string:

use Hypervel\Support\Str;

$slice = Str::of('This is my name')->before('my name');

// 'This is '

beforeLast

The beforeLast method returns everything before the last occurrence of the given value in a string:

use Hypervel\Support\Str;

$slice = Str::of('This is my name')->beforeLast('is');

// 'This '

between

The between method returns the portion of a string between two values:

use Hypervel\Support\Str;

$converted = Str::of('This is my name')->between('This', 'name');

// ' is my '

betweenFirst

The betweenFirst method returns the smallest possible portion of a string between two values:

use Hypervel\Support\Str;

$converted = Str::of('[a] bc [d]')->betweenFirst('[', ']');

// 'a'

camel

The camel method converts the given string to camelCase:

use Hypervel\Support\Str;

$converted = Str::of('foo_bar')->camel();

// 'fooBar'

charAt

The charAt method returns the character at the specified index. If the index is out of bounds, false is returned:

use Hypervel\Support\Str;

$character = Str::of('This is my name.')->charAt(6);

// 's'

classBasename

The classBasename method returns the class name of the given class with the class's namespace removed:

use Hypervel\Support\Str;

$class = Str::of('Foo\Bar\Baz')->classBasename();

// 'Baz'

chopStart

The chopStart method removes the first occurrence of the given value only if the value appears at the start of the string:

use Hypervel\Support\Str;

$url = Str::of('https://laravel.com')->chopStart('https://');

// 'laravel.com'

You may also pass an array. If the string starts with any of the values in the array then that value will be removed from string:

use Hypervel\Support\Str;

$url = Str::of('http://laravel.com')->chopStart(['https://', 'http://']);

// 'laravel.com'

chopEnd

The chopEnd method removes the last occurrence of the given value only if the value appears at the end of the string:

use Hypervel\Support\Str;

$url = Str::of('https://laravel.com')->chopEnd('.com');

// 'https://laravel'

You may also pass an array. If the string ends with any of the values in the array then that value will be removed from string:

use Hypervel\Support\Str;

$url = Str::of('http://laravel.com')->chopEnd(['.com', '.io']);

// 'http://laravel'

contains

The contains method determines if the given string contains the given value. By default this method is case sensitive:

use Hypervel\Support\Str;

$contains = Str::of('This is my name')->contains('my');

// true

You may also pass an array of values to determine if the given string contains any of the values in the array:

use Hypervel\Support\Str;

$contains = Str::of('This is my name')->contains(['my', 'foo']);

// true

You can disable case sensitivity by setting the ignoreCase argument to true:

use Hypervel\Support\Str;

$contains = Str::of('This is my name')->contains('MY', ignoreCase: true);

// true

containsAll

The containsAll method determines if the given string contains all of the values in the given array:

use Hypervel\Support\Str;

$containsAll = Str::of('This is my name')->containsAll(['my', 'name']);

// true

You can disable case sensitivity by setting the ignoreCase argument to true:

use Hypervel\Support\Str;

$containsAll = Str::of('This is my name')->containsAll(['MY', 'NAME'], ignoreCase: true);

// true

dirname

The dirname method returns the parent directory portion of the given string:

use Hypervel\Support\Str;

$string = Str::of('/foo/bar/baz')->dirname();

// '/foo/bar'

If necessary, you may specify how many directory levels you wish to trim from the string:

use Hypervel\Support\Str;

$string = Str::of('/foo/bar/baz')->dirname(2);

// '/foo'

endsWith

The endsWith method determines if the given string ends with the given value:

use Hypervel\Support\Str;

$result = Str::of('This is my name')->endsWith('name');

// true

You may also pass an array of values to determine if the given string ends with any of the values in the array:

use Hypervel\Support\Str;

$result = Str::of('This is my name')->endsWith(['name', 'foo']);

// true

$result = Str::of('This is my name')->endsWith(['this', 'foo']);

// false

exactly

The exactly method determines if the given string is an exact match with another string:

use Hypervel\Support\Str;

$result = Str::of('Laravel')->exactly('Laravel');

// true

excerpt

The excerpt method extracts an excerpt from the string that matches the first instance of a phrase within that string:

use Hypervel\Support\Str;

$excerpt = Str::of('This is my name')->excerpt('my', [
    'radius' => 3
]);

// '...is my na...'

The radius option, which defaults to 100, allows you to define the number of characters that should appear on each side of the truncated string.

In addition, you may use the omission option to change the string that will be prepended and appended to the truncated string:

use Hypervel\Support\Str;

$excerpt = Str::of('This is my name')->excerpt('name', [
    'radius' => 3,
    'omission' => '(...) '
]);

// '(...) my name'

explode

The explode method splits the string by the given delimiter and returns a collection containing each section of the split string:

use Hypervel\Support\Str;

$collection = Str::of('foo bar baz')->explode(' ');

// collect(['foo', 'bar', 'baz'])

finish

The finish method adds a single instance of the given value to a string if it does not already end with that value:

use Hypervel\Support\Str;

$adjusted = Str::of('this/string')->finish('/');

// this/string/

$adjusted = Str::of('this/string/')->finish('/');

// this/string/

headline

The headline method will convert strings delimited by casing, hyphens, or underscores into a space delimited string with each word's first letter capitalized:

use Hypervel\Support\Str;

$headline = Str::of('taylor_otwell')->headline();

// Taylor Otwell

$headline = Str::of('EmailNotificationSent')->headline();

// Email Notification Sent

is

The is method determines if a given string matches a given pattern. Asterisks may be used as wildcard values

use Hypervel\Support\Str;

$matches = Str::of('foobar')->is('foo*');

// true

$matches = Str::of('foobar')->is('baz*');

// false

isAscii

The isAscii method determines if a given string is an ASCII string:

use Hypervel\Support\Str;

$result = Str::of('Taylor')->isAscii();

// true

$result = Str::of('รผ')->isAscii();

// false

isEmpty

The isEmpty method determines if the given string is empty:

use Hypervel\Support\Str;

$result = Str::of('  ')->trim()->isEmpty();

// true

$result = Str::of('Laravel')->trim()->isEmpty();

// false

isNotEmpty

The isNotEmpty method determines if the given string is not empty:

use Hypervel\Support\Str;

$result = Str::of('  ')->trim()->isNotEmpty();

// false

$result = Str::of('Laravel')->trim()->isNotEmpty();

// true

isJson

The isJson method determines if a given string is valid JSON:

use Hypervel\Support\Str;

$result = Str::of('[1,2,3]')->isJson();

// true

$result = Str::of('{"first": "John", "last": "Doe"}')->isJson();

// true

$result = Str::of('{first: "John", last: "Doe"}')->isJson();

// false

isUlid

The isUlid method determines if a given string is a ULID:

use Hypervel\Support\Str;

$result = Str::of('01gd6r360bp37zj17nxb55yv40')->isUlid();

// true

$result = Str::of('Taylor')->isUlid();

// false

isUrl

The isUrl method determines if a given string is a URL:

use Hypervel\Support\Str;

$result = Str::of('http://example.com')->isUrl();

// true

$result = Str::of('Taylor')->isUrl();

// false

The isUrl method considers a wide range of protocols as valid. However, you may specify the protocols that should be considered valid by providing them to the isUrl method:

$result = Str::of('http://example.com')->isUrl(['http', 'https']);

isUuid

The isUuid method determines if a given string is a UUID:

use Hypervel\Support\Str;

$result = Str::of('5ace9ab9-e9cf-4ec6-a19d-5881212a452c')->isUuid();

// true

$result = Str::of('Taylor')->isUuid();

// false

kebab

The kebab method converts the given string to kebab-case:

use Hypervel\Support\Str;

$converted = Str::of('fooBar')->kebab();

// foo-bar

lcfirst

The lcfirst method returns the given string with the first character lowercased:

use Hypervel\Support\Str;

$string = Str::of('Foo Bar')->lcfirst();

// foo Bar

length

The length method returns the length of the given string:

use Hypervel\Support\Str;

$length = Str::of('Laravel')->length();

// 7

limit

The limit method truncates the given string to the specified length:

use Hypervel\Support\Str;

$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20);

// The quick brown fox...

You may also pass a second argument to change the string that will be appended to the end of the truncated string:

$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20, ' (...)');

// The quick brown fox (...)

If you would like to preserve complete words when truncating the string, you may utilize the preserveWords argument. When this argument is true, the string will be truncated to the nearest complete word boundary:

$truncated = Str::of('The quick brown fox')->limit(12, preserveWords: true);

// The quick...

lower

The lower method converts the given string to lowercase:

use Hypervel\Support\Str;

$result = Str::of('LARAVEL')->lower();

// 'laravel'

markdown

The markdown method converts GitHub flavored Markdown into HTML:

use Hypervel\Support\Str;

$html = Str::of('# Laravel')->markdown();

// <h1>Laravel</h1>

$html = Str::of('# Taylor <b>Otwell</b>')->markdown([
    'html_input' => 'strip',
]);

// <h1>Taylor Otwell</h1>

Markdown Security

By default, Markdown supports raw HTML, which will expose Cross-Site Scripting (XSS) vulnerabilities when used with raw user input. As per the CommonMark Security documentation, you may use the html_input option to either escape or strip raw HTML, and the allow_unsafe_links option to specify whether to allow unsafe links. If you need to allow some raw HTML, you should pass your compiled Markdown through an HTML Purifier:

use Hypervel\Support\Str;

Str::of('Inject: <script>alert("Hello XSS!");</script>')->markdown([
    'html_input' => 'strip',
    'allow_unsafe_links' => false,
]);

// <p>Inject: alert(&quot;Hello XSS!&quot;);</p>

mask

The mask method masks a portion of a string with a repeated character, and may be used to obfuscate segments of strings such as email addresses and phone numbers:

use Hypervel\Support\Str;

$string = Str::of('[email protected]')->mask('*', 3);

// tay***************

If needed, you may provide negative numbers as the third or fourth argument to the mask method, which will instruct the method to begin masking at the given distance from the end of the string:

$string = Str::of('[email protected]')->mask('*', -15, 3);

// tay***@example.com

$string = Str::of('[email protected]')->mask('*', 4, -4);

// tayl**********.com

match

The match method will return the portion of a string that matches a given regular expression pattern:

use Hypervel\Support\Str;

$result = Str::of('foo bar')->match('/bar/');

// 'bar'

$result = Str::of('foo bar')->match('/foo (.*)/');

// 'bar'

matchAll

The matchAll method will return a collection containing the portions of a string that match a given regular expression pattern:

use Hypervel\Support\Str;

$result = Str::of('bar foo bar')->matchAll('/bar/');

// collect(['bar', 'bar'])

If you specify a matching group within the expression, Hypervel will return a collection of the first matching group's matches:

use Hypervel\Support\Str;

$result = Str::of('bar fun bar fly')->matchAll('/f(\w*)/');

// collect(['un', 'ly']);

If no matches are found, an empty collection will be returned.

isMatch

The isMatch method will return true if the string matches a given regular expression:

use Hypervel\Support\Str;

$result = Str::of('foo bar')->isMatch('/foo (.*)/');

// true

$result = Str::of('laravel')->isMatch('/foo (.*)/');

// false

newLine

The newLine method appends an "end of line" character to a string:

use Hypervel\Support\Str;

$padded = Str::of('Laravel')->newLine()->append('Framework');

// 'Laravel
//  Framework'

padBoth

The padBoth method wraps PHP's str_pad function, padding both sides of a string with another string until the final string reaches the desired length:

use Hypervel\Support\Str;

$padded = Str::of('James')->padBoth(10, '_');

// '__James___'

$padded = Str::of('James')->padBoth(10);

// '  James   '

padLeft

The padLeft method wraps PHP's str_pad function, padding the left side of a string with another string until the final string reaches the desired length:

use Hypervel\Support\Str;

$padded = Str::of('James')->padLeft(10, '-=');

// '-=-=-James'

$padded = Str::of('James')->padLeft(10);

// '     James'

padRight

The padRight method wraps PHP's str_pad function, padding the right side of a string with another string until the final string reaches the desired length:

use Hypervel\Support\Str;

$padded = Str::of('James')->padRight(10, '-');

// 'James-----'

$padded = Str::of('James')->padRight(10);

// 'James     '

pipe

The pipe method allows you to transform the string by passing its current value to the given callable:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$hash = Str::of('Laravel')->pipe('md5')->prepend('Checksum: ');

// 'Checksum: a5c95b86291ea299fcbe64458ed12702'

$closure = Str::of('foo')->pipe(function (Stringable $str) {
    return 'bar';
});

// 'bar'

plural

The plural method converts a singular word string to its plural form. This function supports any of the languages support by Laravel's pluralizer:

use Hypervel\Support\Str;

$plural = Str::of('car')->plural();

// cars

$plural = Str::of('child')->plural();

// children

You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:

use Hypervel\Support\Str;

$plural = Str::of('child')->plural(2);

// children

$plural = Str::of('child')->plural(1);

// child

position

The position method returns the position of the first occurrence of a substring in a string. If the substring does not exist within the string, false is returned:

use Hypervel\Support\Str;

$position = Str::of('Hello, World!')->position('Hello');

// 0

$position = Str::of('Hello, World!')->position('W');

// 7

prepend

The prepend method prepends the given values onto the string:

use Hypervel\Support\Str;

$string = Str::of('Framework')->prepend('Hypervel ');

// Hypervel Framework

remove

The remove method removes the given value or array of values from the string:

use Hypervel\Support\Str;

$string = Str::of('Arkansas is quite beautiful!')->remove('quite');

// Arkansas is beautiful!

You may also pass false as a second parameter to ignore case when removing strings.

repeat

The repeat method repeats the given string:

use Hypervel\Support\Str;

$repeated = Str::of('a')->repeat(5);

// aaaaa

replace

The replace method replaces a given string within the string:

use Hypervel\Support\Str;

$replaced = Str::of('Laravel 6.x')->replace('6.x', '7.x');

// Laravel 7.x

The replace method also accepts a caseSensitive argument. By default, the replace method is case sensitive:

$replaced = Str::of('macOS 13.x')->replace(
    'macOS', 'iOS', caseSensitive: false
);

replaceArray

The replaceArray method replaces a given value in the string sequentially using an array:

use Hypervel\Support\Str;

$string = 'The event will take place between ? and ?';

$replaced = Str::of($string)->replaceArray('?', ['8:30', '9:00']);

// The event will take place between 8:30 and 9:00

replaceFirst

The replaceFirst method replaces the first occurrence of a given value in a string:

use Hypervel\Support\Str;

$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceFirst('the', 'a');

// a quick brown fox jumps over the lazy dog

replaceLast

The replaceLast method replaces the last occurrence of a given value in a string:

use Hypervel\Support\Str;

$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceLast('the', 'a');

// the quick brown fox jumps over a lazy dog

replaceMatches

The replaceMatches method replaces all portions of a string matching a pattern with the given replacement string:

use Hypervel\Support\Str;

$replaced = Str::of('(+1) 501-555-1000')->replaceMatches('/[^A-Za-z0-9]++/', '')

// '15015551000'

The replaceMatches method also accepts a closure that will be invoked with each portion of the string matching the given pattern, allowing you to perform the replacement logic within the closure and return the replaced value:

use Hypervel\Support\Str;

$replaced = Str::of('123')->replaceMatches('/\d/', function (array $matches) {
    return '['.$matches[0].']';
});

// '[1][2][3]'

replaceStart

The replaceStart method replaces the first occurrence of the given value only if the value appears at the start of the string:

use Hypervel\Support\Str;

$replaced = Str::of('Hello World')->replaceStart('Hello', 'Laravel');

// Laravel World

$replaced = Str::of('Hello World')->replaceStart('World', 'Laravel');

// Hello World

replaceEnd

The replaceEnd method replaces the last occurrence of the given value only if the value appears at the end of the string:

use Hypervel\Support\Str;

$replaced = Str::of('Hello World')->replaceEnd('World', 'Laravel');

// Hello Laravel

$replaced = Str::of('Hello World')->replaceEnd('Hello', 'Laravel');

// Hello World

scan

The scan method parses input from a string into a collection according to a format supported by the sscanf PHP function:

use Hypervel\Support\Str;

$collection = Str::of('filename.jpg')->scan('%[^.].%s');

// collect(['filename', 'jpg'])

singular

The singular method converts a string to its singular form. This function supports any of the languages support by Laravel's pluralizer:

use Hypervel\Support\Str;

$singular = Str::of('cars')->singular();

// car

$singular = Str::of('children')->singular();

// child

slug

The slug method generates a URL friendly "slug" from the given string:

use Hypervel\Support\Str;

$slug = Str::of('Hypervel Framework')->slug('-');

// hypervel-framework

snake

The snake method converts the given string to snake_case:

use Hypervel\Support\Str;

$converted = Str::of('fooBar')->snake();

// foo_bar

split

The split method splits a string into a collection using a regular expression:

use Hypervel\Support\Str;

$segments = Str::of('one, two, three')->split('/[\s,]+/');

// collect(["one", "two", "three"])

squish

The squish method removes all extraneous white space from a string, including extraneous white space between words:

use Hypervel\Support\Str;

$string = Str::of('    Hypervel    framework    ')->squish();

// Hypervel framework

start

The start method adds a single instance of the given value to a string if it does not already start with that value:

use Hypervel\Support\Str;

$adjusted = Str::of('this/string')->start('/');

// /this/string

$adjusted = Str::of('/this/string')->start('/');

// /this/string

startsWith

The startsWith method determines if the given string begins with the given value:

use Hypervel\Support\Str;

$result = Str::of('This is my name')->startsWith('This');

// true

stripTags

The stripTags method removes all HTML and PHP tags from a string:

use Hypervel\Support\Str;

$result = Str::of('<a href="https://laravel.com">Taylor <b>Otwell</b></a>')->stripTags();

// Taylor Otwell

$result = Str::of('<a href="https://laravel.com">Taylor <b>Otwell</b></a>')->stripTags('<b>');

// Taylor <b>Otwell</b>

studly

The studly method converts the given string to StudlyCase:

use Hypervel\Support\Str;

$converted = Str::of('foo_bar')->studly();

// FooBar

substr

The substr method returns the portion of the string specified by the given start and length parameters:

use Hypervel\Support\Str;

$string = Str::of('Laravel Framework')->substr(8);

// Framework

$string = Str::of('Laravel Framework')->substr(8, 5);

// Frame

substrReplace

The substrReplace method replaces text within a portion of a string, starting at the position specified by the second argument and replacing the number of characters specified by the third argument. Passing 0 to the method's third argument will insert the string at the specified position without replacing any of the existing characters in the string:

use Hypervel\Support\Str;

$string = Str::of('1300')->substrReplace(':', 2);

// 13:

$string = Str::of('The Framework')->substrReplace(' Laravel', 3, 0);

// The Laravel Framework

swap

The swap method replaces multiple values in the string using PHP's strtr function:

use Hypervel\Support\Str;

$string = Str::of('Tacos are great!')
    ->swap([
        'Tacos' => 'Burritos',
        'great' => 'fantastic',
    ]);

// Burritos are fantastic!

take

The take method returns a specified number of characters from the beginning of the string:

use Hypervel\Support\Str;

$taken = Str::of('Build something amazing!')->take(5);

// Build

tap

The tap method passes the string to the given closure, allowing you to examine and interact with the string while not affecting the string itself. The original string is returned by the tap method regardless of what is returned by the closure:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('Laravel')
    ->append(' Framework')
    ->tap(function (Stringable $string) {
        dump('String after append: '.$string);
    })
    ->upper();

// LARAVEL FRAMEWORK

test

The test method determines if a string matches the given regular expression pattern:

use Hypervel\Support\Str;

$result = Str::of('Laravel Framework')->test('/Laravel/');

// true

title

The title method converts the given string to Title Case:

use Hypervel\Support\Str;

$converted = Str::of('a nice title uses the correct case')->title();

// A Nice Title Uses The Correct Case

toBase64

The toBase64 method converts the given string to Base64:

use Hypervel\Support\Str;

$base64 = Str::of('Laravel')->toBase64();

// TGFyYXZlbA==

trim

The trim method trims the given string. Unlike PHP's native trim function, Laravel's trim method also removes unicode whitespace characters:

use Hypervel\Support\Str;

$string = Str::of('  Hypervel  ')->trim();

// 'Hypervel'

$string = Str::of('/Hypervel/')->trim('/');

// 'Hypervel'

ltrim

The ltrim method trims the left side of the string. Unlike PHP's native ltrim function, Laravel's ltrim method also removes unicode whitespace characters:

use Hypervel\Support\Str;

$string = Str::of('  Hypervel  ')->ltrim();

// 'Hypervel  '

$string = Str::of('/Hypervel/')->ltrim('/');

// 'Hypervel/'

rtrim

The rtrim method trims the right side of the given string. Unlike PHP's native rtrim function, Laravel's rtrim method also removes unicode whitespace characters:

use Hypervel\Support\Str;

$string = Str::of('  Hypervel  ')->rtrim();

// '  Hypervel'

$string = Str::of('/Hypervel/')->rtrim('/');

// '/Hypervel'

ucfirst

The ucfirst method returns the given string with the first character capitalized:

use Hypervel\Support\Str;

$string = Str::of('foo bar')->ucfirst();

// Foo bar

ucsplit

The ucsplit method splits the given string into a collection by uppercase characters:

use Hypervel\Support\Str;

$string = Str::of('Foo Bar')->ucsplit();

// collect(['Foo', 'Bar'])

unwrap

The unwrap method removes the specified strings from the beginning and end of a given string:

use Hypervel\Support\Str;

Str::of('-Laravel-')->unwrap('-');

// Laravel

Str::of('{framework: "Laravel"}')->unwrap('{', '}');

// framework: "Laravel"

upper

The upper method converts the given string to uppercase:

use Hypervel\Support\Str;

$adjusted = Str::of('laravel')->upper();

// LARAVEL

when

The when method invokes the given closure if a given condition is true. The closure will receive the fluent string instance:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('Taylor')
    ->when(true, function (Stringable $string) {
        return $string->append(' Otwell');
    });

// 'Taylor Otwell'

If necessary, you may pass another closure as the third parameter to the when method. This closure will execute if the condition parameter evaluates to false.

whenContains

The whenContains method invokes the given closure if the string contains the given value. The closure will receive the fluent string instance:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('tony stark')
    ->whenContains('tony', function (Stringable $string) {
        return $string->title();
    });

// 'Tony Stark'

If necessary, you may pass another closure as the third parameter to the when method. This closure will execute if the string does not contain the given value.

You may also pass an array of values to determine if the given string contains any of the values in the array:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('tony stark')
    ->whenContains(['tony', 'hulk'], function (Stringable $string) {
        return $string->title();
    });

// Tony Stark

whenContainsAll

The whenContainsAll method invokes the given closure if the string contains all of the given sub-strings. The closure will receive the fluent string instance:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('tony stark')
    ->whenContainsAll(['tony', 'stark'], function (Stringable $string) {
        return $string->title();
    });

// 'Tony Stark'

If necessary, you may pass another closure as the third parameter to the when method. This closure will execute if the condition parameter evaluates to false.

whenEmpty

The whenEmpty method invokes the given closure if the string is empty. If the closure returns a value, that value will also be returned by the whenEmpty method. If the closure does not return a value, the fluent string instance will be returned:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('  ')->whenEmpty(function (Stringable $string) {
    return $string->trim()->prepend('Laravel');
});

// 'Laravel'

whenNotEmpty

The whenNotEmpty method invokes the given closure if the string is not empty. If the closure returns a value, that value will also be returned by the whenNotEmpty method. If the closure does not return a value, the fluent string instance will be returned:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('Framework')->whenNotEmpty(function (Stringable $string) {
    return $string->prepend('Hypervel ');
});

// 'Hypervel Framework'

whenStartsWith

The whenStartsWith method invokes the given closure if the string starts with the given sub-string. The closure will receive the fluent string instance:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('disney world')->whenStartsWith('disney', function (Stringable $string) {
    return $string->title();
});

// 'Disney World'

whenEndsWith

The whenEndsWith method invokes the given closure if the string ends with the given sub-string. The closure will receive the fluent string instance:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('disney world')->whenEndsWith('world', function (Stringable $string) {
    return $string->title();
});

// 'Disney World'

whenExactly

The whenExactly method invokes the given closure if the string exactly matches the given string. The closure will receive the fluent string instance:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('laravel')->whenExactly('laravel', function (Stringable $string) {
    return $string->title();
});

// 'Laravel'

whenNotExactly

The whenNotExactly method invokes the given closure if the string does not exactly match the given string. The closure will receive the fluent string instance:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('framework')->whenNotExactly('laravel', function (Stringable $string) {
    return $string->title();
});

// 'Framework'

whenIs

The whenIs method invokes the given closure if the string matches a given pattern. Asterisks may be used as wildcard values. The closure will receive the fluent string instance:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('foo/bar')->whenIs('foo/*', function (Stringable $string) {
    return $string->append('/baz');
});

// 'foo/bar/baz'

whenIsAscii

The whenIsAscii method invokes the given closure if the string is 7 bit ASCII. The closure will receive the fluent string instance:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('laravel')->whenIsAscii(function (Stringable $string) {
    return $string->title();
});

// 'Laravel'

whenIsUlid

The whenIsUlid method invokes the given closure if the string is a valid ULID. The closure will receive the fluent string instance:

use Hypervel\Support\Str;

$string = Str::of('01gd6r360bp37zj17nxb55yv40')->whenIsUlid(function (Stringable $string) {
    return $string->substr(0, 8);
});

// '01gd6r36'

whenIsUuid

The whenIsUuid method invokes the given closure if the string is a valid UUID. The closure will receive the fluent string instance:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('a0a2a2d2-0b87-4a18-83f2-2529882be2de')->whenIsUuid(function (Stringable $string) {
    return $string->substr(0, 8);
});

// 'a0a2a2d2'

whenTest

The whenTest method invokes the given closure if the string matches the given regular expression. The closure will receive the fluent string instance:

use Hypervel\Support\Str;
use Hypervel\Support\Stringable;

$string = Str::of('laravel framework')->whenTest('/laravel/', function (Stringable $string) {
    return $string->title();
});

// 'Laravel Framework'

wordCount

The wordCount method returns the number of words that a string contains:

use Hypervel\Support\Str;

Str::of('Hello, world!')->wordCount(); // 2

words

The words method limits the number of words in a string. If necessary, you may specify an additional string that will be appended to the truncated string:

use Hypervel\Support\Str;

$string = Str::of('Perfectly balanced, as all things should be.')->words(3, ' >>>');

// Perfectly balanced, as >>>

wrap

The wrap method wraps the given string with an additional string or pair of strings:

use Hypervel\Support\Str;

Str::of('Laravel')->wrap('"');

// "Laravel"

Str::is('is')->wrap(before: 'This ', after: ' Laravel!');

// This is Laravel!