140 KiB
Helpers
- Introduction
- Available Methods
- Other Utilities
- Benchmarking
- Dates
- Deferred Functions
- Lottery
- Pipeline
- Sleep
- Timebox
- URI
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
Arr::accessible Arr::add Arr::array Arr::boolean Arr::collapse Arr::crossJoin Arr::divide Arr::dot Arr::every Arr::except Arr::exists Arr::first Arr::flatten Arr::float Arr::forget Arr::from Arr::get Arr::has Arr::hasAll Arr::hasAny Arr::integer Arr::isAssoc Arr::isList Arr::join Arr::keyBy Arr::last Arr::map Arr::mapSpread Arr::mapWithKeys Arr::only Arr::partition Arr::pluck Arr::prepend Arr::prependKeysWith Arr::pull Arr::push Arr::query Arr::random Arr::reject Arr::select Arr::set Arr::shuffle Arr::sole Arr::some Arr::sort Arr::sortDesc Arr::sortRecursive Arr::string Arr::take Arr::toCssClasses Arr::toCssStyles Arr::undot Arr::where Arr::whereNotNull Arr::wrap data_fill data_get data_set data_forget head last
Numbers
Number::abbreviate Number::clamp Number::currency Number::defaultCurrency Number::defaultLocale Number::fileSize Number::forHumans Number::format Number::ordinal Number::pairs Number::parseInt Number::parseFloat Number::percentage Number::spell Number::spellOrdinal Number::trim Number::useLocale Number::withLocale Number::useCurrency Number::withCurrency
Paths
app_path base_path config_path database_path lang_path public_path resource_path storage_path
URLs
action asset route secure_asset secure_url to_action to_route uri url
Miscellaneous
abort abort_if abort_unless app auth back bcrypt blank broadcast broadcast_if broadcast_unless cache class_uses_recursive collect config context cookie csrf_field csrf_token decrypt dd dispatch dispatch_sync dump encrypt env event fake filled info literal logger method_field now old once optional policy redirect report report_if report_unless request rescue resolve response retry session tap throw_if throw_unless today trait_uses_recursive transform validator value view with when
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
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
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]
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]
Arr::array()
The Arr::array method retrieves a value from a deeply nested array using
"dot" notation (just as Arr::get() does), but throws an
InvalidArgumentException if the requested value is not an array:
1use Illuminate\Support\Arr;
2
3$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
4
5$value = Arr::array($array, 'languages');
6
7// ['PHP', 'Ruby']
8
9$value = Arr::array($array, 'name');
10
11// throws InvalidArgumentException
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$value = Arr::array($array, 'languages');
// ['PHP', 'Ruby']
$value = Arr::array($array, 'name');
// throws InvalidArgumentException
Arr::boolean()
The Arr::boolean method retrieves a value from a deeply nested array using
"dot" notation (just as Arr::get() does), but throws an
InvalidArgumentException if the requested value is not a boolean:
1use Illuminate\Support\Arr;
2
3$array = ['name' => 'Joe', 'available' => true];
4
5$value = Arr::boolean($array, 'available');
6
7// true
8
9$value = Arr::boolean($array, 'name');
10
11// throws InvalidArgumentException
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'available' => true];
$value = Arr::boolean($array, 'available');
// true
$value = Arr::boolean($array, 'name');
// throws InvalidArgumentException
Arr::collapse()
The Arr::collapse method collapses an array of arrays or collections 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]
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]
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*/
use Illuminate\Support\Arr;
$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
/*
[
[1, 'a'],
[1, 'b'],
[2, 'a'],
[2, 'b'],
]
*/
$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
/*
[
[1, 'a', 'I'],
[1, 'a', 'II'],
[1, 'b', 'I'],
[1, 'b', 'II'],
[2, 'a', 'I'],
[2, 'a', 'II'],
[2, 'b', 'I'],
[2, 'b', 'II'],
]
*/
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']
use Illuminate\Support\Arr;
[$keys, $values] = Arr::divide(['name' => 'Desk']);
// $keys: ['name']
// $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]
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$flattened = Arr::dot($array);
// ['products.desk.price' => 100]
Arr::every()
The Arr::every method ensures that all values in the array pass a given
truth test:
1use Illuminate\Support\Arr;
2
3$array = [1, 2, 3];
4
5Arr::every($array, fn ($i) => $i > 0);
6
7// true
8
9Arr::every($array, fn ($i) => $i > 2);
10
11// false
use Illuminate\Support\Arr;
$array = [1, 2, 3];
Arr::every($array, fn ($i) => $i > 0);
// true
Arr::every($array, fn ($i) => $i > 2);
// false
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']
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$filtered = Arr::except($array, ['price']);
// ['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
use Illuminate\Support\Arr;
$array = ['name' => 'John Doe', 'age' => 17];
$exists = Arr::exists($array, 'name');
// true
$exists = Arr::exists($array, 'salary');
// 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 (int $value, int $key) {
6 return $value >= 150;
7});
8
9// 200
use Illuminate\Support\Arr;
$array = [100, 200, 300];
$first = Arr::first($array, function (int $value, int $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:
1use Illuminate\Support\Arr;
2
3$first = Arr::first($array, $callback, $default);
use Illuminate\Support\Arr;
$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']
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$flattened = Arr::flatten($array);
// ['Joe', 'PHP', 'Ruby']
Arr::float()
The Arr::float method retrieves a value from a deeply nested array using
"dot" notation (just as Arr::get() does), but throws an
InvalidArgumentException if the requested value is not a float:
1use Illuminate\Support\Arr;
2
3$array = ['name' => 'Joe', 'balance' => 123.45];
4
5$value = Arr::float($array, 'balance');
6
7// 123.45
8
9$value = Arr::float($array, 'name');
10
11// throws InvalidArgumentException
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'balance' => 123.45];
$value = Arr::float($array, 'balance');
// 123.45
$value = Arr::float($array, 'name');
// throws InvalidArgumentException
Arr::forget()
The Arr::forget method removes a given key / value pairs 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' => []]
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::forget($array, 'products.desk');
// ['products' => []]
Arr::from()
The Arr::from method converts various input types into a plain PHP array. It
supports a range of input types, including arrays, objects, and several common
Laravel interfaces, such as Arrayable, Enumerable, Jsonable, and
JsonSerializable. Additionally, it handles Traversable and WeakMap
instances:
1use Illuminate\Support\Arr;
2
3Arr::from((object) ['foo' => 'bar']); // ['foo' => 'bar']
4
5class TestJsonableObject implements Jsonable
6{
7 public function toJson($options = 0)
8 {
9 return json_encode(['foo' => 'bar']);
10 }
11}
12
13Arr::from(new TestJsonableObject); // ['foo' => 'bar']
use Illuminate\Support\Arr;
Arr::from((object) ['foo' => 'bar']); // ['foo' => 'bar']
class TestJsonableObject implements Jsonable
{
public function toJson($options = 0)
{
return json_encode(['foo' => 'bar']);
}
}
Arr::from(new TestJsonableObject); // ['foo' => 'bar']
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
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:
1use Illuminate\Support\Arr;
2
3$discount = Arr::get($array, 'products.desk.discount', 0);
4
5// 0
use Illuminate\Support\Arr;
$discount = Arr::get($array, 'products.desk.discount', 0);
// 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
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
Arr::hasAll()
The Arr::hasAll method determines if all of the specified keys exist in the
given array using "dot" notation:
1use Illuminate\Support\Arr;
2
3$array = ['name' => 'Taylor', 'language' => 'PHP'];
4
5Arr::hasAll($array, ['name']); // true
6Arr::hasAll($array, ['name', 'language']); // true
7Arr::hasAll($array, ['name', 'IDE']); // false
use Illuminate\Support\Arr;
$array = ['name' => 'Taylor', 'language' => 'PHP'];
Arr::hasAll($array, ['name']); // true
Arr::hasAll($array, ['name', 'language']); // true
Arr::hasAll($array, ['name', 'IDE']); // 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
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
Arr::integer()
The Arr::integer method retrieves a value from a deeply nested array using
"dot" notation (just as Arr::get() does), but throws an
InvalidArgumentException if the requested value is not an int:
1use Illuminate\Support\Arr;
2
3$array = ['name' => 'Joe', 'age' => 42];
4
5$value = Arr::integer($array, 'age');
6
7// 42
8
9$value = Arr::integer($array, 'name');
10
11// throws InvalidArgumentException
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'age' => 42];
$value = Arr::integer($array, 'age');
// 42
$value = Arr::integer($array, 'name');
// throws InvalidArgumentException
Arr::isAssoc()
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:
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
use Illuminate\Support\Arr;
$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
// true
$isAssoc = Arr::isAssoc([1, 2, 3]);
// false
Arr::isList()
The Arr::isList method returns true if the given array's keys are
sequential integers beginning from zero:
1use Illuminate\Support\Arr;
2
3$isList = Arr::isList(['foo', 'bar', 'baz']);
4
5// true
6
7$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);
8
9// false
use Illuminate\Support\Arr;
$isList = Arr::isList(['foo', 'bar', 'baz']);
// true
$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);
// false
Arr::join()
The Arr::join method joins array elements with a string. Using this method's
third argument, you may also specify the joining string for the final element
of the array:
1use Illuminate\Support\Arr;
2
3$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];
4
5$joined = Arr::join($array, ', ');
6
7// Tailwind, Alpine, Laravel, Livewire
8
9$joined = Arr::join($array, ', ', ', and ');
10
11// Tailwind, Alpine, Laravel, and Livewire
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
Arr::keyBy()
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:
1use Illuminate\Support\Arr;
2
3$array = [
4 ['product_id' => 'prod-100', 'name' => 'Desk'],
5 ['product_id' => 'prod-200', 'name' => 'Chair'],
6];
7
8$keyed = Arr::keyBy($array, 'product_id');
9
10/*
11 [
12 'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
13 'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
14 ]
15*/
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'],
]
*/
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 (int $value, int $key) {
6 return $value >= 150;
7});
8
9// 300
use Illuminate\Support\Arr;
$array = [100, 200, 300, 110];
$last = Arr::last($array, function (int $value, int $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:
1use Illuminate\Support\Arr;
2
3$last = Arr::last($array, $callback, $default);
use Illuminate\Support\Arr;
$last = Arr::last($array, $callback, $default);
Arr::map()
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:
1use Illuminate\Support\Arr;
2
3$array = ['first' => 'james', 'last' => 'kirk'];
4
5$mapped = Arr::map($array, function (string $value, string $key) {
6 return ucfirst($value);
7});
8
9// ['first' => 'James', 'last' => 'Kirk']
use Illuminate\Support\Arr;
$array = ['first' => 'james', 'last' => 'kirk'];
$mapped = Arr::map($array, function (string $value, string $key) {
return ucfirst($value);
});
// ['first' => 'James', 'last' => 'Kirk']
Arr::mapSpread()
The Arr::mapSpread method iterates over the array, passing each nested item
value into the given closure. The closure is free to modify the item and
return it, thus forming a new array of modified items:
1use Illuminate\Support\Arr;
2
3$array = [
4 [0, 1],
5 [2, 3],
6 [4, 5],
7 [6, 7],
8 [8, 9],
9];
10
11$mapped = Arr::mapSpread($array, function (int $even, int $odd) {
12 return $even + $odd;
13});
14
15/*
16 [1, 5, 9, 13, 17]
17*/
use Illuminate\Support\Arr;
$array = [
[0, 1],
[2, 3],
[4, 5],
[6, 7],
[8, 9],
];
$mapped = Arr::mapSpread($array, function (int $even, int $odd) {
return $even + $odd;
});
/*
[1, 5, 9, 13, 17]
*/
Arr::mapWithKeys()
The Arr::mapWithKeys method iterates through the array and passes each value
to the given callback. The callback should return an associative array
containing a single key / value pair:
1use Illuminate\Support\Arr;
2
3$array = [
4 [
5 'name' => 'John',
6 'department' => 'Sales',
7 'email' => '[[email protected]](/cdn-cgi/l/email-protection)',
8 ],
9 [
10 'name' => 'Jane',
11 'department' => 'Marketing',
12 'email' => '[[email protected]](/cdn-cgi/l/email-protection)',
13 ]
14];
15
16$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
17 return [$item['email'] => $item['name']];
18});
19
20/*
21 [
22 '[[email protected]](/cdn-cgi/l/email-protection)' => 'John',
23 '[[email protected]](/cdn-cgi/l/email-protection)' => 'Jane',
24 ]
25*/
use Illuminate\Support\Arr;
$array = [
[
'name' => 'John',
'department' => 'Sales',
'email' => '[[email protected]](/cdn-cgi/l/email-protection)',
],
[
'name' => 'Jane',
'department' => 'Marketing',
'email' => '[[email protected]](/cdn-cgi/l/email-protection)',
]
];
$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
return [$item['email'] => $item['name']];
});
/*
[
'[[email protected]](/cdn-cgi/l/email-protection)' => 'John',
'[[email protected]](/cdn-cgi/l/email-protection)' => 'Jane',
]
*/
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]
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
$slice = Arr::only($array, ['name', 'price']);
// ['name' => 'Desk', 'price' => 100]
Arr::partition()
The Arr::partition method may be combined with PHP array destructuring to
separate elements that pass a given truth test from those that do not:
1<?php
2
3use Illuminate\Support\Arr;
4
5$numbers = [1, 2, 3, 4, 5, 6];
6
7[$underThree, $equalOrAboveThree] = Arr::partition($numbers, function (int $i) {
8 return $i < 3;
9});
10
11dump($underThree);
12
13// [1, 2]
14
15dump($equalOrAboveThree);
16
17// [3, 4, 5, 6]
<?php
use Illuminate\Support\Arr;
$numbers = [1, 2, 3, 4, 5, 6];
[$underThree, $equalOrAboveThree] = Arr::partition($numbers, function (int $i) {
return $i < 3;
});
dump($underThree);
// [1, 2]
dump($equalOrAboveThree);
// [3, 4, 5, 6]
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']
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:
1use Illuminate\Support\Arr;
2
3$names = Arr::pluck($array, 'developer.name', 'developer.id');
4
5// [1 => 'Taylor', 2 => 'Abigail']
use Illuminate\Support\Arr;
$names = Arr::pluck($array, 'developer.name', 'developer.id');
// [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']
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:
1use Illuminate\Support\Arr;
2
3$array = ['price' => 100];
4
5$array = Arr::prepend($array, 'Desk', 'name');
6
7// ['name' => 'Desk', 'price' => 100]
use Illuminate\Support\Arr;
$array = ['price' => 100];
$array = Arr::prepend($array, 'Desk', 'name');
// ['name' => 'Desk', 'price' => 100]
Arr::prependKeysWith()
The Arr::prependKeysWith prepends all key names of an associative array with
the given prefix:
1use Illuminate\Support\Arr;
2
3$array = [
4 'name' => 'Desk',
5 'price' => 100,
6];
7
8$keyed = Arr::prependKeysWith($array, 'product.');
9
10/*
11 [
12 'product.name' => 'Desk',
13 'product.price' => 100,
14 ]
15*/
use Illuminate\Support\Arr;
$array = [
'name' => 'Desk',
'price' => 100,
];
$keyed = Arr::prependKeysWith($array, 'product.');
/*
[
'product.name' => 'Desk',
'product.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]
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:
1use Illuminate\Support\Arr;
2
3$value = Arr::pull($array, $key, $default);
use Illuminate\Support\Arr;
$value = Arr::pull($array, $key, $default);
Arr::push()
The Arr::push method pushes an item into an array using "dot" notation. If
an array does not exist at the given key, it will be created:
1use Illuminate\Support\Arr;
2
3$array = [];
4
5Arr::push($array, 'office.furniture', 'Desk');
6
7// $array: ['office' => ['furniture' => ['Desk']]]
use Illuminate\Support\Arr;
$array = [];
Arr::push($array, 'office.furniture', 'Desk');
// $array: ['office' => ['furniture' => ['Desk']]]
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
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
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)
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:
1use Illuminate\Support\Arr;
2
3$items = Arr::random($array, 2);
4
5// [2, 5] - (retrieved randomly)
use Illuminate\Support\Arr;
$items = Arr::random($array, 2);
// [2, 5] - (retrieved randomly)
Arr::reject()
The Arr::reject method removes items from an array using the given closure:
1use Illuminate\Support\Arr;
2
3$array = [100, '200', 300, '400', 500];
4
5$filtered = Arr::reject($array, function (string|int $value, int $key) {
6 return is_string($value);
7});
8
9// [0 => 100, 2 => 300, 4 => 500]
use Illuminate\Support\Arr;
$array = [100, '200', 300, '400', 500];
$filtered = Arr::reject($array, function (string|int $value, int $key) {
return is_string($value);
});
// [0 => 100, 2 => 300, 4 => 500]
Arr::select()
The Arr::select method selects an array of values from an array:
1use Illuminate\Support\Arr;
2
3$array = [
4 ['id' => 1, 'name' => 'Desk', 'price' => 200],
5 ['id' => 2, 'name' => 'Table', 'price' => 150],
6 ['id' => 3, 'name' => 'Chair', 'price' => 300],
7];
8
9Arr::select($array, ['name', 'price']);
10
11// [['name' => 'Desk', 'price' => 200], ['name' => 'Table', 'price' => 150], ['name' => 'Chair', 'price' => 300]]
use Illuminate\Support\Arr;
$array = [
['id' => 1, 'name' => 'Desk', 'price' => 200],
['id' => 2, 'name' => 'Table', 'price' => 150],
['id' => 3, 'name' => 'Chair', 'price' => 300],
];
Arr::select($array, ['name', 'price']);
// [['name' => 'Desk', 'price' => 200], ['name' => 'Table', 'price' => 150], ['name' => 'Chair', 'price' => 300]]
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]]]
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::set($array, 'products.desk.price', 200);
// ['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)
use Illuminate\Support\Arr;
$array = Arr::shuffle([1, 2, 3, 4, 5]);
// [3, 2, 5, 1, 4] - (generated randomly)
Arr::sole()
The Arr::sole method retrieves a single value from an array using the given
closure. If more than one value within the array matches the given truth test,
an Illuminate\Support\MultipleItemsFoundException exception will be thrown.
If no values match the truth test, an
Illuminate\Support\ItemNotFoundException exception will be thrown:
1use Illuminate\Support\Arr;
2
3$array = ['Desk', 'Table', 'Chair'];
4
5$value = Arr::sole($array, fn (string $value) => $value === 'Desk');
6
7// 'Desk'
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$value = Arr::sole($array, fn (string $value) => $value === 'Desk');
// 'Desk'
Arr::some()
The Arr::some method ensures that at least one of the values in the array
passes a given truth test:
1use Illuminate\Support\Arr;
2
3$array = [1, 2, 3];
4
5Arr::some($array, fn ($i) => $i > 2);
6
7// true
use Illuminate\Support\Arr;
$array = [1, 2, 3];
Arr::some($array, fn ($i) => $i > 2);
// true
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']
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:
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 (array $value) {
10 return $value['name'];
11}));
12
13/*
14 [
15 ['name' => 'Chair'],
16 ['name' => 'Desk'],
17 ['name' => 'Table'],
18 ]
19*/
use Illuminate\Support\Arr;
$array = [
['name' => 'Desk'],
['name' => 'Table'],
['name' => 'Chair'],
];
$sorted = array_values(Arr::sort($array, function (array $value) {
return $value['name'];
}));
/*
[
['name' => 'Chair'],
['name' => 'Desk'],
['name' => 'Table'],
]
*/
Arr::sortDesc()
The Arr::sortDesc method sorts an array in descending order by its values:
1use Illuminate\Support\Arr;
2
3$array = ['Desk', 'Table', 'Chair'];
4
5$sorted = Arr::sortDesc($array);
6
7// ['Table', 'Desk', 'Chair']
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:
1use Illuminate\Support\Arr;
2
3$array = [
4 ['name' => 'Desk'],
5 ['name' => 'Table'],
6 ['name' => 'Chair'],
7];
8
9$sorted = array_values(Arr::sortDesc($array, function (array $value) {
10 return $value['name'];
11}));
12
13/*
14 [
15 ['name' => 'Table'],
16 ['name' => 'Desk'],
17 ['name' => 'Chair'],
18 ]
19*/
use Illuminate\Support\Arr;
$array = [
['name' => 'Desk'],
['name' => 'Table'],
['name' => 'Chair'],
];
$sorted = array_values(Arr::sortDesc($array, function (array $value) {
return $value['name'];
}));
/*
[
['name' => 'Table'],
['name' => 'Desk'],
['name' => 'Chair'],
]
*/
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*/
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'],
]
*/
If you would like the results sorted in descending order, you may use the
Arr::sortRecursiveDesc method.
1$sorted = Arr::sortRecursiveDesc($array);
$sorted = Arr::sortRecursiveDesc($array);
Arr::string()
The Arr::string method retrieves a value from a deeply nested array using
"dot" notation (just as Arr::get() does), but throws an
InvalidArgumentException if the requested value is not a string:
1use Illuminate\Support\Arr;
2
3$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
4
5$value = Arr::string($array, 'name');
6
7// Joe
8
9$value = Arr::string($array, 'languages');
10
11// throws InvalidArgumentException
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$value = Arr::string($array, 'name');
// Joe
$value = Arr::string($array, 'languages');
// throws InvalidArgumentException
Arr::take()
The Arr::take method returns a new array with the specified number of items:
1use Illuminate\Support\Arr;
2
3$array = [0, 1, 2, 3, 4, 5];
4
5$chunk = Arr::take($array, 3);
6
7// [0, 1, 2]
use Illuminate\Support\Arr;
$array = [0, 1, 2, 3, 4, 5];
$chunk = Arr::take($array, 3);
// [0, 1, 2]
You may also pass a negative integer to take the specified number of items from the end of the array:
1$array = [0, 1, 2, 3, 4, 5];
2
3$chunk = Arr::take($array, -2);
4
5// [4, 5]
$array = [0, 1, 2, 3, 4, 5];
$chunk = Arr::take($array, -2);
// [4, 5]
Arr::toCssClasses()
The Arr::toCssClasses method 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*/
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'
*/
Arr::toCssStyles()
The Arr::toCssStyles conditionally compiles a CSS style 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$hasColor = true;
4
5$array = ['background-color: blue', 'color: blue' => $hasColor];
6
7$classes = Arr::toCssStyles($array);
8
9/*
10 'background-color: blue; color: blue;'
11*/
use Illuminate\Support\Arr;
$hasColor = true;
$array = ['background-color: blue', 'color: blue' => $hasColor];
$classes = Arr::toCssStyles($array);
/*
'background-color: blue; color: blue;'
*/
This method powers Laravel's functionality allowing merging classes with a
Blade component's attribute bag
as well as the @class [Blade directive](/docs/12.x/blade#conditional-
classes).
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']]
use Illuminate\Support\Arr;
$array = [
'user.name' => 'Kevin Malone',
'user.occupation' => 'Accountant',
];
$array = Arr::undot($array);
// ['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 (string|int $value, int $key) {
6 return is_string($value);
7});
8
9// [1 => '200', 3 => '400']
use Illuminate\Support\Arr;
$array = [100, '200', 300, '400', 500];
$filtered = Arr::where($array, function (string|int $value, int $key) {
return is_string($value);
});
// [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]
use Illuminate\Support\Arr;
$array = [0, null];
$filtered = Arr::whereNotNull($array);
// [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']
use Illuminate\Support\Arr;
$string = 'Laravel';
$array = Arr::wrap($string);
// ['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// []
use Illuminate\Support\Arr;
$array = Arr::wrap(null);
// []
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]]]
$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:
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 = [
'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],
],
]
*/
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
$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:
1$discount = data_get($data, 'products.desk.discount', 0);
2
3// 0
$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:
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 = [
'product-one' => ['name' => 'Desk 1', 'price' => 100],
'product-two' => ['name' => 'Desk 2', 'price' => 150],
];
data_get($data, '*.name');
// ['Desk 1', 'Desk 2'];
The {first} and {last} placeholders may be used to retrieve the first or
last items in an array:
1$flight = [
2 'segments' => [
3 ['from' => 'LHR', 'departure' => '9:00', 'to' => 'IST', 'arrival' => '15:00'],
4 ['from' => 'IST', 'departure' => '16:00', 'to' => 'PKX', 'arrival' => '20:00'],
5 ],
6];
7
8data_get($flight, 'segments.{first}.arrival');
9
10// 15:00
$flight = [
'segments' => [
['from' => 'LHR', 'departure' => '9:00', 'to' => 'IST', 'arrival' => '15:00'],
['from' => 'IST', 'departure' => '16:00', 'to' => 'PKX', 'arrival' => '20:00'],
],
];
data_get($flight, 'segments.{first}.arrival');
// 15:00
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]]]
$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:
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*/
$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:
1$data = ['products' => ['desk' => ['price' => 100]]];
2
3data_set($data, 'products.desk.price', 200, overwrite: false);
4
5// ['products' => ['desk' => ['price' => 100]]]
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200, overwrite: false);
// ['products' => ['desk' => ['price' => 100]]]
data_forget()
The data_forget function removes a value within a nested array or object
using "dot" notation:
1$data = ['products' => ['desk' => ['price' => 100]]];
2
3data_forget($data, 'products.desk.price');
4
5// ['products' => ['desk' => []]]
$data = ['products' => ['desk' => ['price' => 100]]];
data_forget($data, 'products.desk.price');
// ['products' => ['desk' => []]]
This function also accepts wildcards using asterisks and will remove 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_forget($data, 'products.*.price');
9
10/*
11 [
12 'products' => [
13 ['name' => 'Desk 1'],
14 ['name' => 'Desk 2'],
15 ],
16 ]
17*/
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 150],
],
];
data_forget($data, 'products.*.price');
/*
[
'products' => [
['name' => 'Desk 1'],
['name' => 'Desk 2'],
],
]
*/
head()
The head function returns the first element in the given array. If the array
is empty, false will be returned:
1$array = [100, 200, 300];
2
3$first = head($array);
4
5// 100
$array = [100, 200, 300];
$first = head($array);
// 100
last()
The last function returns the last element in the given array. If the array
is empty, false will be returned:
1$array = [100, 200, 300];
2
3$last = last($array);
4
5// 300
$array = [100, 200, 300];
$last = last($array);
// 300
Numbers
Number::abbreviate()
The Number::abbreviate method returns the human-readable format of the
provided numerical value, with an abbreviation for the units:
1use Illuminate\Support\Number;
2
3$number = Number::abbreviate(1000);
4
5// 1K
6
7$number = Number::abbreviate(489939);
8
9// 490K
10
11$number = Number::abbreviate(1230000, precision: 2);
12
13// 1.23M
use Illuminate\Support\Number;
$number = Number::abbreviate(1000);
// 1K
$number = Number::abbreviate(489939);
// 490K
$number = Number::abbreviate(1230000, precision: 2);
// 1.23M
Number::clamp()
The Number::clamp method ensures a given number stays within a specified
range. If the number is lower than the minimum, the minimum value is returned.
If the number is higher than the maximum, the maximum value is returned:
1use Illuminate\Support\Number;
2
3$number = Number::clamp(105, min: 10, max: 100);
4
5// 100
6
7$number = Number::clamp(5, min: 10, max: 100);
8
9// 10
10
11$number = Number::clamp(10, min: 10, max: 100);
12
13// 10
14
15$number = Number::clamp(20, min: 10, max: 100);
16
17// 20
use Illuminate\Support\Number;
$number = Number::clamp(105, min: 10, max: 100);
// 100
$number = Number::clamp(5, min: 10, max: 100);
// 10
$number = Number::clamp(10, min: 10, max: 100);
// 10
$number = Number::clamp(20, min: 10, max: 100);
// 20
Number::currency()
The Number::currency method returns the currency representation of the given
value as a string:
1use Illuminate\Support\Number;
2
3$currency = Number::currency(1000);
4
5// $1,000.00
6
7$currency = Number::currency(1000, in: 'EUR');
8
9// €1,000.00
10
11$currency = Number::currency(1000, in: 'EUR', locale: 'de');
12
13// 1.000,00 €
14
15$currency = Number::currency(1000, in: 'EUR', locale: 'de', precision: 0);
16
17// 1.000 €
use Illuminate\Support\Number;
$currency = Number::currency(1000);
// $1,000.00
$currency = Number::currency(1000, in: 'EUR');
// €1,000.00
$currency = Number::currency(1000, in: 'EUR', locale: 'de');
// 1.000,00 €
$currency = Number::currency(1000, in: 'EUR', locale: 'de', precision: 0);
// 1.000 €
Number::defaultCurrency()
The Number::defaultCurrency method returns the default currency being used
by the Number class:
1use Illuminate\Support\Number;
2
3$currency = Number::defaultCurrency();
4
5// USD
use Illuminate\Support\Number;
$currency = Number::defaultCurrency();
// USD
Number::defaultLocale()
The Number::defaultLocale method returns the default locale being used by
the Number class:
1use Illuminate\Support\Number;
2
3$locale = Number::defaultLocale();
4
5// en
use Illuminate\Support\Number;
$locale = Number::defaultLocale();
// en
Number::fileSize()
The Number::fileSize method returns the file size representation of the
given byte value as a string:
1use Illuminate\Support\Number;
2
3$size = Number::fileSize(1024);
4
5// 1 KB
6
7$size = Number::fileSize(1024 * 1024);
8
9// 1 MB
10
11$size = Number::fileSize(1024, precision: 2);
12
13// 1.00 KB
use Illuminate\Support\Number;
$size = Number::fileSize(1024);
// 1 KB
$size = Number::fileSize(1024 * 1024);
// 1 MB
$size = Number::fileSize(1024, precision: 2);
// 1.00 KB
Number::forHumans()
The Number::forHumans method returns the human-readable format of the
provided numerical value:
1use Illuminate\Support\Number;
2
3$number = Number::forHumans(1000);
4
5// 1 thousand
6
7$number = Number::forHumans(489939);
8
9// 490 thousand
10
11$number = Number::forHumans(1230000, precision: 2);
12
13// 1.23 million
use Illuminate\Support\Number;
$number = Number::forHumans(1000);
// 1 thousand
$number = Number::forHumans(489939);
// 490 thousand
$number = Number::forHumans(1230000, precision: 2);
// 1.23 million
Number::format()
The Number::format method formats the given number into a locale specific
string:
1use Illuminate\Support\Number;
2
3$number = Number::format(100000);
4
5// 100,000
6
7$number = Number::format(100000, precision: 2);
8
9// 100,000.00
10
11$number = Number::format(100000.123, maxPrecision: 2);
12
13// 100,000.12
14
15$number = Number::format(100000, locale: 'de');
16
17// 100.000
use Illuminate\Support\Number;
$number = Number::format(100000);
// 100,000
$number = Number::format(100000, precision: 2);
// 100,000.00
$number = Number::format(100000.123, maxPrecision: 2);
// 100,000.12
$number = Number::format(100000, locale: 'de');
// 100.000
Number::ordinal()
The Number::ordinal method returns a number's ordinal representation:
1use Illuminate\Support\Number;
2
3$number = Number::ordinal(1);
4
5// 1st
6
7$number = Number::ordinal(2);
8
9// 2nd
10
11$number = Number::ordinal(21);
12
13// 21st
use Illuminate\Support\Number;
$number = Number::ordinal(1);
// 1st
$number = Number::ordinal(2);
// 2nd
$number = Number::ordinal(21);
// 21st
Number::pairs()
The Number::pairs method generates an array of number pairs (sub-ranges)
based on a specified range and step value. This method can be useful for
dividing a larger range of numbers into smaller, manageable sub-ranges for
things like pagination or batching tasks. The pairs method returns an array
of arrays, where each inner array represents a pair (sub-range) of numbers:
1use Illuminate\Support\Number;
2
3$result = Number::pairs(25, 10);
4
5// [[0, 9], [10, 19], [20, 25]]
6
7$result = Number::pairs(25, 10, offset: 0);
8
9// [[0, 10], [10, 20], [20, 25]]
use Illuminate\Support\Number;
$result = Number::pairs(25, 10);
// [[0, 9], [10, 19], [20, 25]]
$result = Number::pairs(25, 10, offset: 0);
// [[0, 10], [10, 20], [20, 25]]
Number::parseInt()
The Number::parseInt method parse a string into an integer according to the
specified locale:
1use Illuminate\Support\Number;
2
3$result = Number::parseInt('10.123');
4
5// (int) 10
6
7$result = Number::parseInt('10,123', locale: 'fr');
8
9// (int) 10
use Illuminate\Support\Number;
$result = Number::parseInt('10.123');
// (int) 10
$result = Number::parseInt('10,123', locale: 'fr');
// (int) 10
Number::parseFloat()
The Number::parseFloat method parse a string into a float according to the
specified locale:
1use Illuminate\Support\Number;
2
3$result = Number::parseFloat('10');
4
5// (float) 10.0
6
7$result = Number::parseFloat('10', locale: 'fr');
8
9// (float) 10.0
use Illuminate\Support\Number;
$result = Number::parseFloat('10');
// (float) 10.0
$result = Number::parseFloat('10', locale: 'fr');
// (float) 10.0
Number::percentage()
The Number::percentage method returns the percentage representation of the
given value as a string:
1use Illuminate\Support\Number;
2
3$percentage = Number::percentage(10);
4
5// 10%
6
7$percentage = Number::percentage(10, precision: 2);
8
9// 10.00%
10
11$percentage = Number::percentage(10.123, maxPrecision: 2);
12
13// 10.12%
14
15$percentage = Number::percentage(10, precision: 2, locale: 'de');
16
17// 10,00%
use Illuminate\Support\Number;
$percentage = Number::percentage(10);
// 10%
$percentage = Number::percentage(10, precision: 2);
// 10.00%
$percentage = Number::percentage(10.123, maxPrecision: 2);
// 10.12%
$percentage = Number::percentage(10, precision: 2, locale: 'de');
// 10,00%
Number::spell()
The Number::spell method transforms the given number into a string of words:
1use Illuminate\Support\Number;
2
3$number = Number::spell(102);
4
5// one hundred and two
6
7$number = Number::spell(88, locale: 'fr');
8
9// quatre-vingt-huit
use Illuminate\Support\Number;
$number = Number::spell(102);
// one hundred and two
$number = Number::spell(88, locale: 'fr');
// quatre-vingt-huit
The after argument allows you to specify a value after which all numbers
should be spelled out:
1$number = Number::spell(10, after: 10);
2
3// 10
4
5$number = Number::spell(11, after: 10);
6
7// eleven
$number = Number::spell(10, after: 10);
// 10
$number = Number::spell(11, after: 10);
// eleven
The until argument allows you to specify a value before which all numbers
should be spelled out:
1$number = Number::spell(5, until: 10);
2
3// five
4
5$number = Number::spell(10, until: 10);
6
7// 10
$number = Number::spell(5, until: 10);
// five
$number = Number::spell(10, until: 10);
// 10
Number::spellOrdinal()
The Number::spellOrdinal method returns the number's ordinal representation
as a string of words:
1use Illuminate\Support\Number;
2
3$number = Number::spellOrdinal(1);
4
5// first
6
7$number = Number::spellOrdinal(2);
8
9// second
10
11$number = Number::spellOrdinal(21);
12
13// twenty-first
use Illuminate\Support\Number;
$number = Number::spellOrdinal(1);
// first
$number = Number::spellOrdinal(2);
// second
$number = Number::spellOrdinal(21);
// twenty-first
Number::trim()
The Number::trim method removes any trailing zero digits after the decimal
point of the given number:
1use Illuminate\Support\Number;
2
3$number = Number::trim(12.0);
4
5// 12
6
7$number = Number::trim(12.30);
8
9// 12.3
use Illuminate\Support\Number;
$number = Number::trim(12.0);
// 12
$number = Number::trim(12.30);
// 12.3
Number::useLocale()
The Number::useLocale method sets the default number locale globally, which
affects how numbers and currency are formatted by subsequent invocations to
the Number class's methods:
1use Illuminate\Support\Number;
2
3/**
4 * Bootstrap any application services.
5 */
6public function boot(): void
7{
8 Number::useLocale('de');
9}
use Illuminate\Support\Number;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Number::useLocale('de');
}
Number::withLocale()
The Number::withLocale method executes the given closure using the specified
locale and then restores the original locale after the callback has executed:
1use Illuminate\Support\Number;
2
3$number = Number::withLocale('de', function () {
4 return Number::format(1500);
5});
use Illuminate\Support\Number;
$number = Number::withLocale('de', function () {
return Number::format(1500);
});
Number::useCurrency()
The Number::useCurrency method sets the default number currency globally,
which affects how the currency is formatted by subsequent invocations to the
Number class's methods:
1use Illuminate\Support\Number;
2
3/**
4 * Bootstrap any application services.
5 */
6public function boot(): void
7{
8 Number::useCurrency('GBP');
9}
use Illuminate\Support\Number;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Number::useCurrency('GBP');
}
Number::withCurrency()
The Number::withCurrency method executes the given closure using the
specified currency and then restores the original currency after the callback
has executed:
1use Illuminate\Support\Number;
2
3$number = Number::withCurrency('GBP', function () {
4 // ...
5});
use Illuminate\Support\Number;
$number = Number::withCurrency('GBP', function () {
// ...
});
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');
$path = app_path();
$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');
$path = base_path();
$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');
$path = config_path();
$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');
$path = database_path();
$path = database_path('factories/UserFactory.php');
lang_path()
The lang_path function returns the fully qualified path to your
application's lang directory. You may also use the lang_path function to
generate a fully qualified path to a given file within the directory:
1$path = lang_path();
2
3$path = lang_path('en/messages.php');
$path = lang_path();
$path = lang_path('en/messages.php');
By default, the Laravel application skeleton does not include the lang
directory. If you would like to customize Laravel's language files, you may
publish them via the lang:publish Artisan command.
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');
$path = public_path();
$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');
$path = resource_path();
$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');
$path = storage_path();
$path = storage_path('app/file.txt');
URLs
action()
The action function generates a URL for the given controller action:
1use App\Http\Controllers\HomeController;
2
3$url = action([HomeController::class, 'index']);
use App\Http\Controllers\HomeController;
$url = action([HomeController::class, 'index']);
If the method accepts route parameters, you may pass them as the second argument to the method:
1$url = action([UserController::class, 'profile'], ['id' => 1]);
$url = action([UserController::class, 'profile'], ['id' => 1]);
asset()
The asset function generates a URL for an asset using the current scheme of
the request (HTTP or HTTPS):
1$url = asset('img/photo.jpg');
$url = asset('img/photo.jpg');
You can configure the asset URL host by setting the ASSET_URL variable in
your .env file. This can be useful if you host your assets on an external
service like Amazon S3 or another CDN:
1// ASSET_URL=http://example.com/assets
2
3$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg
// ASSET_URL=http://example.com/assets
$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg
route()
The route function generates a URL for a given named
route:
1$url = route('route.name');
$url = route('route.name');
If the route accepts parameters, you may pass them as the second argument to the function:
1$url = route('route.name', ['id' => 1]);
$url = route('route.name', ['id' => 1]);
By default, the route function generates an absolute URL. If you wish to
generate a relative URL, you may pass false as the third argument to the
function:
1$url = route('route.name', ['id' => 1], false);
$url = route('route.name', ['id' => 1], false);
secure_asset()
The secure_asset function generates a URL for an asset using HTTPS:
1$url = secure_asset('img/photo.jpg');
$url = secure_asset('img/photo.jpg');
secure_url()
The secure_url function generates a fully qualified HTTPS URL to the given
path. Additional URL segments may be passed in the function's second argument:
1$url = secure_url('user/profile');
2
3$url = secure_url('user/profile', [1]);
$url = secure_url('user/profile');
$url = secure_url('user/profile', [1]);
to_action()
The to_action function generates a redirect HTTP
response for a given controller action:
1use App\Http\Controllers\UserController;
2
3return to_action([UserController::class, 'show'], ['user' => 1]);
use App\Http\Controllers\UserController;
return to_action([UserController::class, 'show'], ['user' => 1]);
If necessary, you may pass the HTTP status code that should be assigned to the
redirect and any additional response headers as the third and fourth arguments
to the to_action method:
1return to_action(
2 [UserController::class, 'show'],
3 ['user' => 1],
4 302,
5 ['X-Framework' => 'Laravel']
6);
return to_action(
[UserController::class, 'show'],
['user' => 1],
302,
['X-Framework' => 'Laravel']
);
to_route()
The to_route function generates a redirect HTTP
response for a given named
route:
1return to_route('users.show', ['user' => 1]);
return to_route('users.show', ['user' => 1]);
If necessary, you may pass the HTTP status code that should be assigned to the
redirect and any additional response headers as the third and fourth arguments
to the to_route method:
1return to_route('users.show', ['user' => 1], 302, ['X-Framework' => 'Laravel']);
return to_route('users.show', ['user' => 1], 302, ['X-Framework' => 'Laravel']);
uri()
The uri function generates a fluent URI instance for the given URI:
1$uri = uri('https://example.com')
2 ->withPath('/users')
3 ->withQuery(['page' => 1]);
$uri = uri('https://example.com')
->withPath('/users')
->withQuery(['page' => 1]);
If the uri function is given an array containing a callable controller and
method pair, the function will create a Uri instance for the controller
method's route path:
1use App\Http\Controllers\UserController;
2
3$uri = uri([UserController::class, 'show'], ['user' => $user]);
use App\Http\Controllers\UserController;
$uri = uri([UserController::class, 'show'], ['user' => $user]);
If the controller is invokable, you may simply provide the controller class name:
1use App\Http\Controllers\UserIndexController;
2
3$uri = uri(UserIndexController::class);
use App\Http\Controllers\UserIndexController;
$uri = uri(UserIndexController::class);
If the value given to the uri function matches the name of a named
route, a Uri instance will be generated
for that route's path:
1$uri = uri('users.show', ['user' => $user]);
$uri = uri('users.show', ['user' => $user]);
url()
The url function generates a fully qualified URL to the given path:
1$url = url('user/profile');
2
3$url = url('user/profile', [1]);
$url = url('user/profile');
$url = url('user/profile', [1]);
If no path is provided, an Illuminate\Routing\UrlGenerator instance is
returned:
1$current = url()->current();
2
3$full = url()->full();
4
5$previous = url()->previous();
$current = url()->current();
$full = url()->full();
$previous = url()->previous();
For more information on working with the url function, consult the URL
generation documentation.
Miscellaneous
abort()
The abort function throws [an HTTP exception](/docs/12.x/errors#http-
exceptions) which will be rendered by the exception
handler:
1abort(403);
abort(403);
You may also provide the exception's message and custom HTTP response headers that should be sent to the browser:
1abort(403, 'Unauthorized.', $headers);
abort(403, 'Unauthorized.', $headers);
abort_if()
The abort_if function throws an HTTP exception if a given boolean expression
evaluates to true:
1abort_if(! Auth::user()->isAdmin(), 403);
abort_if(! Auth::user()->isAdmin(), 403);
Like the abort method, you may also provide the exception's response text as
the third argument and an array of custom response headers as the fourth
argument to the function.
abort_unless()
The abort_unless function throws an HTTP exception if a given boolean
expression evaluates to false:
1abort_unless(Auth::user()->isAdmin(), 403);
abort_unless(Auth::user()->isAdmin(), 403);
Like the abort method, you may also provide the exception's response text as
the third argument and an array of custom response headers as the fourth
argument to the function.
app()
The app function returns the service container
instance:
1$container = app();
$container = app();
You may pass a class or interface name to resolve it from the container:
1$api = app('HelpSpot\API');
$api = app('HelpSpot\API');
auth()
The auth function returns an authenticator
instance. You may use it as an alternative to the Auth facade:
1$user = auth()->user();
$user = auth()->user();
If needed, you may specify which guard instance you would like to access:
1$user = auth('admin')->user();
$user = auth('admin')->user();
back()
The back function generates a redirect HTTP
response to the user's previous location:
1return back($status = 302, $headers = [], $fallback = '/');
2
3return back();
return back($status = 302, $headers = [], $fallback = '/');
return back();
bcrypt()
The bcrypt function hashes the given value using
Bcrypt. You may use this function as an alternative to the Hash facade:
1$password = bcrypt('my-secret-password');
$password = bcrypt('my-secret-password');
blank()
The blank function determines whether the given value is "blank":
1blank('');
2blank(' ');
3blank(null);
4blank(collect());
5
6// true
7
8blank(0);
9blank(true);
10blank(false);
11
12// false
blank('');
blank(' ');
blank(null);
blank(collect());
// true
blank(0);
blank(true);
blank(false);
// false
For the inverse of blank, see the filled function.
broadcast()
The broadcast function broadcasts the given
event to its listeners:
1broadcast(new UserRegistered($user));
2
3broadcast(new UserRegistered($user))->toOthers();
broadcast(new UserRegistered($user));
broadcast(new UserRegistered($user))->toOthers();
broadcast_if()
The broadcast_if function broadcasts the given
event to its listeners if a given boolean expression
evaluates to true:
1broadcast_if($user->isActive(), new UserRegistered($user));
2
3broadcast_if($user->isActive(), new UserRegistered($user))->toOthers();
broadcast_if($user->isActive(), new UserRegistered($user));
broadcast_if($user->isActive(), new UserRegistered($user))->toOthers();
broadcast_unless()
The broadcast_unless function broadcasts the
given event to its listeners if a given boolean
expression evaluates to false:
1broadcast_unless($user->isBanned(), new UserRegistered($user));
2
3broadcast_unless($user->isBanned(), new UserRegistered($user))->toOthers();
broadcast_unless($user->isBanned(), new UserRegistered($user));
broadcast_unless($user->isBanned(), new UserRegistered($user))->toOthers();
cache()
The cache function may be used to get values from the
cache. If the given key does not exist in the cache, an
optional default value will be returned:
1$value = cache('key');
2
3$value = cache('key', 'default');
$value = cache('key');
$value = cache('key', 'default');
You may add items to the cache by passing an array of key / value pairs to the function. You should also pass the number of seconds or duration the cached value should be considered valid:
1cache(['key' => 'value'], 300);
2
3cache(['key' => 'value'], now()->addSeconds(10));
cache(['key' => 'value'], 300);
cache(['key' => 'value'], now()->addSeconds(10));
class_uses_recursive()
The class_uses_recursive function returns all traits used by a class,
including traits used by all of its parent classes:
1$traits = class_uses_recursive(App\Models\User::class);
$traits = class_uses_recursive(App\Models\User::class);
collect()
The collect function creates a collection instance
from the given value:
1$collection = collect(['Taylor', 'Abigail']);
$collection = collect(['Taylor', 'Abigail']);
config()
The config function gets the value of a
configuration variable. The configuration values
may be accessed using "dot" syntax, which includes the name of the file and
the option you wish to access. You may also provide a default value that will
be returned if the configuration option does not exist:
1$value = config('app.timezone');
2
3$value = config('app.timezone', $default);
$value = config('app.timezone');
$value = config('app.timezone', $default);
You may set configuration variables at runtime by passing an array of key / value pairs. However, note that this function only affects the configuration value for the current request and does not update your actual configuration values:
1config(['app.debug' => true]);
config(['app.debug' => true]);
context()
The context function gets the value from the current
context. You may also provide a default value that will
be returned if the context key does not exist:
1$value = context('trace_id');
2
3$value = context('trace_id', $default);
$value = context('trace_id');
$value = context('trace_id', $default);
You may set context values by passing an array of key / value pairs:
1use Illuminate\Support\Str;
2
3context(['trace_id' => Str::uuid()->toString()]);
use Illuminate\Support\Str;
context(['trace_id' => Str::uuid()->toString()]);
cookie()
The cookie function creates a new cookie
instance:
1$cookie = cookie('name', 'value', $minutes);
$cookie = cookie('name', 'value', $minutes);
csrf_field()
The csrf_field function generates an HTML hidden input field containing
the value of the CSRF token. For example, using Blade
syntax:
1{{ csrf_field() }}
{{ csrf_field() }}
csrf_token()
The csrf_token function retrieves the value of the current CSRF token:
1$token = csrf_token();
$token = csrf_token();
decrypt()
The decrypt function decrypts the given value. You
may use this function as an alternative to the Crypt facade:
1$password = decrypt($value);
$password = decrypt($value);
For the inverse of decrypt, see the encrypt function.
dd()
The dd function dumps the given variables and ends the execution of the
script:
1dd($value);
2
3dd($value1, $value2, $value3, ...);
dd($value);
dd($value1, $value2, $value3, ...);
If you do not want to halt the execution of your script, use the dump function instead.
dispatch()
The dispatch function pushes the given [job](/docs/12.x/queues#creating-
jobs) onto the Laravel job queue:
1dispatch(new App\Jobs\SendEmails);
dispatch(new App\Jobs\SendEmails);
dispatch_sync()
The dispatch_sync function pushes the given job to the
sync queue so that it is
processed immediately:
1dispatch_sync(new App\Jobs\SendEmails);
dispatch_sync(new App\Jobs\SendEmails);
dump()
The dump function dumps the given variables:
1dump($value);
2
3dump($value1, $value2, $value3, ...);
dump($value);
dump($value1, $value2, $value3, ...);
If you want to stop executing the script after dumping the variables, use the dd function instead.
encrypt()
The encrypt function encrypts the given value. You
may use this function as an alternative to the Crypt facade:
1$secret = encrypt('my-secret-value');
$secret = encrypt('my-secret-value');
For the inverse of encrypt, see the decrypt function.
env()
The env function retrieves the value of an environment
variable or returns a
default value:
1$env = env('APP_ENV');
2
3$env = env('APP_ENV', 'production');
$env = env('APP_ENV');
$env = env('APP_ENV', 'production');
If you execute the config:cache command during your deployment process, you
should be sure that you are only calling the env function from within your
configuration files. Once the configuration has been cached, the .env file
will not be loaded and all calls to the env function will return external
environment variables such as server-level or system-level environment
variables or null.
event()
The event function dispatches the given event to its
listeners:
1event(new UserRegistered($user));
event(new UserRegistered($user));
fake()
The fake function resolves a Faker
singleton from the container, which can be useful when creating fake data in
model factories, database seeding, tests, and prototyping views:
1@for ($i = 0; $i < 10; $i++)
2 <dl>
3 <dt>Name</dt>
4 <dd>{{ fake()->name() }}</dd>
5
6 <dt>Email</dt>
7 <dd>{{ fake()->unique()->safeEmail() }}</dd>
8 </dl>
9@endfor
@for ($i = 0; $i < 10; $i++)
<dl>
<dt>Name</dt>
<dd>{{ fake()->name() }}</dd>
<dt>Email</dt>
<dd>{{ fake()->unique()->safeEmail() }}</dd>
</dl>
@endfor
By default, the fake function will utilize the app.faker_locale
configuration option in your config/app.php configuration. Typically, this
configuration option is set via the APP_FAKER_LOCALE environment variable.
You may also specify the locale by passing it to the fake function. Each
locale will resolve an individual singleton:
1fake('nl_NL')->name()
fake('nl_NL')->name()
filled()
The filled function determines whether the given value is not "blank":
1filled(0);
2filled(true);
3filled(false);
4
5// true
6
7filled('');
8filled(' ');
9filled(null);
10filled(collect());
11
12// false
filled(0);
filled(true);
filled(false);
// true
filled('');
filled(' ');
filled(null);
filled(collect());
// false
For the inverse of filled, see the blank function.
info()
The info function will write information to your application's
log:
1info('Some helpful information!');
info('Some helpful information!');
An array of contextual data may also be passed to the function:
1info('User login attempt failed.', ['id' => $user->id]);
info('User login attempt failed.', ['id' => $user->id]);
literal()
The literal function creates a new
stdClass instance with the
given named arguments as properties:
1$obj = literal(
2 name: 'Joe',
3 languages: ['PHP', 'Ruby'],
4);
5
6$obj->name; // 'Joe'
7$obj->languages; // ['PHP', 'Ruby']
$obj = literal(
name: 'Joe',
languages: ['PHP', 'Ruby'],
);
$obj->name; // 'Joe'
$obj->languages; // ['PHP', 'Ruby']
logger()
The logger function can be used to write a debug level message to the
log:
1logger('Debug message');
logger('Debug message');
An array of contextual data may also be passed to the function:
1logger('User has logged in.', ['id' => $user->id]);
logger('User has logged in.', ['id' => $user->id]);
A logger instance will be returned if no value is passed to the function:
1logger()->error('You are not allowed here.');
logger()->error('You are not allowed here.');
method_field()
The method_field function generates an HTML hidden input field containing
the spoofed value of the form's HTTP verb. For example, using Blade
syntax:
1<form method="POST">
2 {{ method_field('DELETE') }}
3</form>
<form method="POST">
{{ method_field('DELETE') }}
</form>
now()
The now function creates a new Illuminate\Support\Carbon instance for the
current time:
1$now = now();
$now = now();
old()
The old function retrieves an old
input value flashed into the session:
1$value = old('value');
2
3$value = old('value', 'default');
$value = old('value');
$value = old('value', 'default');
Since the "default value" provided as the second argument to the old
function is often an attribute of an Eloquent model, Laravel allows you to
simply pass the entire Eloquent model as the second argument to the old
function. When doing so, Laravel will assume the first argument provided to
the old function is the name of the Eloquent attribute that should be
considered the "default value":
1{{ old('name', $user->name) }}
2
3// Is equivalent to...
4
5{{ old('name', $user) }}
{{ old('name', $user->name) }}
// Is equivalent to...
{{ old('name', $user) }}
once()
The once function executes the given callback and caches the result in
memory for the duration of the request. Any subsequent calls to the once
function with the same callback will return the previously cached result:
1function random(): int
2{
3 return once(function () {
4 return random_int(1, 1000);
5 });
6}
7
8random(); // 123
9random(); // 123 (cached result)
10random(); // 123 (cached result)
function random(): int
{
return once(function () {
return random_int(1, 1000);
});
}
random(); // 123
random(); // 123 (cached result)
random(); // 123 (cached result)
When the once function is executed from within an object instance, the
cached result will be unique to that object instance:
1<?php
2
3class NumberService
4{
5 public function all(): array
6 {
7 return once(fn () => [1, 2, 3]);
8 }
9}
10
11$service = new NumberService;
12
13$service->all();
14$service->all(); // (cached result)
15
16$secondService = new NumberService;
17
18$secondService->all();
19$secondService->all(); // (cached result)
<?php
class NumberService
{
public function all(): array
{
return once(fn () => [1, 2, 3]);
}
}
$service = new NumberService;
$service->all();
$service->all(); // (cached result)
$secondService = new NumberService;
$secondService->all();
$secondService->all(); // (cached result)
optional()
The optional function accepts any argument and allows you to access
properties or call methods on that object. If the given object is null,
properties and methods will return null instead of causing an error:
1return optional($user->address)->street;
2
3{!! old('name', optional($user)->name) !!}
return optional($user->address)->street;
{!! old('name', optional($user)->name) !!}
The optional function also accepts a closure as its second argument. The
closure will be invoked if the value provided as the first argument is not
null:
1return optional(User::find($id), function (User $user) {
2 return $user->name;
3});
return optional(User::find($id), function (User $user) {
return $user->name;
});
policy()
The policy method retrieves a [policy](/docs/12.x/authorization#creating-
policies) instance for a given class:
1$policy = policy(App\Models\User::class);
$policy = policy(App\Models\User::class);
redirect()
The redirect function returns a redirect HTTP
response, or returns the redirector instance
if called with no arguments:
1return redirect($to = null, $status = 302, $headers = [], $secure = null);
2
3return redirect('/home');
4
5return redirect()->route('route.name');
return redirect($to = null, $status = 302, $headers = [], $secure = null);
return redirect('/home');
return redirect()->route('route.name');
report()
The report function will report an exception using your exception
handler:
1report($e);
report($e);
The report function also accepts a string as an argument. When a string is
given to the function, the function will create an exception with the given
string as its message:
1report('Something went wrong.');
report('Something went wrong.');
report_if()
The report_if function will report an exception using your exception
handler if a given boolean expression
evaluates to true:
1report_if($shouldReport, $e);
2
3report_if($shouldReport, 'Something went wrong.');
report_if($shouldReport, $e);
report_if($shouldReport, 'Something went wrong.');
report_unless()
The report_unless function will report an exception using your exception
handler if a given boolean expression
evaluates to false:
1report_unless($reportingDisabled, $e);
2
3report_unless($reportingDisabled, 'Something went wrong.');
report_unless($reportingDisabled, $e);
report_unless($reportingDisabled, 'Something went wrong.');
request()
The request function returns the current request
instance or obtains an input field's value from the current request:
1$request = request();
2
3$value = request('key', $default);
$request = request();
$value = request('key', $default);
rescue()
The rescue function executes the given closure and catches any exceptions
that occur during its execution. All exceptions that are caught will be sent
to your exception handler; however,
the request will continue processing:
1return rescue(function () {
2 return $this->method();
3});
return rescue(function () {
return $this->method();
});
You may also pass a second argument to the rescue function. This argument
will be the "default" value that should be returned if an exception occurs
while executing the closure:
1return rescue(function () {
2 return $this->method();
3}, false);
4
5return rescue(function () {
6 return $this->method();
7}, function () {
8 return $this->failure();
9});
return rescue(function () {
return $this->method();
}, false);
return rescue(function () {
return $this->method();
}, function () {
return $this->failure();
});
A report argument may be provided to the rescue function to determine if
the exception should be reported via the report function:
1return rescue(function () {
2 return $this->method();
3}, report: function (Throwable $throwable) {
4 return $throwable instanceof InvalidArgumentException;
5});
return rescue(function () {
return $this->method();
}, report: function (Throwable $throwable) {
return $throwable instanceof InvalidArgumentException;
});
resolve()
The resolve function resolves a given class or interface name to an instance
using the service container:
1$api = resolve('HelpSpot\API');
$api = resolve('HelpSpot\API');
response()
The response function creates a response instance or
obtains an instance of the response factory:
1return response('Hello World', 200, $headers);
2
3return response()->json(['foo' => 'bar'], 200, $headers);
return response('Hello World', 200, $headers);
return response()->json(['foo' => 'bar'], 200, $headers);
retry()
The retry function attempts to execute the given callback until the given
maximum attempt threshold is met. If the callback does not throw an exception,
its return value will be returned. If the callback throws an exception, it
will automatically be retried. If the maximum attempt count is exceeded, the
exception will be thrown:
1return retry(5, function () {
2 // Attempt 5 times while resting 100ms between attempts...
3}, 100);
return retry(5, function () {
// Attempt 5 times while resting 100ms between attempts...
}, 100);
If you would like to manually calculate the number of milliseconds to sleep
between attempts, you may pass a closure as the third argument to the retry
function:
1use Exception;
2
3return retry(5, function () {
4 // ...
5}, function (int $attempt, Exception $exception) {
6 return $attempt * 100;
7});
use Exception;
return retry(5, function () {
// ...
}, function (int $attempt, Exception $exception) {
return $attempt * 100;
});
For convenience, you may provide an array as the first argument to the retry
function. This array will be used to determine how many milliseconds to sleep
between subsequent attempts:
1return retry([100, 200], function () {
2 // Sleep for 100ms on first retry, 200ms on second retry...
3});
return retry([100, 200], function () {
// Sleep for 100ms on first retry, 200ms on second retry...
});
To only retry under specific conditions, you may pass a closure as the fourth
argument to the retry function:
1use App\Exceptions\TemporaryException;
2use Exception;
3
4return retry(5, function () {
5 // ...
6}, 100, function (Exception $exception) {
7 return $exception instanceof TemporaryException;
8});
use App\Exceptions\TemporaryException;
use Exception;
return retry(5, function () {
// ...
}, 100, function (Exception $exception) {
return $exception instanceof TemporaryException;
});
session()
The session function may be used to get or set session
values:
1$value = session('key');
$value = session('key');
You may set values by passing an array of key / value pairs to the function:
1session(['chairs' => 7, 'instruments' => 3]);
session(['chairs' => 7, 'instruments' => 3]);
The session store will be returned if no value is passed to the function:
1$value = session()->get('key');
2
3session()->put('key', $value);
$value = session()->get('key');
session()->put('key', $value);
tap()
The tap function accepts two arguments: an arbitrary $value and a closure.
The $value will be passed to the closure and then be returned by the tap
function. The return value of the closure is irrelevant:
1$user = tap(User::first(), function (User $user) {
2 $user->name = 'Taylor';
3
4 $user->save();
5});
$user = tap(User::first(), function (User $user) {
$user->name = 'Taylor';
$user->save();
});
If no closure is passed to the tap function, you may call any method on the
given $value. The return value of the method you call will always be
$value, regardless of what the method actually returns in its definition.
For example, the Eloquent update method typically returns an integer.
However, we can force the method to return the model itself by chaining the
update method call through the tap function:
1$user = tap($user)->update([
2 'name' => $name,
3 'email' => $email,
4]);
$user = tap($user)->update([
'name' => $name,
'email' => $email,
]);
To add a tap method to a class, you may add the
Illuminate\Support\Traits\Tappable trait to the class. The tap method of
this trait accepts a Closure as its only argument. The object instance itself
will be passed to the Closure and then be returned by the tap method:
1return $user->tap(function (User $user) {
2 // ...
3});
return $user->tap(function (User $user) {
// ...
});
throw_if()
The throw_if function throws the given exception if a given boolean
expression evaluates to true:
1throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);
2
3throw_if(
4 ! Auth::user()->isAdmin(),
5 AuthorizationException::class,
6 'You are not allowed to access this page.'
7);
throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);
throw_if(
! Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page.'
);
throw_unless()
The throw_unless function throws the given exception if a given boolean
expression evaluates to false:
1throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);
2
3throw_unless(
4 Auth::user()->isAdmin(),
5 AuthorizationException::class,
6 'You are not allowed to access this page.'
7);
throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);
throw_unless(
Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page.'
);
today()
The today function creates a new Illuminate\Support\Carbon instance for
the current date:
1$today = today();
$today = today();
trait_uses_recursive()
The trait_uses_recursive function returns all traits used by a trait:
1$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);
$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);
transform()
The transform function executes a closure on a given value if the value is
not blank and then returns the return value of the closure:
1$callback = function (int $value) {
2 return $value * 2;
3};
4
5$result = transform(5, $callback);
6
7// 10
$callback = function (int $value) {
return $value * 2;
};
$result = transform(5, $callback);
// 10
A default value or closure may be passed as the third argument to the function. This value will be returned if the given value is blank:
1$result = transform(null, $callback, 'The value is blank');
2
3// The value is blank
$result = transform(null, $callback, 'The value is blank');
// The value is blank
validator()
The validator function creates a new validator
instance with the given arguments. You may use it as an alternative to the
Validator facade:
1$validator = validator($data, $rules, $messages);
$validator = validator($data, $rules, $messages);
value()
The value function returns the value it is given. However, if you pass a
closure to the function, the closure will be executed and its returned value
will be returned:
1$result = value(true);
2
3// true
4
5$result = value(function () {
6 return false;
7});
8
9// false
$result = value(true);
// true
$result = value(function () {
return false;
});
// false
Additional arguments may be passed to the value function. If the first
argument is a closure then the additional parameters will be passed to the
closure as arguments, otherwise they will be ignored:
1$result = value(function (string $name) {
2 return $name;
3}, 'Taylor');
4
5// 'Taylor'
$result = value(function (string $name) {
return $name;
}, 'Taylor');
// 'Taylor'
view()
The view function retrieves a view instance:
1return view('auth.login');
return view('auth.login');
with()
The with function returns the value it is given. If a closure is passed as
the second argument to the function, the closure will be executed and its
returned value will be returned:
1$callback = function (mixed $value) {
2 return is_numeric($value) ? $value * 2 : 0;
3};
4
5$result = with(5, $callback);
6
7// 10
8
9$result = with(null, $callback);
10
11// 0
12
13$result = with(5, null);
14
15// 5
$callback = function (mixed $value) {
return is_numeric($value) ? $value * 2 : 0;
};
$result = with(5, $callback);
// 10
$result = with(null, $callback);
// 0
$result = with(5, null);
// 5
when()
The when function returns the value it is given if a given condition
evaluates to true. Otherwise, null is returned. If a closure is passed as
the second argument to the function, the closure will be executed and its
returned value will be returned:
1$value = when(true, 'Hello World');
2
3$value = when(true, fn () => 'Hello World');
$value = when(true, 'Hello World');
$value = when(true, fn () => 'Hello World');
The when function is primarily useful for conditionally rendering HTML
attributes:
1<div {!! when($condition, 'wire:poll="calculate"') !!}>
2 ...
3</div>
<div {!! when($condition, 'wire:poll="calculate"') !!}>
...
</div>
Other Utilities
Benchmarking
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:
1<?php
2
3use App\Models\User;
4use Illuminate\Support\Benchmark;
5
6Benchmark::dd(fn () => User::find(1)); // 0.1 ms
7
8Benchmark::dd([
9 'Scenario 1' => fn () => User::count(), // 0.5 ms
10 'Scenario 2' => fn () => User::all()->count(), // 20.0 ms
11]);
<?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 number of milliseconds it took to execute the callback across all
iterations:
1Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms
Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms
Sometimes, you may want to benchmark the execution of a callback while still
obtaining the value returned by the callback. The value method will return a
tuple containing the value returned by the callback and the number of
milliseconds it took to execute the callback:
1[$count, $duration] = Benchmark::value(fn () => User::count());
[$count, $duration] = Benchmark::value(fn () => User::count());
Dates
Laravel includes Carbon, a powerful date
and time manipulation library. To create a new Carbon instance, you may
invoke the now function. This function is globally available within your
Laravel application:
1$now = now();
$now = now();
Or, you may create a new Carbon instance using the
Illuminate\Support\Carbon class:
1use Illuminate\Support\Carbon;
2
3$now = Carbon::now();
use Illuminate\Support\Carbon;
$now = Carbon::now();
For a thorough discussion of Carbon and its features, please consult the official Carbon documentation.
Deferred Functions
While Laravel's queued jobs allow you to queue tasks for background processing, sometimes you may have simple tasks you would like to defer without configuring or maintaining a long-running queue worker.
Deferred functions allow you to defer the execution of a closure until after
the HTTP response has been sent to the user, keeping your application feeling
fast and responsive. To defer the execution of a closure, simply pass the
closure to the Illuminate\Support\defer function:
1use App\Services\Metrics;
2use Illuminate\Http\Request;
3use Illuminate\Support\Facades\Route;
4use function Illuminate\Support\defer;
5
6Route::post('/orders', function (Request $request) {
7 // Create order...
8
9 defer(fn () => Metrics::reportOrder($order));
10
11 return $order;
12});
use App\Services\Metrics;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use function Illuminate\Support\defer;
Route::post('/orders', function (Request $request) {
// Create order...
defer(fn () => Metrics::reportOrder($order));
return $order;
});
By default, deferred functions will only be executed if the HTTP response,
Artisan command, or queued job from which Illuminate\Support\defer is
invoked completes successfully. This means that deferred functions will not be
executed if a request results in a 4xx or 5xx HTTP response. If you would
like a deferred function to always execute, you may chain the always method
onto your deferred function:
1defer(fn () => Metrics::reportOrder($order))->always();
defer(fn () => Metrics::reportOrder($order))->always();
If you have the Swoole PHP
extension installed, Laravel's
defer function may conflict with Swoole's own global defer function,
leading to web server errors. Make sure you call Laravel's defer helper by
explicitly namespacing it: use function Illuminate\Support\defer;
Cancelling Deferred Functions
If you need to cancel a deferred function before it is executed, you can use
the forget method to cancel the function by its name. To name a deferred
function, provide a second argument to the Illuminate\Support\defer
function:
1defer(fn () => Metrics::report(), 'reportMetrics');
2
3defer()->forget('reportMetrics');
defer(fn () => Metrics::report(), 'reportMetrics');
defer()->forget('reportMetrics');
Disabling Deferred Functions in Tests
When writing tests, it may be useful to disable deferred functions. You may
call withoutDefer in your test to instruct Laravel to invoke all deferred
functions immediately:
Pest PHPUnit
1test('without defer', function () {
2 $this->withoutDefer();
3
4 // ...
5});
test('without defer', function () {
$this->withoutDefer();
// ...
});
1use Tests\TestCase;
2
3class ExampleTest extends TestCase
4{
5 public function test_without_defer(): void
6 {
7 $this->withoutDefer();
8
9 // ...
10 }
11}
use Tests\TestCase;
class ExampleTest extends TestCase
{
public function test_without_defer(): void
{
$this->withoutDefer();
// ...
}
}
If you would like to disable deferred functions for all tests within a test
case, you may call the withoutDefer method from the setUp method on your
base TestCase class:
1<?php
2
3namespace Tests;
4
5use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
6
7abstract class TestCase extends BaseTestCase
8{
9 protected function setUp(): void
10 {
11 parent::setUp();
12
13 $this->withoutDefer();
14 }
15}
<?php
namespace Tests;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
abstract class TestCase extends BaseTestCase
{
protected function setUp(): void
{
parent::setUp();
$this->withoutDefer();
}
}
Lottery
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:
1use Illuminate\Support\Lottery;
2
3Lottery::odds(1, 20)
4 ->winner(fn () => $user->won())
5 ->loser(fn () => $user->lost())
6 ->choose();
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:
1use Carbon\CarbonInterval;
2use Illuminate\Support\Facades\DB;
3use Illuminate\Support\Lottery;
4
5DB::whenQueryingForLongerThan(
6 CarbonInterval::seconds(2),
7 Lottery::odds(1, 100)->winner(fn () => report('Querying > 2 seconds.')),
8);
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.')),
);
Testing Lotteries
Laravel provides some simple methods to allow you to easily test your application's lottery invocations:
1// Lottery will always win...
2Lottery::alwaysWin();
3
4// Lottery will always lose...
5Lottery::alwaysLose();
6
7// Lottery will win then lose, and finally return to normal behavior...
8Lottery::fix([true, false]);
9
10// Lottery will return to normal behavior...
11Lottery::determineResultsNormally();
// 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();
Pipeline
Laravel's Pipeline facade provides a convenient way to "pipe" a given input
through a series of invokable classes, closures, or callables, giving each
class the opportunity to inspect or modify the input and invoke the next
callable in the pipeline:
1use Closure;
2use App\Models\User;
3use Illuminate\Support\Facades\Pipeline;
4
5$user = Pipeline::send($user)
6 ->through([
7 function (User $user, Closure $next) {
8 // ...
9
10 return $next($user);
11 },
12 function (User $user, Closure $next) {
13 // ...
14
15 return $next($user);
16 },
17 ])
18 ->then(fn (User $user) => $user);
use Closure;
use App\Models\User;
use Illuminate\Support\Facades\Pipeline;
$user = Pipeline::send($user)
->through([
function (User $user, Closure $next) {
// ...
return $next($user);
},
function (User $user, Closure $next) {
// ...
return $next($user);
},
])
->then(fn (User $user) => $user);
As you can see, each invokable class or closure in the pipeline is provided
the input and a $next closure. Invoking the $next closure will invoke the
next callable in the pipeline. As you may have noticed, this is very similar
to middleware.
When the last callable in the pipeline invokes the $next closure, the
callable provided to the then method will be invoked. Typically, this
callable will simply return the given input. For convenience, if you simply
want to return the input after it has been processed, you may use the
thenReturn method.
Of course, as discussed previously, you are not limited to providing closures to your pipeline. You may also provide invokable classes. If a class name is provided, the class will be instantiated via Laravel's service container, allowing dependencies to be injected into the invokable class:
1$user = Pipeline::send($user)
2 ->through([
3 GenerateProfilePhoto::class,
4 ActivateSubscription::class,
5 SendWelcomeEmail::class,
6 ])
7 ->thenReturn();
$user = Pipeline::send($user)
->through([
GenerateProfilePhoto::class,
ActivateSubscription::class,
SendWelcomeEmail::class,
])
->thenReturn();
The withinTransaction method may be invoked on the pipeline to automatically
wrap all steps of the pipeline within a single database transaction:
1$user = Pipeline::send($user)
2 ->withinTransaction()
3 ->through([
4 ProcessOrder::class,
5 TransferFunds::class,
6 UpdateInventory::class,
7 ])
8 ->thenReturn();
$user = Pipeline::send($user)
->withinTransaction()
->through([
ProcessOrder::class,
TransferFunds::class,
UpdateInventory::class,
])
->thenReturn();
Sleep
Laravel's Sleep class is a light-weight wrapper around PHP's native sleep
and usleep functions, offering greater testability while also exposing a
developer friendly API for working with time:
1use Illuminate\Support\Sleep;
2
3$waiting = true;
4
5while ($waiting) {
6 Sleep::for(1)->second();
7
8 $waiting = /* ... */;
9}
use Illuminate\Support\Sleep;
$waiting = true;
while ($waiting) {
Sleep::for(1)->second();
$waiting = /* ... */;
}
The Sleep class offers a variety of methods that allow you to work with
different units of time:
1// Return a value after sleeping...
2$result = Sleep::for(1)->second()->then(fn () => 1 + 1);
3
4// Sleep while a given value is true...
5Sleep::for(1)->second()->while(fn () => shouldKeepSleeping());
6
7// Pause execution for 90 seconds...
8Sleep::for(1.5)->minutes();
9
10// Pause execution for 2 seconds...
11Sleep::for(2)->seconds();
12
13// Pause execution for 500 milliseconds...
14Sleep::for(500)->milliseconds();
15
16// Pause execution for 5,000 microseconds...
17Sleep::for(5000)->microseconds();
18
19// Pause execution until a given time...
20Sleep::until(now()->addMinute());
21
22// Alias of PHP's native "sleep" function...
23Sleep::sleep(2);
24
25// Alias of PHP's native "usleep" function...
26Sleep::usleep(5000);
// Return a value after sleeping...
$result = Sleep::for(1)->second()->then(fn () => 1 + 1);
// Sleep while a given value is true...
Sleep::for(1)->second()->while(fn () => shouldKeepSleeping());
// Pause execution for 90 seconds...
Sleep::for(1.5)->minutes();
// Pause execution for 2 seconds...
Sleep::for(2)->seconds();
// Pause execution for 500 milliseconds...
Sleep::for(500)->milliseconds();
// Pause execution for 5,000 microseconds...
Sleep::for(5000)->microseconds();
// Pause execution until a given time...
Sleep::until(now()->addMinute());
// Alias of PHP's native "sleep" function...
Sleep::sleep(2);
// Alias of PHP's native "usleep" function...
Sleep::usleep(5000);
To easily combine units of time, you may use the and method:
1Sleep::for(1)->second()->and(10)->milliseconds();
Sleep::for(1)->second()->and(10)->milliseconds();
Testing Sleep
When testing code that utilizes the Sleep class or PHP's native sleep
functions, your test will pause execution. As you might expect, this makes
your test suite significantly slower. For example, imagine you are testing the
following code:
1$waiting = /* ... */;
2
3$seconds = 1;
4
5while ($waiting) {
6 Sleep::for($seconds++)->seconds();
7
8 $waiting = /* ... */;
9}
$waiting = /* ... */;
$seconds = 1;
while ($waiting) {
Sleep::for($seconds++)->seconds();
$waiting = /* ... */;
}
Typically, testing this code would take at least one second. Luckily, the
Sleep class allows us to "fake" sleeping so that our test suite stays fast:
Pest PHPUnit
1it('waits until ready', function () {
2 Sleep::fake();
3
4 // ...
5});
it('waits until ready', function () {
Sleep::fake();
// ...
});
1public function test_it_waits_until_ready()
2{
3 Sleep::fake();
4
5 // ...
6}
public function test_it_waits_until_ready()
{
Sleep::fake();
// ...
}
When faking the Sleep class, the actual execution pause is by-passed,
leading to a substantially faster test.
Once the Sleep class has been faked, it is possible to make assertions
against the expected "sleeps" that should have occurred. To illustrate this,
let's imagine we are testing code that pauses execution three times, with each
pause increasing by a single second. Using the assertSequence method, we can
assert that our code "slept" for the proper amount of time while keeping our
test fast:
Pest PHPUnit
1it('checks if ready three times', function () {
2 Sleep::fake();
3
4 // ...
5
6 Sleep::assertSequence([
7 Sleep::for(1)->second(),
8 Sleep::for(2)->seconds(),
9 Sleep::for(3)->seconds(),
10 ]);
11}
it('checks if ready three times', function () {
Sleep::fake();
// ...
Sleep::assertSequence([
Sleep::for(1)->second(),
Sleep::for(2)->seconds(),
Sleep::for(3)->seconds(),
]);
}
1public function test_it_checks_if_ready_three_times()
2{
3 Sleep::fake();
4
5 // ...
6
7 Sleep::assertSequence([
8 Sleep::for(1)->second(),
9 Sleep::for(2)->seconds(),
10 Sleep::for(3)->seconds(),
11 ]);
12}
public function test_it_checks_if_ready_three_times()
{
Sleep::fake();
// ...
Sleep::assertSequence([
Sleep::for(1)->second(),
Sleep::for(2)->seconds(),
Sleep::for(3)->seconds(),
]);
}
Of course, the Sleep class offers a variety of other assertions you may use
when testing:
1use Carbon\CarbonInterval as Duration;
2use Illuminate\Support\Sleep;
3
4// Assert that sleep was called 3 times...
5Sleep::assertSleptTimes(3);
6
7// Assert against the duration of sleep...
8Sleep::assertSlept(function (Duration $duration): bool {
9 return /* ... */;
10}, times: 1);
11
12// Assert that the Sleep class was never invoked...
13Sleep::assertNeverSlept();
14
15// Assert that, even if Sleep was called, no execution paused occurred...
16Sleep::assertInsomniac();
use Carbon\CarbonInterval as Duration;
use Illuminate\Support\Sleep;
// Assert that sleep was called 3 times...
Sleep::assertSleptTimes(3);
// Assert against the duration of sleep...
Sleep::assertSlept(function (Duration $duration): bool {
return /* ... */;
}, times: 1);
// Assert that the Sleep class was never invoked...
Sleep::assertNeverSlept();
// Assert that, even if Sleep was called, no execution paused occurred...
Sleep::assertInsomniac();
Sometimes it may be useful to perform an action whenever a fake sleep occurs.
To achieve this, you may provide a callback to the whenFakingSleep method.
In the following example, we use Laravel's time manipulation
helpers to instantly progress time
by the duration of each sleep:
1use Carbon\CarbonInterval as Duration;
2
3$this->freezeTime();
4
5Sleep::fake();
6
7Sleep::whenFakingSleep(function (Duration $duration) {
8 // Progress time when faking sleep...
9 $this->travel($duration->totalMilliseconds)->milliseconds();
10});
use Carbon\CarbonInterval as Duration;
$this->freezeTime();
Sleep::fake();
Sleep::whenFakingSleep(function (Duration $duration) {
// Progress time when faking sleep...
$this->travel($duration->totalMilliseconds)->milliseconds();
});
As progressing time is a common requirement, the fake method accepts a
syncWithCarbon argument to keep Carbon in sync when sleeping within a test:
1Sleep::fake(syncWithCarbon: true);
2
3$start = now();
4
5Sleep::for(1)->second();
6
7$start->diffForHumans(); // 1 second ago
Sleep::fake(syncWithCarbon: true);
$start = now();
Sleep::for(1)->second();
$start->diffForHumans(); // 1 second ago
Laravel uses the Sleep class internally whenever it is pausing execution.
For example, the retry helper uses the Sleep class when sleeping, allowing
for improved testability when using that helper.
Timebox
Laravel's Timebox class ensures that the given callback always takes a fixed
amount of time to execute, even if its actual execution completes sooner. This
is particularly useful for cryptographic operations and user authentication
checks, where attackers might exploit variations in execution time to infer
sensitive information.
If the execution exceeds the fixed duration, Timebox has no effect. It is up
to the developer to choose a sufficiently long time as the fixed duration to
account for worst-case scenarios.
The call method accepts a closure and a time limit in microseconds, and then executes the closure and waits until the time limit is reached:
1use Illuminate\Support\Timebox;
2
3(new Timebox)->call(function ($timebox) {
4 // ...
5}, microseconds: 10000);
use Illuminate\Support\Timebox;
(new Timebox)->call(function ($timebox) {
// ...
}, microseconds: 10000);
If an exception is thrown within the closure, this class will respect the defined delay and re-throw the exception after the delay.
URI
Laravel's Uri class provides a convenient and fluent interface for creating
and manipulating URIs. This class wraps the functionality provided by the
underlying League URI package and integrates seamlessly with Laravel's routing
system.
You can create a Uri instance easily using static methods:
1use App\Http\Controllers\UserController;
2use App\Http\Controllers\InvokableController;
3use Illuminate\Support\Uri;
4
5// Generate a URI instance from the given string...
6$uri = Uri::of('https://example.com/path');
7
8// Generate URI instances to paths, named routes, or controller actions...
9$uri = Uri::to('/dashboard');
10$uri = Uri::route('users.show', ['user' => 1]);
11$uri = Uri::signedRoute('users.show', ['user' => 1]);
12$uri = Uri::temporarySignedRoute('user.index', now()->addMinutes(5));
13$uri = Uri::action([UserController::class, 'index']);
14$uri = Uri::action(InvokableController::class);
15
16// Generate a URI instance from the current request URL...
17$uri = $request->uri();
use App\Http\Controllers\UserController;
use App\Http\Controllers\InvokableController;
use Illuminate\Support\Uri;
// Generate a URI instance from the given string...
$uri = Uri::of('https://example.com/path');
// Generate URI instances to paths, named routes, or controller actions...
$uri = Uri::to('/dashboard');
$uri = Uri::route('users.show', ['user' => 1]);
$uri = Uri::signedRoute('users.show', ['user' => 1]);
$uri = Uri::temporarySignedRoute('user.index', now()->addMinutes(5));
$uri = Uri::action([UserController::class, 'index']);
$uri = Uri::action(InvokableController::class);
// Generate a URI instance from the current request URL...
$uri = $request->uri();
Once you have a URI instance, you can fluently modify it:
1$uri = Uri::of('https://example.com')
2 ->withScheme('http')
3 ->withHost('test.com')
4 ->withPort(8000)
5 ->withPath('/users')
6 ->withQuery(['page' => 2])
7 ->withFragment('section-1');
$uri = Uri::of('https://example.com')
->withScheme('http')
->withHost('test.com')
->withPort(8000)
->withPath('/users')
->withQuery(['page' => 2])
->withFragment('section-1');
Inspecting URIs
The Uri class also allows you to easily inspect the various components of
the underlying URI:
1$scheme = $uri->scheme();
2$host = $uri->host();
3$port = $uri->port();
4$path = $uri->path();
5$segments = $uri->pathSegments();
6$query = $uri->query();
7$fragment = $uri->fragment();
$scheme = $uri->scheme();
$host = $uri->host();
$port = $uri->port();
$path = $uri->path();
$segments = $uri->pathSegments();
$query = $uri->query();
$fragment = $uri->fragment();
Manipulating Query Strings
The Uri class offers several methods that may be used to manipulate a URI's
query string. The withQuery method may be used to merge additional query
string parameters into the existing query string:
1$uri = $uri->withQuery(['sort' => 'name']);
$uri = $uri->withQuery(['sort' => 'name']);
The withQueryIfMissing method may be used to merge additional query string
parameters into the existing query string if the given keys do not already
exist in the query string:
1$uri = $uri->withQueryIfMissing(['page' => 1]);
$uri = $uri->withQueryIfMissing(['page' => 1]);
The replaceQuery method may be used to complete replace the existing query
string with a new one:
1$uri = $uri->replaceQuery(['page' => 1]);
$uri = $uri->replaceQuery(['page' => 1]);
The pushOntoQuery method may be used to push additional parameters onto a
query string parameter that has an array value:
1$uri = $uri->pushOntoQuery('filter', ['active', 'pending']);
$uri = $uri->pushOntoQuery('filter', ['active', 'pending']);
The withoutQuery method may be used to remove parameters from the query
string:
1$uri = $uri->withoutQuery(['page']);
$uri = $uri->withoutQuery(['page']);
Generating Responses From URIs
The redirect method may be used to generate a RedirectResponse instance to
the given URI:
1$uri = Uri::of('https://example.com');
2
3return $uri->redirect();
$uri = Uri::of('https://example.com');
return $uri->redirect();
Or, you may simply return the Uri instance from a route or controller
action, which will automatically generate a redirect response to the returned
URI:
1use Illuminate\Support\Facades\Route;
2use Illuminate\Support\Uri;
3
4Route::get('/redirect', function () {
5 return Uri::to('/index')
6 ->withQuery(['sort' => 'name']);
7});
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Uri;
Route::get('/redirect', function () {
return Uri::to('/index')
->withQuery(['sort' => 'name']);
});