Helpers Collection
Visit this package on GitHub

Helpers

These methods and functions are all also available in the PHP helpers package.

Laravel includes a variety of global "helper" PHP functions. 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.

The Arr::clean method (alternative arrayClean function) remove null or optional empty entries from array:

use NormanHuth\Helpers\Arr;
Arr::clean(['name' => 'Norman', 'lastname' => '', 'phone' => null]);
arrayClean(['name' => 'Norman', 'lastname' => '', 'phone' => null]);
// ['name' => 'Norman', 'lastname' => '']
Arr::clean(['name' => 'Norman', 'lastname' => '', 'phone' => null], true);
arrayClean(['name' => 'Norman', 'lastname' => '', 'phone' => null], true);
// ['name' => 'Norman']

The Arr::keyMap method (alternative arrayKeyMap function) applies the callback to the elements of the given array keys:

use NormanHuth\Helpers\Arr;
Arr::keyMap('ucfirst', ['cars' => 1, 'boats' => 0, 'bikes' => 2]);
arrayKeyMap('ucfirst', ['cars' => 1, 'boats' => 0, 'bikes' => 2]);
// ['Cars' => 1, 'Boats' => 0, 'Bikes' => 2]

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

Notice: If You using this in Laravel. The locale is set to configured local.

use NormanHuth\Helpers\Str;
$slug = Str::slug('Laravel 10 Framework', '-');
$slug = strSlug('Laravel 10 Framework', '-');
// laravel-10-framework

Add whitespace before every upper char:

use NormanHuth\Helpers\Str;
$string = 'AddWhitespaceBeforeEveryUpperChar';
Str::spaceBeforeCapitals($string);
strSpaceBeforeCapitals($string);
// "Add Whitespace Before Every Upper Char"

Domain with queries via http_build_query:

use NormanHuth\Helpers\Str;
Str::httpBuildQueryUrl('https://huth.it', ['foo' => 'bar', 'one' => 'two']);
httpBuildQueryUrl('https://huth.it', ['foo' => 'bar', 'one' => 'two']);
// "https://huth.it?foo=bar&one=two"

Get index number of an integer:

use NormanHuth\Helpers\Str;
Str::indexNumber(12);
indexNumber(12);
// 0
Str::indexNumber(78);
indexNumber(78);
// 0
Str::indexNumber(109);
indexNumber(109);
// 100
Str::indexNumber(323);
indexNumber(323);
// 300
Str::indexNumber(1230, 1000);
indexNumber(1230, 1000);
// 1000

Replace the last comma in a list with and word:

Notice: When you use this function in Laravel the translation function __ is automatically used.

use NormanHuth\Helpers\Str;
Str::lastAnd(['Jane', 'John', 'Norman']);
// "Jane, John and Norman"

Generate a serial number:

use NormanHuth\Helpers\Str;
Str::generateSerialNo();
// "71WWF-6MJH5-ACS31-GKMMQ-SIU7W"
Str::generateSerialNo(false, 3, 3, ' ');
// "1uX hIw hoQ"

Round up to the nearest multiple of E.

use NormanHuth\Helpers\Str;
Str::ceilUpNearest(23);
ceilUpNearest(23);
// 25.0
Str::ceilUpNearest(27, 10);
ceilUpNearest(27, 10);
// 30.0

Format int with leading zeros:

use NormanHuth\Helpers\Str;
Str::fillDigits(23);
fillDigits(23);
// "00023"
Str::fillDigits(23, 3);
fillDigits(23, 3);
// "023"

Get a random HEX color:

use NormanHuth\Helpers\Str;
Str::randomHexColor();
// "551acd"

Returns the JSON representation pretty and unescaped of a value:

use NormanHuth\Helpers\Str;
Str::jsonPrettyEncode(['foo' => 'bar', 'dog' => 'fur']);
jsonPrettyEncode(['foo' => 'bar', 'dog' => 'fur']);
/*
{
"foo": "bar",
"dog": "fur"
}
*/

Encode emojis to unicode:

use NormanHuth\Helpers\Str;
Str::emojiToUnicode('😊');
// U+1F60A

Trim every line and remove doubled whitespaces and new lines:

use NormanHuth\Helpers\Str;
Str::normalizeUserSubmit("Hi\n\nLorem Ipsum");
normalizeUserSubmit("Hi\n\nLorem Ipsum");
// "Hi\nLorem Ipsum"

Get Domain name from URL:

use NormanHuth\Helpers\Str;
Str::getDomain('https://huth.it/coffee');
urlGetDomain('https://huth.it/coffee');
// "huth.it"

The base_path function returns the fully qualified path to your application's root directory. You may also use the base_path function to generate a fully qualified path to a given file relative to the project root directory:

$path = base_path();
$path = base_path('vendor/bin');

The Arr::accessible method determines if the given value is array accessible:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);
// true
$isAccessible = Arr::accessible(new Collection);
// true
$isAccessible = Arr::accessible('abc');
// false
$isAccessible = Arr::accessible(new stdClass);
// false

The Arr::add method adds a given key / value pair to an array if the given key doesn't already exist in the array or is set to null:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = Arr::add(['name' => 'Desk'], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
// ['name' => 'Desk', 'price' => 100]

The Arr::collapse method collapses an array of arrays into a single array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
// [1, 2, 3, 4, 5, 6, 7, 8, 9]

The Arr::crossJoin method cross joins the given arrays, returning a Cartesian product with all possible permutations:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
/* // [tl! collapse:start]
[
[1, 'a'],
[1, 'b'],
[2, 'a'],
[2, 'b'],
]
*/ // [tl! collapse:end]
$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
/* // [tl! collapse:start]
[
[1, 'a', 'I'],
[1, 'a', 'II'],
[1, 'b', 'I'],
[1, 'b', 'II'],
[2, 'a', 'I'],
[2, 'a', 'II'],
[2, 'b', 'I'],
[2, 'b', 'II'],
]
*/ // [tl! collapse:end]

The Arr::divide method returns two arrays: one containing the keys and the other containing the values of the given array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
[$keys, $values] = Arr::divide(['name' => 'Desk']);
// $keys: ['name']
// $values: ['Desk']

The Arr::dot method flattens a multidimensional array into a single level array that uses "dot" notation to indicate depth:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$flattened = Arr::dot($array);
// ['products.desk.price' => 100]

The Arr::except method removes the given key / value pairs from an array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$filtered = Arr::except($array, ['price']);
// ['name' => 'Desk']

The Arr::exists method checks that the given key exists in the provided array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['name' => 'John Doe', 'age' => 17];
$exists = Arr::exists($array, 'name');
// true
$exists = Arr::exists($array, 'salary');
// false

The Arr::first method returns the first element of an array passing a given truth test:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [100, 200, 300];
$first = Arr::first($array, function ($value, $key) {
return $value >= 150;
});
// 200

A default value may also be passed as the third parameter to the method. This value will be returned if no value passes the truth test:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$first = Arr::first($array, $callback, $default);

The Arr::flatten method flattens a multi-dimensional array into a single level array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$flattened = Arr::flatten($array);
// ['Joe', 'PHP', 'Ruby']

The Arr::forget method removes a given key / value pair from a deeply nested array using "dot" notation:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::forget($array, 'products.desk');
// ['products' => []]

The Arr::get method retrieves a value from a deeply nested array using "dot" notation:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$price = Arr::get($array, 'products.desk.price');
// 100

The Arr::get method also accepts a default value, which will be returned if the specified key is not present in the array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$discount = Arr::get($array, 'products.desk.discount', 0);
// 0

The Arr::has method checks whether a given item or items exists in an array using "dot" notation:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = Arr::has($array, 'product.name');
// true
$contains = Arr::has($array, ['product.price', 'product.discount']);
// false

The Arr::hasAny method checks whether any item in a given set exists in an array using "dot" notation:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = Arr::hasAny($array, 'product.name');
// true
$contains = Arr::hasAny($array, ['product.name', 'product.discount']);
// true
$contains = Arr::hasAny($array, ['category', 'product.discount']);
// false

The Arr::isAssoc method returns true if the given array is an associative array. An array is considered "associative" if it doesn't have sequential numerical keys beginning with zero:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
// true
$isAssoc = Arr::isAssoc([1, 2, 3]);
// false

The Arr::isList method returns true if the given array's keys are sequential integers beginning from zero:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$isList = Arr::isList(['foo', 'bar', 'baz']);
// true
$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);
// false

The Arr::join method joins array elements with a string. Using this method's second argument, you may also specify the joining string for the final element of the array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];
$joined = Arr::join($array, ', ');
// Tailwind, Alpine, Laravel, Livewire
$joined = Arr::join($array, ', ', ' and ');
// Tailwind, Alpine, Laravel and Livewire

The Arr::keyBy method keys the array by the given key. If multiple items have the same key, only the last one will appear in the new array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [
['product_id' => 'prod-100', 'name' => 'Desk'],
['product_id' => 'prod-200', 'name' => 'Chair'],
];
$keyed = Arr::keyBy($array, 'product_id');
/*
[
'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
]
*/

The Arr::last method returns the last element of an array passing a given truth test:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [100, 200, 300, 110];
$last = Arr::last($array, function ($value, $key) {
return $value >= 150;
});
// 300

A default value may be passed as the third argument to the method. This value will be returned if no value passes the truth test:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$last = Arr::last($array, $callback, $default);

The Arr::map method iterates through the array and passes each value and key to the given callback. The array value is replaced by the value returned by the callback:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['first' => 'james', 'last' => 'kirk'];
$mapped = Arr::map($array, function ($value, $key) {
return ucfirst($value);
});
// ['first' => 'James', 'last' => 'Kirk']

The Arr::only method returns only the specified key / value pairs from the given array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
$slice = Arr::only($array, ['name', 'price']);
// ['name' => 'Desk', 'price' => 100]

The Arr::pluck method retrieves all of the values for a given key from an array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [
['developer' => ['id' => 1, 'name' => 'Taylor']],
['developer' => ['id' => 2, 'name' => 'Abigail']],
];
$names = Arr::pluck($array, 'developer.name');
// ['Taylor', 'Abigail']

You may also specify how you wish the resulting list to be keyed:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$names = Arr::pluck($array, 'developer.name', 'developer.id');
// [1 => 'Taylor', 2 => 'Abigail']

The Arr::prepend method will push an item onto the beginning of an array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['one', 'two', 'three', 'four'];
$array = Arr::prepend($array, 'zero');
// ['zero', 'one', 'two', 'three', 'four']

If needed, you may specify the key that should be used for the value:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['price' => 100];
$array = Arr::prepend($array, 'Desk', 'name');
// ['name' => 'Desk', 'price' => 100]

The Arr::prependKeysWith prepends all key names of an associative array with the given prefix:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [
'name' => 'Desk',
'price' => 100,
];
$keyed = Arr::prependKeysWith($array, 'product.');
/*
[
'product.name' => 'Desk',
'product.price' => 100,
]
*/

The Arr::pull method returns and removes a key / value pair from an array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$name = Arr::pull($array, 'name');
// $name: Desk
// $array: ['price' => 100]

A default value may be passed as the third argument to the method. This value will be returned if the key doesn't exist:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$value = Arr::pull($array, $key, $default);

The Arr::query method converts the array into a query string:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [
'name' => 'Taylor',
'order' => [
'column' => 'created_at',
'direction' => 'desc'
]
];
Arr::query($array);
// name=Taylor&order[column]=created_at&order[direction]=desc

The Arr::random method returns a random value from an array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [1, 2, 3, 4, 5];
$random = Arr::random($array);
// 4 - (retrieved randomly)

You may also specify the number of items to return as an optional second argument. Note that providing this argument will return an array even if only one item is desired:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$items = Arr::random($array, 2);
// [2, 5] - (retrieved randomly)

The Arr::set method sets a value within a deeply nested array using "dot" notation:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::set($array, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]

The Arr::shuffle method randomly shuffles the items in the array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = Arr::shuffle([1, 2, 3, 4, 5]);
// [3, 2, 5, 1, 4] - (generated randomly)

The Arr::sort method sorts an array by its values:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sort($array);
// ['Chair', 'Desk', 'Table']

You may also sort the array by the results of a given closure:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [
['name' => 'Desk'],
['name' => 'Table'],
['name' => 'Chair'],
];
$sorted = array_values(Arr::sort($array, function ($value) {
return $value['name'];
}));
/*
[
['name' => 'Chair'],
['name' => 'Desk'],
['name' => 'Table'],
]
*/

The Arr::sortDesc method sorts an array in descending order by its values:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sortDesc($array);
// ['Table', 'Desk', 'Chair']

You may also sort the array by the results of a given closure:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [
['name' => 'Desk'],
['name' => 'Table'],
['name' => 'Chair'],
];
$sorted = array_values(Arr::sortDesc($array, function ($value) {
return $value['name'];
}));
/*
[
['name' => 'Table'],
['name' => 'Desk'],
['name' => 'Chair'],
]
*/

The Arr::sortRecursive method recursively sorts an array using the sort function for numerically indexed sub-arrays and the ksort function for associative sub-arrays:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [
['Roman', 'Taylor', 'Li'],
['PHP', 'Ruby', 'JavaScript'],
['one' => 1, 'two' => 2, 'three' => 3],
];
$sorted = Arr::sortRecursive($array);
/*
[
['JavaScript', 'PHP', 'Ruby'],
['one' => 1, 'three' => 3, 'two' => 2],
['Li', 'Roman', 'Taylor'],
]
*/

The Arr::toCssClasses conditionally compiles a CSS class string. The method accepts an array of classes where the array key contains the class or classes you wish to add, while the value is a boolean expression. If the array element has a numeric key, it will always be included in the rendered class list:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$isActive = false;
$hasError = true;
$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];
$classes = Arr::toCssClasses($array);
/*
'p-4 bg-red'
*/

The Arr::undot method expands a single-dimensional array that uses "dot" notation into a multi-dimensional array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [
'user.name' => 'Kevin Malone',
'user.occupation' => 'Accountant',
];
$array = Arr::undot($array);
// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]

The Arr::where method filters an array using the given closure:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [100, '200', 300, '400', 500];
$filtered = Arr::where($array, function ($value, $key) {
return is_string($value);
});
// [1 => '200', 3 => '400']

The Arr::whereNotNull method removes all null values from the given array:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = [0, null];
$filtered = Arr::whereNotNull($array);
// [0 => 0]

The Arr::wrap method wraps the given value in an array. If the given value is already an array it will be returned without modification:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$string = 'Laravel';
$array = Arr::wrap($string);
// ['Laravel']

If the given value is null, an empty array will be returned:

use NormanHuth\Helpers\Arr; # or use Illuminate\Support\Arr;
$array = Arr::wrap(null);
// []

The data_fill function sets a missing value within a nested array or object using "dot" notation:

$data = ['products' => ['desk' => ['price' => 100]]];
data_fill($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 100]]]
data_fill($data, 'products.desk.discount', 10);
// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]

This function also accepts asterisks as wildcards and will fill the target accordingly:

$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2'],
],
];
data_fill($data, 'products.*.price', 200);
/*
[
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 200],
],
]
*/

The data_get function retrieves a value from a nested array or object using "dot" notation:

$data = ['products' => ['desk' => ['price' => 100]]];
$price = data_get($data, 'products.desk.price');
// 100

The data_get function also accepts a default value, which will be returned if the specified key is not found:

$discount = data_get($data, 'products.desk.discount', 0);
// 0

The function also accepts wildcards using asterisks, which may target any key of the array or object:

$data = [
'product-one' => ['name' => 'Desk 1', 'price' => 100],
'product-two' => ['name' => 'Desk 2', 'price' => 150],
];
data_get($data, '*.name');
// ['Desk 1', 'Desk 2'];

The data_set function sets a value within a nested array or object using "dot" notation:

$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]

This function also accepts wildcards using asterisks and will set values on the target accordingly:

$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 150],
],
];
data_set($data, 'products.*.price', 200);
/*
[
'products' => [
['name' => 'Desk 1', 'price' => 200],
['name' => 'Desk 2', 'price' => 200],
],
]
*/

By default, any existing values are overwritten. If you wish to only set a value if it doesn't exist, you may pass false as the fourth argument to the function:

$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200, overwrite: false);
// ['products' => ['desk' => ['price' => 100]]]

The head function returns the first element in the given array:

$array = [100, 200, 300];
$first = head($array);
// 100

The last function returns the last element in the given array:

$array = [100, 200, 300];
$last = last($array);
// 300

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

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;

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

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$slice = Str::after('This is my name', 'This is');
// ' my name'

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$slice = Str::afterLast('App\Http\Controllers\Controller', '\\');
// 'Controller'

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$slice = Str::ascii('û');
// 'u'

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$slice = Str::before('This is my name', 'my name');
// 'This is '

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$slice = Str::beforeLast('This is my name', 'is');
// 'This '

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$slice = Str::between('This is my name', 'This', 'name');
// ' is my '

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$slice = Str::betweenFirst('[a] bc [d]', '[', ']');
// 'a'

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$converted = Str::camel('foo_bar');
// fooBar

The Str::contains method determines if the given string contains the given value. This method is case sensitive:

use NormanHuth\Helpers\Str; # or use Illuminate\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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$contains = Str::contains('This is my name', ['my', 'foo']);
// true

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$containsAll = Str::containsAll('This is my name', ['my', 'name']);
// true

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

use NormanHuth\Helpers\Str; # or use Illuminate\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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$result = Str::endsWith('This is my name', ['name', 'foo']);
// true
$result = Str::endsWith('This is my name', ['this', 'foo']);
// false

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

use NormanHuth\Helpers\Str; # or use Illuminate\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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$excerpt = Str::excerpt('This is my name', 'name', [
'radius' => 3,
'omission' => '(...) '
]);
// '(...) my name'

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$adjusted = Str::finish('this/string', '/');
// this/string/
$adjusted = Str::finish('this/string/', '/');
// this/string/

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$headline = Str::headline('steve_jobs');
// Steve Jobs
$headline = Str::headline('EmailNotificationSent');
// Email Notification Sent

The Str::inlineMarkdown method converts GitHub flavored Markdown into inline HTML using CommonMark. However, unlike the markdown method, it does not wrap all generated HTML in a block-level element:

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$html = Str::inlineMarkdown('**Laravel**');
// <strong>Laravel</strong>

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$matches = Str::is('foo*', 'foobar');
// true
$matches = Str::is('baz*', 'foobar');
// false

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$isAscii = Str::isAscii('Taylor');
// true
$isAscii = Str::isAscii('ü');
// false

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

use NormanHuth\Helpers\Str; # or use Illuminate\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

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$isUlid = Str::isUlid('01gd6r360bp37zj17nxb55yv40');
// true
$isUlid = Str::isUlid('laravel');
// false

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');
// true
$isUuid = Str::isUuid('laravel');
// false

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$converted = Str::kebab('fooBar');
// foo-bar

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$string = Str::lcfirst('Foo Bar');
// foo Bar

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$length = Str::length('Laravel');
// 7

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

use NormanHuth\Helpers\Str; # or use Illuminate\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:

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');
// The quick brown fox (...)

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$converted = Str::lower('LARAVEL');
// laravel

The Str::markdown method converts GitHub flavored Markdown into HTML using CommonMark:

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$html = Str::markdown('# Laravel');
$html = parseMarkdown('# Laravel');
// <h1>Laravel</h1>
$html = Str::markdown('# Taylor <b>Otwell</b>', [
'html_input' => 'strip',
]);
// <h1>Taylor Otwell</h1>

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$string = Str::mask('taylor@example.com', '*', 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('taylor@example.com', '*', -15, 3);
// tay***@example.com

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
return (string) Str::orderedUuid();

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$padded = Str::padBoth('James', 10, '_');
// '__James___'
$padded = Str::padBoth('James', 10);
// ' James '

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$padded = Str::padLeft('James', 10, '-=');
// '-=-=-James'
$padded = Str::padLeft('James', 10);
// ' James'

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$padded = Str::padRight('James', 10, '-');
// 'James-----'
$padded = Str::padRight('James', 10);
// 'James '

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 NormanHuth\Helpers\Str; # or use Illuminate\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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$plural = Str::plural('child', 2);
// children
$singular = Str::plural('child', 1);
// child

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 NormanHuth\Helpers\Str; # or use Illuminate\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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$plural = Str::pluralStudly('VerifiedHuman', 2);
// VerifiedHumans
$singular = Str::pluralStudly('VerifiedHuman', 1);
// VerifiedHuman

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$random = Str::random(40);

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

use NormanHuth\Helpers\Str; # or use Illuminate\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.

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$string = 'Laravel 8.x';
$replaced = Str::replace('8.x', '9.x', $string);
// Laravel 9.x

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

use NormanHuth\Helpers\Str; # or use Illuminate\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

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

use NormanHuth\Helpers\Str; # or use Illuminate\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

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

use NormanHuth\Helpers\Str; # or use Illuminate\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

The Str::reverse method reverses the given string:

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$reversed = Str::reverse('Hello World');
// dlroW olleH

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$singular = Str::singular('cars');
// car
$singular = Str::singular('children');
// child

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$converted = Str::snake('fooBar');
// foo_bar
$converted = Str::snake('fooBar', '-');
// foo-bar

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$string = Str::squish(' laravel framework ');
// laravel framework

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$adjusted = Str::start('this/string', '/');
// /this/string
$adjusted = Str::start('/this/string', '/');
// /this/string

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

use NormanHuth\Helpers\Str; # or use Illuminate\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

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$converted = Str::studly('foo_bar');
// FooBar

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$converted = Str::substr('The Laravel Framework', 4, 7);
// Laravel

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$count = Str::substrCount('If you like ice cream, you will like snow cones.', 'like');
// 2

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$result = Str::substrReplace('1300', ':', 2);
// 13:
$result = Str::substrReplace('1300', ':', 2, 0);
// 13:00

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$string = Str::swap([
'Tacos' => 'Burritos',
'great' => 'fantastic',
], 'Tacos are great!');
// Burritos are fantastic!

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$converted = Str::title('a nice title uses the correct case');
// A Nice Title Uses The Correct Case

The Str::toHtmlString method converts the string instance to an instance of Illuminate\Support\HtmlString, which may be displayed in Blade templates:

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$htmlString = Str::of('Nuno Maduro')->toHtmlString();

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$string = Str::ucfirst('foo bar');
// Foo bar

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$segments = Str::ucsplit('FooBar');
// [0 => 'Foo', 1 => 'Bar']

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
$string = Str::upper('laravel');
// LARAVEL

The Str::ulid method generates a ULID:

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
return (string) Str::ulid();
// 01gd6r360bp37zj17nxb55yv40

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
return (string) Str::uuid();

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

use NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
Str::wordCount('Hello, world!'); // 2

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 NormanHuth\Helpers\Str; # or use Illuminate\Support\Str;
return Str::words('Perfectly balanced, as all things should be.', 3, ' >>>');
// Perfectly balanced, as >>>

The blank function determines whether the given value is "blank":

blank('');
blank(' ');
blank(null);
blank(collect());
// true
blank(0);
blank(true);
blank(false);
// false

For the inverse of blank, see the filled method.

The class_uses_recursive function returns all traits used by a class, including traits used by all of its parent classes:

$traits = class_uses_recursive(NormanHuth\Helpers\Arr::class);
// ['Illuminate\Support\Traits\Macroable' => 'Illuminate\Support\Traits\Macroable'];

The collect function creates a Collection instance from the given value:

$collection = collect(['taylor', 'abigail']);

The dd function dumps the given variables and ends execution of the script:

dd($value);
dd($value1, $value2, $value3, ...);
dd(['value', 'value1'])

If you do not want to halt the execution of your script, use the dump function instead.

The dump function dumps the given variables:

dump($value);
dump($value1, $value2, $value3, ...);
dump(['value', 'value1'])

If you want to stop executing the script after dumping the variables, use the dd function instead.

The filled function determines whether the given value is not "blank":

filled(0);
filled(true);
filled(false);
// true
filled('');
filled(' ');
filled(null);
filled(collect());
// false

For the inverse of filled, see the blank method.

The now function creates a new Carbon instance for the current time:

$now = now();

Sometimes you may wish to quickly test the performance of certain parts of your application. On those occasions, you may utilize the Benchmark support class to measure the number of milliseconds it takes for the given callbacks to complete:

<?php
use App\Models\User;
use Illuminate\Support\Benchmark;
Benchmark::dd(fn () => User::find(1)); // 0.1 ms
Benchmark::dd([
'Scenario 1' => fn () => User::count(), // 0.5 ms
'Scenario 2' => fn () => User::all()->count(), // 20.0 ms
]);

By default, the given callbacks will be executed once (one iteration), and their duration will be displayed in the browser / console.

To invoke a callback more than once, you may specify the number of iterations that the callback should be invoked as the second argument to the method. When executing a callback more than once, the Benchmark class will return the average amount of milliseconds it took to execute the callback across all iterations:

Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms

Laravel's lottery class may be used to execute callbacks based on a set of given odds. This can be particularly useful when you only want to execute code for a percentage of your incoming requests:

use Illuminate\Support\Lottery;
Lottery::odds(1, 20)
->winner(fn () => $user->won())
->loser(fn () => $user->lost())
->choose();

You may combine Laravel's lottery class with other Laravel features. For example, you may wish to only report a small percentage of slow queries to your exception handler. And, since the lottery class is callable, we may pass an instance of the class into any method that accepts callables:

use Carbon\CarbonInterval;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Lottery;
DB::whenQueryingForLongerThan(
CarbonInterval::seconds(2),
Lottery::odds(1, 100)->winner(fn () => report('Querying > 2 seconds.')),
);

Laravel provides some simple methods to allow you to easily test your application's lottery invocations:

// Lottery will always win...
Lottery::alwaysWin();
// Lottery will always lose...
Lottery::alwaysLose();
// Lottery will win then lose, and finally return to normal behavior...
Lottery::fix([true, false]);
// Lottery will return to normal behavior...
Lottery::determineResultsNormally();