Helpers

• Introduction
• Available Methods

Introduction

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.

Available Methods

Arrays & Objects

Paths

Strings

Fluent Strings

URLs

Miscellaneous

Method Listing

Arrays & Objects

Arr::accessible()

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

 1use Illuminate\Support\Arr;
 2use Illuminate\Support\Collection;
 3 
 4$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);
 5 
 6// true
 7 
 8$isAccessible = Arr::accessible(new Collection);
 9 
10// true
11 
12$isAccessible = Arr::accessible('abc');
13 
14// false
15 
16$isAccessible = Arr::accessible(new stdClass);
17 
18// false
 1use Illuminate\Support\Arr;
 2use Illuminate\Support\Collection;
 3 
 4$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);
 5 
 6// true
 7 
 8$isAccessible = Arr::accessible(new Collection);
 9 
10// true
11 
12$isAccessible = Arr::accessible('abc');
13 
14// false
15 
16$isAccessible = Arr::accessible(new stdClass);
17 
18// false

Arr::add()

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:

1use Illuminate\Support\Arr;
2 
3$array = Arr::add(['name' => 'Desk'], 'price', 100);
4 
5// ['name' => 'Desk', 'price' => 100]
6 
7$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
8 
9// ['name' => 'Desk', 'price' => 100]
1use Illuminate\Support\Arr;
2 
3$array = Arr::add(['name' => 'Desk'], 'price', 100);
4 
5// ['name' => 'Desk', 'price' => 100]
6 
7$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
8 
9// ['name' => 'Desk', 'price' => 100]

Arr::collapse()

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

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

Arr::crossJoin()

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

 1use Illuminate\Support\Arr;
 2 
 3$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
 4 
 5/*
 6    [
 7        [1, 'a'],
 8        [1, 'b'],
 9        [2, 'a'],
10        [2, 'b'],
11    ]
12*/
13 
14$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
15 
16/*
17    [
18        [1, 'a', 'I'],
19        [1, 'a', 'II'],
20        [1, 'b', 'I'],
21        [1, 'b', 'II'],
22        [2, 'a', 'I'],
23        [2, 'a', 'II'],
24        [2, 'b', 'I'],
25        [2, 'b', 'II'],
26    ]
27*/
 1use Illuminate\Support\Arr;
 2 
 3$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
 4 
 5/*
 6    [
 7        [1, 'a'],
 8        [1, 'b'],
 9        [2, 'a'],
10        [2, 'b'],
11    ]
12*/
13 
14$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
15 
16/*
17    [
18        [1, 'a', 'I'],
19        [1, 'a', 'II'],
20        [1, 'b', 'I'],
21        [1, 'b', 'II'],
22        [2, 'a', 'I'],
23        [2, 'a', 'II'],
24        [2, 'b', 'I'],
25        [2, 'b', 'II'],
26    ]
27*/

Arr::divide()

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

1use Illuminate\Support\Arr;
2 
3[$keys, $values] = Arr::divide(['name' => 'Desk']);
4 
5// $keys: ['name']
6 
7// $values: ['Desk']
1use Illuminate\Support\Arr;
2 
3[$keys, $values] = Arr::divide(['name' => 'Desk']);
4 
5// $keys: ['name']
6 
7// $values: ['Desk']

Arr::dot()

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

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5$flattened = Arr::dot($array);
6 
7// ['products.desk.price' => 100]
1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5$flattened = Arr::dot($array);
6 
7// ['products.desk.price' => 100]

Arr::except()

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

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100];
4 
5$filtered = Arr::except($array, ['price']);
6 
7// ['name' => 'Desk']
1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100];
4 
5$filtered = Arr::except($array, ['price']);
6 
7// ['name' => 'Desk']

Arr::exists()

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

 1use Illuminate\Support\Arr;
 2 
 3$array = ['name' => 'John Doe', 'age' => 17];
 4 
 5$exists = Arr::exists($array, 'name');
 6 
 7// true
 8 
 9$exists = Arr::exists($array, 'salary');
10 
11// false
 1use Illuminate\Support\Arr;
 2 
 3$array = ['name' => 'John Doe', 'age' => 17];
 4 
 5$exists = Arr::exists($array, 'name');
 6 
 7// true
 8 
 9$exists = Arr::exists($array, 'salary');
10 
11// false

Arr::first()

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

1use Illuminate\Support\Arr;
2 
3$array = [100, 200, 300];
4 
5$first = Arr::first($array, function ($value, $key) {
6    return $value >= 150;
7});
8 
9// 200
1use Illuminate\Support\Arr;
2 
3$array = [100, 200, 300];
4 
5$first = Arr::first($array, function ($value, $key) {
6    return $value >= 150;
7});
8 
9// 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:

1use Illuminate\Support\Arr;
2 
3$first = Arr::first($array, $callback, $default);
1use Illuminate\Support\Arr;
2 
3$first = Arr::first($array, $callback, $default);

Arr::flatten()

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

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
4 
5$flattened = Arr::flatten($array);
6 
7// ['Joe', 'PHP', 'Ruby']
1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
4 
5$flattened = Arr::flatten($array);
6 
7// ['Joe', 'PHP', 'Ruby']

Arr::forget()

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

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5Arr::forget($array, 'products.desk');
6 
7// ['products' => []]
1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5Arr::forget($array, 'products.desk');
6 
7// ['products' => []]

Arr::get()

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

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5$price = Arr::get($array, 'products.desk.price');
6 
7// 100
1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5$price = Arr::get($array, 'products.desk.price');
6 
7// 100

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

1use Illuminate\Support\Arr;
2 
3$discount = Arr::get($array, 'products.desk.discount', 0);
4 
5// 0
1use Illuminate\Support\Arr;
2 
3$discount = Arr::get($array, 'products.desk.discount', 0);
4 
5// 0

Arr::has()

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

 1use Illuminate\Support\Arr;
 2 
 3$array = ['product' => ['name' => 'Desk', 'price' => 100]];
 4 
 5$contains = Arr::has($array, 'product.name');
 6 
 7// true
 8 
 9$contains = Arr::has($array, ['product.price', 'product.discount']);
10 
11// false
 1use Illuminate\Support\Arr;
 2 
 3$array = ['product' => ['name' => 'Desk', 'price' => 100]];
 4 
 5$contains = Arr::has($array, 'product.name');
 6 
 7// true
 8 
 9$contains = Arr::has($array, ['product.price', 'product.discount']);
10 
11// false

Arr::hasAny()

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

 1use Illuminate\Support\Arr;
 2 
 3$array = ['product' => ['name' => 'Desk', 'price' => 100]];
 4 
 5$contains = Arr::hasAny($array, 'product.name');
 6 
 7// true
 8 
 9$contains = Arr::hasAny($array, ['product.name', 'product.discount']);
10 
11// true
12 
13$contains = Arr::hasAny($array, ['category', 'product.discount']);
14 
15// false
 1use Illuminate\Support\Arr;
 2 
 3$array = ['product' => ['name' => 'Desk', 'price' => 100]];
 4 
 5$contains = Arr::hasAny($array, 'product.name');
 6 
 7// true
 8 
 9$contains = Arr::hasAny($array, ['product.name', 'product.discount']);
10 
11// true
12 
13$contains = Arr::hasAny($array, ['category', 'product.discount']);
14 
15// false

Arr::isAssoc()

The Arr::isAssoc 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:

1use Illuminate\Support\Arr;
2 
3$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
4 
5// true
6 
7$isAssoc = Arr::isAssoc([1, 2, 3]);
8 
9// false
1use Illuminate\Support\Arr;
2 
3$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
4 
5// true
6 
7$isAssoc = Arr::isAssoc([1, 2, 3]);
8 
9// false

Arr::last()

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

1use Illuminate\Support\Arr;
2 
3$array = [100, 200, 300, 110];
4 
5$last = Arr::last($array, function ($value, $key) {
6    return $value >= 150;
7});
8 
9// 300
1use Illuminate\Support\Arr;
2 
3$array = [100, 200, 300, 110];
4 
5$last = Arr::last($array, function ($value, $key) {
6    return $value >= 150;
7});
8 
9// 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:

1use Illuminate\Support\Arr;
2 
3$last = Arr::last($array, $callback, $default);
1use Illuminate\Support\Arr;
2 
3$last = Arr::last($array, $callback, $default);

Arr::only()

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

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
4 
5$slice = Arr::only($array, ['name', 'price']);
6 
7// ['name' => 'Desk', 'price' => 100]
1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
4 
5$slice = Arr::only($array, ['name', 'price']);
6 
7// ['name' => 'Desk', 'price' => 100]

Arr::pluck()

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

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['developer' => ['id' => 1, 'name' => 'Taylor']],
 5    ['developer' => ['id' => 2, 'name' => 'Abigail']],
 6];
 7 
 8$names = Arr::pluck($array, 'developer.name');
 9 
10// ['Taylor', 'Abigail']
 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['developer' => ['id' => 1, 'name' => 'Taylor']],
 5    ['developer' => ['id' => 2, 'name' => 'Abigail']],
 6];
 7 
 8$names = Arr::pluck($array, 'developer.name');
 9 
10// ['Taylor', 'Abigail']

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

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

Arr::prepend()

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

1use Illuminate\Support\Arr;
2 
3$array = ['one', 'two', 'three', 'four'];
4 
5$array = Arr::prepend($array, 'zero');
6 
7// ['zero', 'one', 'two', 'three', 'four']
1use Illuminate\Support\Arr;
2 
3$array = ['one', 'two', 'three', 'four'];
4 
5$array = Arr::prepend($array, 'zero');
6 
7// ['zero', 'one', 'two', 'three', 'four']

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

1use Illuminate\Support\Arr;
2 
3$array = ['price' => 100];
4 
5$array = Arr::prepend($array, 'Desk', 'name');
6 
7// ['name' => 'Desk', 'price' => 100]
1use Illuminate\Support\Arr;
2 
3$array = ['price' => 100];
4 
5$array = Arr::prepend($array, 'Desk', 'name');
6 
7// ['name' => 'Desk', 'price' => 100]

Arr::pull()

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

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100];
4 
5$name = Arr::pull($array, 'name');
6 
7// $name: Desk
8 
9// $array: ['price' => 100]
1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100];
4 
5$name = Arr::pull($array, 'name');
6 
7// $name: Desk
8 
9// $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:

1use Illuminate\Support\Arr;
2 
3$value = Arr::pull($array, $key, $default);
1use Illuminate\Support\Arr;
2 
3$value = Arr::pull($array, $key, $default);

Arr::query()

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

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    'name' => 'Taylor',
 5    'order' => [
 6        'column' => 'created_at',
 7        'direction' => 'desc'
 8    ]
 9];
10 
11Arr::query($array);
12 
13// name=Taylor&order[column]=created_at&order[direction]=desc
 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    'name' => 'Taylor',
 5    'order' => [
 6        'column' => 'created_at',
 7        'direction' => 'desc'
 8    ]
 9];
10 
11Arr::query($array);
12 
13// name=Taylor&order[column]=created_at&order[direction]=desc

Arr::random()

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

1use Illuminate\Support\Arr;
2 
3$array = [1, 2, 3, 4, 5];
4 
5$random = Arr::random($array);
6 
7// 4 - (retrieved randomly)
1use Illuminate\Support\Arr;
2 
3$array = [1, 2, 3, 4, 5];
4 
5$random = Arr::random($array);
6 
7// 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:

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

Arr::set()

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

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5Arr::set($array, 'products.desk.price', 200);
6 
7// ['products' => ['desk' => ['price' => 200]]]
1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5Arr::set($array, 'products.desk.price', 200);
6 
7// ['products' => ['desk' => ['price' => 200]]]

Arr::shuffle()

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

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

Arr::sort()

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

1use Illuminate\Support\Arr;
2 
3$array = ['Desk', 'Table', 'Chair'];
4 
5$sorted = Arr::sort($array);
6 
7// ['Chair', 'Desk', 'Table']
1use Illuminate\Support\Arr;
2 
3$array = ['Desk', 'Table', 'Chair'];
4 
5$sorted = Arr::sort($array);
6 
7// ['Chair', 'Desk', 'Table']

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

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['name' => 'Desk'],
 5    ['name' => 'Table'],
 6    ['name' => 'Chair'],
 7];
 8 
 9$sorted = array_values(Arr::sort($array, function ($value) {
10    return $value['name'];
11}));
12 
13/*
14    [
15        ['name' => 'Chair'],
16        ['name' => 'Desk'],
17        ['name' => 'Table'],
18    ]
19*/
 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['name' => 'Desk'],
 5    ['name' => 'Table'],
 6    ['name' => 'Chair'],
 7];
 8 
 9$sorted = array_values(Arr::sort($array, function ($value) {
10    return $value['name'];
11}));
12 
13/*
14    [
15        ['name' => 'Chair'],
16        ['name' => 'Desk'],
17        ['name' => 'Table'],
18    ]
19*/

Arr::sortRecursive()

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:

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['Roman', 'Taylor', 'Li'],
 5    ['PHP', 'Ruby', 'JavaScript'],
 6    ['one' => 1, 'two' => 2, 'three' => 3],
 7];
 8 
 9$sorted = Arr::sortRecursive($array);
10 
11/*
12    [
13        ['JavaScript', 'PHP', 'Ruby'],
14        ['one' => 1, 'three' => 3, 'two' => 2],
15        ['Li', 'Roman', 'Taylor'],
16    ]
17*/
 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['Roman', 'Taylor', 'Li'],
 5    ['PHP', 'Ruby', 'JavaScript'],
 6    ['one' => 1, 'two' => 2, 'three' => 3],
 7];
 8 
 9$sorted = Arr::sortRecursive($array);
10 
11/*
12    [
13        ['JavaScript', 'PHP', 'Ruby'],
14        ['one' => 1, 'three' => 3, 'two' => 2],
15        ['Li', 'Roman', 'Taylor'],
16    ]
17*/

Arr::toCssClasses()

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:

 1use Illuminate\Support\Arr;
 2 
 3$isActive = false;
 4$hasError = true;
 5 
 6$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];
 7 
 8$classes = Arr::toCssClasses($array);
 9 
10/*
11    'p-4 bg-red'
12*/
 1use Illuminate\Support\Arr;
 2 
 3$isActive = false;
 4$hasError = true;
 5 
 6$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];
 7 
 8$classes = Arr::toCssClasses($array);
 9 
10/*
11    'p-4 bg-red'
12*/

This method powers Laravel's functionality allowing merging classes with a Blade component's attribute bag as well as the @class Blade directive.

Arr::undot()

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

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    'user.name' => 'Kevin Malone',
 5    'user.occupation' => 'Accountant',
 6];
 7 
 8$array = Arr::undot($array);
 9 
10// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]
 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    'user.name' => 'Kevin Malone',
 5    'user.occupation' => 'Accountant',
 6];
 7 
 8$array = Arr::undot($array);
 9 
10// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]

Arr::where()

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

1use Illuminate\Support\Arr;
2 
3$array = [100, '200', 300, '400', 500];
4 
5$filtered = Arr::where($array, function ($value, $key) {
6    return is_string($value);
7});
8 
9// [1 => '200', 3 => '400']
1use Illuminate\Support\Arr;
2 
3$array = [100, '200', 300, '400', 500];
4 
5$filtered = Arr::where($array, function ($value, $key) {
6    return is_string($value);
7});
8 
9// [1 => '200', 3 => '400']

Arr::whereNotNull()

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

1use Illuminate\Support\Arr;
2 
3$array = [0, null];
4 
5$filtered = Arr::whereNotNull($array);
6 
7// [0 => 0]
1use Illuminate\Support\Arr;
2 
3$array = [0, null];
4 
5$filtered = Arr::whereNotNull($array);
6 
7// [0 => 0]

Arr::wrap()

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:

1use Illuminate\Support\Arr;
2 
3$string = 'Laravel';
4 
5$array = Arr::wrap($string);
6 
7// ['Laravel']
1use Illuminate\Support\Arr;
2 
3$string = 'Laravel';
4 
5$array = Arr::wrap($string);
6 
7// ['Laravel']

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

1use Illuminate\Support\Arr;
2 
3$array = Arr::wrap(null);
4 
5// []
1use Illuminate\Support\Arr;
2 
3$array = Arr::wrap(null);
4 
5// []

data_fill()

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

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_fill($data, 'products.desk.price', 200);
4 
5// ['products' => ['desk' => ['price' => 100]]]
6 
7data_fill($data, 'products.desk.discount', 10);
8 
9// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]
1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_fill($data, 'products.desk.price', 200);
4 
5// ['products' => ['desk' => ['price' => 100]]]
6 
7data_fill($data, 'products.desk.discount', 10);
8 
9// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]

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

 1$data = [
 2    'products' => [
 3        ['name' => 'Desk 1', 'price' => 100],
 4        ['name' => 'Desk 2'],
 5    ],
 6];
 7 
 8data_fill($data, 'products.*.price', 200);
 9 
10/*
11    [
12        'products' => [
13            ['name' => 'Desk 1', 'price' => 100],
14            ['name' => 'Desk 2', 'price' => 200],
15        ],
16    ]
17*/
 1$data = [
 2    'products' => [
 3        ['name' => 'Desk 1', 'price' => 100],
 4        ['name' => 'Desk 2'],
 5    ],
 6];
 7 
 8data_fill($data, 'products.*.price', 200);
 9 
10/*
11    [
12        'products' => [
13            ['name' => 'Desk 1', 'price' => 100],
14            ['name' => 'Desk 2', 'price' => 200],
15        ],
16    ]
17*/

data_get()

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

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3$price = data_get($data, 'products.desk.price');
4 
5// 100
1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3$price = data_get($data, 'products.desk.price');
4 
5// 100

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

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

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

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

data_set()

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

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_set($data, 'products.desk.price', 200);
4 
5// ['products' => ['desk' => ['price' => 200]]]
1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_set($data, 'products.desk.price', 200);
4 
5// ['products' => ['desk' => ['price' => 200]]]

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

 1$data = [
 2    'products' => [
 3        ['name' => 'Desk 1', 'price' => 100],
 4        ['name' => 'Desk 2', 'price' => 150],
 5    ],
 6];
 7 
 8data_set($data, 'products.*.price', 200);
 9 
10/*
11    [
12        'products' => [
13            ['name' => 'Desk 1', 'price' => 200],
14            ['name' => 'Desk 2', 'price' => 200],
15        ],
16    ]
17*/
 1$data = [
 2    'products' => [
 3        ['name' => 'Desk 1', 'price' => 100],
 4        ['name' => 'Desk 2', 'price' => 150],
 5    ],
 6];
 7 
 8data_set($data, 'products.*.price', 200);
 9 
10/*
11    [
12        'products' => [
13            ['name' => 'Desk 1', 'price' => 200],
14            ['name' => 'Desk 2', 'price' => 200],
15        ],
16    ]
17*/

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:

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_set($data, 'products.desk.price', 200, $overwrite = false);
4 
5// ['products' => ['desk' => ['price' => 100]]]
1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_set($data, 'products.desk.price', 200, $overwrite = false);
4 
5// ['products' => ['desk' => ['price' => 100]]]

head()

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

1$array = [100, 200, 300];
2 
3$first = head($array);
4 
5// 100
1$array = [100, 200, 300];
2 
3$first = head($array);
4 
5// 100

last()

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

1$array = [100, 200, 300];
2 
3$last = last($array);
4 
5// 300
1$array = [100, 200, 300];
2 
3$last = last($array);
4 
5// 300

Paths

app_path()

The app_path function returns the fully qualified path to your application's app directory. You may also use the app_path function to generate a fully qualified path to a file relative to the application directory:

1$path = app_path();
2 
3$path = app_path('Http/Controllers/Controller.php');
1$path = app_path();
2 
3$path = app_path('Http/Controllers/Controller.php');

base_path()

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:

1$path = base_path();
2 
3$path = base_path('vendor/bin');
1$path = base_path();
2 
3$path = base_path('vendor/bin');

config_path()

The config_path function returns the fully qualified path to your application's config directory. You may also use the config_path function to generate a fully qualified path to a given file within the application's configuration directory:

1$path = config_path();
2 
3$path = config_path('app.php');
1$path = config_path();
2 
3$path = config_path('app.php');

database_path()

The database_path function returns the fully qualified path to your application's database directory. You may also use the database_path function to generate a fully qualified path to a given file within the database directory:

1$path = database_path();
2 
3$path = database_path('factories/UserFactory.php');
1$path = database_path();
2 
3$path = database_path('factories/UserFactory.php');

mix()

The mix function returns the path to a versioned Mix file:

1$path = mix('css/app.css');
1$path = mix('css/app.css');

public_path()

The public_path function returns the fully qualified path to your application's public directory. You may also use the public_path function to generate a fully qualified path to a given file within the public directory:

1$path = public_path();
2 
3$path = public_path('css/app.css');
1$path = public_path();
2 
3$path = public_path('css/app.css');

resource_path()

The resource_path function returns the fully qualified path to your application's resources directory. You may also use the resource_path function to generate a fully qualified path to a given file within the resources directory:

1$path = resource_path();
2 
3$path = resource_path('sass/app.scss');
1$path = resource_path();
2 
3$path = resource_path('sass/app.scss');

storage_path()

The storage_path function returns the fully qualified path to your application's storage directory. You may also use the storage_path function to generate a fully qualified path to a given file within the storage directory:

1$path = storage_path();
2 
3$path = storage_path('app/file.txt');
1$path = storage_path();
2 
3$path = storage_path('app/file.txt');

Strings

__()

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

1echo __('Welcome to our application');
2 
3echo __('messages.welcome');
1echo __('Welcome to our application');
2 
3echo __('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:

1$class = class_basename('Foo\Bar\Baz');
2 
3// Baz
1$class = class_basename('Foo\Bar\Baz');
2 
3// Baz

e()

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

1echo e('<html>foo</html>');
2 
3// &lt;html&gt;foo&lt;/html&gt;
1echo e('<html>foo</html>');
2 
3// &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:

1$string = 'The event will take place between :start and :end';
2 
3$replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string);
4 
5// The event will take place between 8:30 and 9:00
1$string = 'The event will take place between :start and :end';
2 
3$replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string);
4 
5// 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:

1use Illuminate\Support\Str;
2 
3$slice = Str::after('This is my name', 'This is');
4 
5// ' my name'
1use Illuminate\Support\Str;
2 
3$slice = Str::after('This is my name', 'This is');
4 
5// ' 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:

1use Illuminate\Support\Str;
2 
3$slice = Str::afterLast('App\Http\Controllers\Controller', '\\');
4 
5// 'Controller'
1use Illuminate\Support\Str;
2 
3$slice = Str::afterLast('App\Http\Controllers\Controller', '\\');
4 
5// 'Controller'

Str::ascii()

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

1use Illuminate\Support\Str;
2 
3$slice = Str::ascii('û');
4 
5// 'u'
1use Illuminate\Support\Str;
2 
3$slice = Str::ascii('û');
4 
5// 'u'

Str::before()

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

1use Illuminate\Support\Str;
2 
3$slice = Str::before('This is my name', 'my name');
4 
5// 'This is '
1use Illuminate\Support\Str;
2 
3$slice = Str::before('This is my name', 'my name');
4 
5// 'This is '

Str::beforeLast()

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

1use Illuminate\Support\Str;
2 
3$slice = Str::beforeLast('This is my name', 'is');
4 
5// 'This '
1use Illuminate\Support\Str;
2 
3$slice = Str::beforeLast('This is my name', 'is');
4 
5// 'This '

Str::between()

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

1use Illuminate\Support\Str;
2 
3$slice = Str::between('This is my name', 'This', 'name');
4 
5// ' is my '
1use Illuminate\Support\Str;
2 
3$slice = Str::between('This is my name', 'This', 'name');
4 
5// ' is my '

Str::camel()

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

1use Illuminate\Support\Str;
2 
3$converted = Str::camel('foo_bar');
4 
5// fooBar
1use Illuminate\Support\Str;
2 
3$converted = Str::camel('foo_bar');
4 
5// fooBar

Str::contains()

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

1use Illuminate\Support\Str;
2 
3$contains = Str::contains('This is my name', 'my');
4 
5// true
1use Illuminate\Support\Str;
2 
3$contains = Str::contains('This is my name', 'my');
4 
5// true

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

1use Illuminate\Support\Str;
2 
3$contains = Str::contains('This is my name', ['my', 'foo']);
4 
5// true
1use Illuminate\Support\Str;
2 
3$contains = Str::contains('This is my name', ['my', 'foo']);
4 
5// true

Str::containsAll()

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

1use Illuminate\Support\Str;
2 
3$containsAll = Str::containsAll('This is my name', ['my', 'name']);
4 
5// true
1use Illuminate\Support\Str;
2 
3$containsAll = Str::containsAll('This is my name', ['my', 'name']);
4 
5// true

Str::endsWith()

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

1use Illuminate\Support\Str;
2 
3$result = Str::endsWith('This is my name', 'name');
4 
5// true
1use Illuminate\Support\Str;
2 
3$result = Str::endsWith('This is my name', 'name');
4 
5// true

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

1use Illuminate\Support\Str;
2 
3$result = Str::endsWith('This is my name', ['name', 'foo']);
4 
5// true
6 
7$result = Str::endsWith('This is my name', ['this', 'foo']);
8 
9// false
1use Illuminate\Support\Str;
2 
3$result = Str::endsWith('This is my name', ['name', 'foo']);
4 
5// true
6 
7$result = Str::endsWith('This is my name', ['this', 'foo']);
8 
9// false

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:

1use Illuminate\Support\Str;
2 
3$adjusted = Str::finish('this/string', '/');
4 
5// this/string/
6 
7$adjusted = Str::finish('this/string/', '/');
8 
9// this/string/
1use Illuminate\Support\Str;
2 
3$adjusted = Str::finish('this/string', '/');
4 
5// this/string/
6 
7$adjusted = Str::finish('this/string/', '/');
8 
9// 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:

1use Illuminate\Support\Str;
2 
3$headline = Str::headline('steve_jobs');
4 
5// Steve Jobs
6 
7$headline = Str::headline('EmailNotificationSent');
8 
9// Email Notification Sent
1use Illuminate\Support\Str;
2 
3$headline = Str::headline('steve_jobs');
4 
5// Steve Jobs
6 
7$headline = Str::headline('EmailNotificationSent');
8 
9// 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:

1use Illuminate\Support\Str;
2 
3$matches = Str::is('foo*', 'foobar');
4 
5// true
6 
7$matches = Str::is('baz*', 'foobar');
8 
9// false
1use Illuminate\Support\Str;
2 
3$matches = Str::is('foo*', 'foobar');
4 
5// true
6 
7$matches = Str::is('baz*', 'foobar');
8 
9// false

Str::isAscii()

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

1use Illuminate\Support\Str;
2 
3$isAscii = Str::isAscii('Taylor');
4 
5// true
6 
7$isAscii = Str::isAscii('ü');
8 
9// false
1use Illuminate\Support\Str;
2 
3$isAscii = Str::isAscii('Taylor');
4 
5// true
6 
7$isAscii = Str::isAscii('ü');
8 
9// false

Str::isUuid()

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

1use Illuminate\Support\Str;
2 
3$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');
4 
5// true
6 
7$isUuid = Str::isUuid('laravel');
8 
9// false
1use Illuminate\Support\Str;
2 
3$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');
4 
5// true
6 
7$isUuid = Str::isUuid('laravel');
8 
9// false

Str::kebab()

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

1use Illuminate\Support\Str;
2 
3$converted = Str::kebab('fooBar');
4 
5// foo-bar
1use Illuminate\Support\Str;
2 
3$converted = Str::kebab('fooBar');
4 
5// foo-bar

Str::length()

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

1use Illuminate\Support\Str;
2 
3$length = Str::length('Laravel');
4 
5// 7
1use Illuminate\Support\Str;
2 
3$length = Str::length('Laravel');
4 
5// 7

Str::limit()

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

1use Illuminate\Support\Str;
2 
3$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);
4 
5// The quick brown fox...
1use Illuminate\Support\Str;
2 
3$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);
4 
5// 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:

1use Illuminate\Support\Str;
2 
3$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');
4 
5// The quick brown fox (...)
1use Illuminate\Support\Str;
2 
3$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');
4 
5// The quick brown fox (...)

Str::lower()

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

1use Illuminate\Support\Str;
2 
3$converted = Str::lower('LARAVEL');
4 
5// laravel
1use Illuminate\Support\Str;
2 
3$converted = Str::lower('LARAVEL');
4 
5// laravel

Str::markdown()

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

 1use Illuminate\Support\Str;
 2 
 3$html = Str::markdown('# Laravel');
 4 
 5// <h1>Laravel</h1>
 6 
 7$html = Str::markdown('# Taylor <b>Otwell</b>', [
 8    'html_input' => 'strip',
 9]);
10 
11// <h1>Taylor Otwell</h1>
 1use Illuminate\Support\Str;
 2 
 3$html = Str::markdown('# Laravel');
 4 
 5// <h1>Laravel</h1>
 6 
 7$html = Str::markdown('# Taylor <b>Otwell</b>', [
 8    'html_input' => 'strip',
 9]);
10 
11// <h1>Taylor Otwell</h1>

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:

1use Illuminate\Support\Str;
2 
3$string = Str::mask('[email protected]', '*', 3);
4 
5// tay***************
1use Illuminate\Support\Str;
2 
3$string = Str::mask('[email protected]', '*', 3);
4 
5// 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:

1$string = Str::mask('[email protected]', '*', -15, 3);
2 
3// tay***@example.com
1$string = Str::mask('[email protected]', '*', -15, 3);
2 
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:

1use Illuminate\Support\Str;
2 
3return (string) Str::orderedUuid();
1use Illuminate\Support\Str;
2 
3return (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:

1use Illuminate\Support\Str;
2 
3$padded = Str::padBoth('James', 10, '_');
4 
5// '__James___'
6 
7$padded = Str::padBoth('James', 10);
8 
9// '  James   '
1use Illuminate\Support\Str;
2 
3$padded = Str::padBoth('James', 10, '_');
4 
5// '__James___'
6 
7$padded = Str::padBoth('James', 10);
8 
9// '  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:

1use Illuminate\Support\Str;
2 
3$padded = Str::padLeft('James', 10, '-=');
4 
5// '-=-=-James'
6 
7$padded = Str::padLeft('James', 10);
8 
9// '     James'
1use Illuminate\Support\Str;
2 
3$padded = Str::padLeft('James', 10, '-=');
4 
5// '-=-=-James'
6 
7$padded = Str::padLeft('James', 10);
8 
9// '     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:

1use Illuminate\Support\Str;
2 
3$padded = Str::padRight('James', 10, '-');
4 
5// 'James-----'
6 
7$padded = Str::padRight('James', 10);
8 
9// 'James     '
1use Illuminate\Support\Str;
2 
3$padded = Str::padRight('James', 10, '-');
4 
5// 'James-----'
6 
7$padded = Str::padRight('James', 10);
8 
9// 'James     '