跳转至内容

辅助函数

简介

Laravel 包含各种全局“辅助” PHP 函数。许多函数都被框架本身使用;当然,如果你觉得方便,也可以在自己的应用程序中使用它们。

可用方法

数组和对象

数字

路径

URLs

杂项

数组和对象

Arr::accessible()

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

Arr::add()

Arr::add 方法向数组添加给定的键值对(如果键不存在或设置为 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]

Arr::array()

Arr::array 方法使用“点”符号从深度嵌套的数组中检索值(与 Arr::get() 相同),但如果请求的值不是 array,则会抛出 InvalidArgumentException 异常。

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

Arr::boolean()

Arr::boolean 方法使用“点”符号从深度嵌套的数组中检索值,但如果请求的值不是 boolean,则会抛出 InvalidArgumentException 异常。

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

Arr::collapse()

Arr::collapse 方法将数组的数组或集合折叠为单个数组。

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

Arr::crossJoin()

Arr::crossJoin 方法对给定的数组进行交叉连接,返回包含所有可能排列的笛卡尔积。

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

Arr::divide()

Arr::divide 方法返回两个数组:一个包含给定数组的键,另一个包含给定数组的值。

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

Arr::dot()

Arr::dot 方法将多维数组展平为单层数组,并使用“点”符号表示深度。

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

Arr::every()

Arr::every 方法确保数组中的所有值都通过给定的真值测试。

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

Arr::except()

Arr::except 方法从数组中移除给定的键值对。

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

Arr::exceptValues()

Arr::exceptValues 方法从数组中移除指定的值。

1use Illuminate\Support\Arr;
2 
3$array = ['foo', 'bar', 'baz', 'qux'];
4 
5$filtered = Arr::exceptValues($array, ['foo', 'baz']);
6 
7// ['bar', 'qux']

你也可以将 strict 参数设为 true,以在过滤时使用严格类型比较。

1use Illuminate\Support\Arr;
2 
3$array = [1, '1', 2, '2'];
4 
5$filtered = Arr::exceptValues($array, [1, 2], strict: true);
6 
7// ['1', '2']

Arr::exists()

Arr::exists 方法检查给定的键是否存在于提供的数组中。

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

Arr::first()

Arr::first 方法返回数组中通过给定真值测试的第一个元素。

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

可以将默认值作为第三个参数传递给该方法。如果没有任何值通过真值测试,则返回该默认值。

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

Arr::flatten()

Arr::flatten 方法将多维数组展平为单层数组。

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

Arr::float()

Arr::float 方法使用“点”符号从深度嵌套的数组中检索值,但如果请求的值不是 float,则会抛出 InvalidArgumentException 异常。

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

Arr::forget()

Arr::forget 方法使用“点”符号从深度嵌套的数组中移除给定的键值对。

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

Arr::from()

Arr::from 方法将各种输入类型转换为普通 PHP 数组。它支持多种输入类型,包括数组、对象和一些常见的 Laravel 接口,如 ArrayableEnumerableJsonableJsonSerializable。此外,它还能处理 TraversableWeakMap 实例。

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']

Arr::get()

Arr::get 方法使用“点”符号从深度嵌套的数组中检索值。

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

Arr::get 方法还接受一个默认值,如果指定的键不存在于数组中,则返回该值。

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

Arr::has()

Arr::has 方法使用“点”符号检查给定项是否存在于数组中。

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

Arr::hasAll()

Arr::hasAll 方法确定所有指定键是否使用“点”符号存在于给定数组中。

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

Arr::hasAny()

Arr::hasAny 方法检查给定集合中的任何项是否使用“点”符号存在于数组中。

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

Arr::integer()

Arr::integer 方法使用“点”符号从深度嵌套的数组中检索值,但如果请求的值不是 int,则会抛出 InvalidArgumentException 异常。

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

Arr::isAssoc()

如果给定的数组是关联数组,Arr::isAssoc 方法返回 true。如果数组没有从零开始的连续数字键,则认为该数组是“关联”的。

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

Arr::isList()

如果给定数组的键是从零开始的连续整数,Arr::isList 方法返回 true

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

Arr::join()

Arr::join 方法使用字符串连接数组元素。使用该方法的第三个参数,你还可以指定数组最后一个元素的连接字符串。

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

Arr::keyBy()

Arr::keyBy 方法根据给定键对数组进行键控。如果有多个项具有相同的键,则只有最后一个会出现在新数组中。

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*/

Arr::last()

Arr::last 方法返回数组中通过给定真值测试的最后一个元素。

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

可以将默认值作为第三个参数传递给该方法。如果没有任何值通过真值测试,则返回该默认值。

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

Arr::map()

Arr::map 方法遍历数组并将每个值和键传递给给定的回调。数组值将被回调返回的值替换。

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']

Arr::mapSpread()

Arr::mapSpread 方法遍历数组,将每个嵌套项的值传递给给定的闭包。闭包可以随意修改项并返回它,从而形成一个修改后的新数组。

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*/

Arr::mapWithKeys()

Arr::mapWithKeys 方法遍历数组并将每个值传递给给定的回调。回调应返回一个包含单个键值对的关联数组。

1use Illuminate\Support\Arr;
2 
3$array = [
4 [
5 'name' => 'John',
6 'department' => 'Sales',
7 'email' => '[email protected]',
8 ],
9 [
10 'name' => 'Jane',
11 'department' => 'Marketing',
12 'email' => '[email protected]',
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]' => 'John',
23 '[email protected]' => 'Jane',
24 ]
25*/

Arr::only()

Arr::only 方法仅从给定数组中返回指定的键值对。

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

Arr::onlyValues()

Arr::onlyValues 方法仅从数组中返回指定的值。

1use Illuminate\Support\Arr;
2 
3$array = ['foo', 'bar', 'baz', 'qux'];
4 
5$filtered = Arr::onlyValues($array, ['foo', 'baz']);
6 
7// ['foo', 'baz']

你也可以将 strict 参数设为 true,以在过滤时使用严格类型比较。

1use Illuminate\Support\Arr;
2 
3$array = [1, '1', 2, '2'];
4 
5$filtered = Arr::onlyValues($array, [1, 2], strict: true);
6 
7// [1, 2]

Arr::partition()

Arr::partition 方法可以与 PHP 数组解构相结合,将通过给定真值测试的元素与未通过的元素分离开来。

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]

Arr::pluck()

Arr::pluck 方法从数组中检索给定键的所有值。

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

你也可以指定希望如何对结果列表进行键控。

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

Arr::prepend()

Arr::prepend 方法会将一个项推入数组的开头。

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

如果需要,可以指定用于该值的键。

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

Arr::prependKeysWith()

Arr::prependKeysWith 使用给定的前缀为关联数组的所有键名添加前缀。

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*/

Arr::pull()

Arr::pull 方法从数组中返回并移除一个键值对。

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

可以将默认值作为第三个参数传递给该方法。如果键不存在,则返回该默认值。

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

Arr::push()

Arr::push 方法使用“点”符号将项推入数组。如果给定键处不存在数组,则会创建一个。

1use Illuminate\Support\Arr;
2 
3$array = [];
4 
5Arr::push($array, 'office.furniture', 'Desk');
6 
7// $array: ['office' => ['furniture' => ['Desk']]]

Arr::query()

Arr::query 方法将数组转换为查询字符串。

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

Arr::random()

Arr::random 方法从数组中返回一个随机值。

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

你也可以将希望返回的项数作为可选的第二个参数指定。请注意,提供此参数将返回一个数组,即使只想返回一个项。

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

Arr::reject()

Arr::reject 方法使用给定的闭包从数组中移除项。

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]

Arr::select()

Arr::select 方法从数组中选择一个值数组。

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]]

Arr::set()

Arr::set 方法使用“点”符号在深度嵌套的数组中设置值。

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

Arr::shuffle()

Arr::shuffle 方法随机打乱数组中的项。

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

Arr::sole()

Arr::sole 方法使用给定的闭包从数组中检索单个值。如果数组中有多个值匹配给定的真值测试,则抛出 Illuminate\Support\MultipleItemsFoundException 异常。如果没有匹配的值,则抛出 Illuminate\Support\ItemNotFoundException 异常。

1use Illuminate\Support\Arr;
2 
3$array = ['Desk', 'Table', 'Chair'];
4 
5$value = Arr::sole($array, fn (string $value) => $value === 'Desk');
6 
7// 'Desk'

Arr::some()

Arr::some 方法确保数组中至少有一个值通过给定的真值测试。

1use Illuminate\Support\Arr;
2 
3$array = [1, 2, 3];
4 
5Arr::some($array, fn ($i) => $i > 2);
6 
7// true

Arr::sort()

Arr::sort 方法根据值对数组进行排序。

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

你也可以根据给定闭包的结果对数组进行排序。

1use Illuminate\Support\Arr;
2 
3$array = [
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*/

Arr::sortDesc()

Arr::sortDesc 方法根据值以倒序对数组进行排序。

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

你也可以根据给定闭包的结果对数组进行排序。

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*/

Arr::sortRecursive()

Arr::sortRecursive 方法递归地对数组进行排序,对于数字索引子数组使用 sort 函数,对于关联子数组使用 ksort 函数。

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

如果你想以倒序对结果进行排序,可以使用 Arr::sortRecursiveDesc 方法。

1$sorted = Arr::sortRecursiveDesc($array);

Arr::string()

Arr::string 方法使用“点”符号从深度嵌套的数组中检索值,但如果请求的值不是 string,则抛出 InvalidArgumentException 异常。

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

Arr::take()

Arr::take 方法返回一个包含指定数量项的新数组。

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]

你也可以传递一个负整数,从数组末尾获取指定数量的项。

1$array = [0, 1, 2, 3, 4, 5];
2 
3$chunk = Arr::take($array, -2);
4 
5// [4, 5]

Arr::toCssClasses()

Arr::toCssClasses 方法有条件地编译 CSS 类字符串。该方法接受一个类数组,其中数组键包含你希望添加的类,而值是布尔表达式。如果数组元素具有数字键,它将始终包含在渲染的类列表中。

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*/

Arr::toCssStyles()

Arr::toCssStyles 方法有条件地编译 CSS 样式字符串。该方法接受一个 CSS 声明数组,其中数组键包含你希望添加的 CSS 声明,而值是布尔表达式。如果数组元素具有数字键,它将始终包含在编译后的 CSS 样式字符串中。

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*/

此方法支持 Laravel 的功能,允许 将类与 Blade 组件的属性包合并,以及 @class Blade 指令

Arr::undot()

Arr::undot 方法将使用“点”符号的单维数组扩展为多维数组。

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

Arr::where()

Arr::where 方法使用给定的闭包过滤数组。

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']

Arr::whereNotNull()

Arr::whereNotNull 方法从给定数组中移除所有 null 值。

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

Arr::wrap()

Arr::wrap 方法将给定值包装在数组中。如果给定值已经是数组,则原样返回。

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

如果给定值为 null,则返回空数组。

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

data_fill()

data_fill 函数使用“点”符号在嵌套数组或对象中设置缺失值。

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

该函数还接受星号作为通配符,并将相应地填充目标。

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

data_get()

data_get 函数使用“点”符号从嵌套数组或对象中检索值。

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

data_get 函数还接受一个默认值,如果未找到指定键,则返回该值。

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

该函数还接受使用星号的通配符,可以针对数组或对象的任何键。

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'];

{first}{last} 占位符可用于检索数组中的第一个或最后一个项。

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

data_set()

data_set 函数使用“点”符号在嵌套数组或对象中设置值。

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

该函数还接受使用星号的通配符,并将相应地在目标上设置值。

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*/

默认情况下,任何现有值都会被覆盖。如果你只想在值不存在时设置它,可以将 false 作为第四个参数传递给该函数。

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

data_forget()

data_forget 函数使用“点”符号从嵌套数组或对象中移除值。

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

该函数还接受使用星号的通配符,并将相应地移除目标上的值。

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*/

head()

head 函数返回给定数组中的第一个元素。如果数组为空,则返回 false

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

last()

last 函数返回给定数组中的最后一个元素。如果数组为空,则返回 false

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

数字

Number::abbreviate()

Number::abbreviate 方法返回提供数值的人类可读格式,并带有单位缩写。

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

Number::clamp()

Number::clamp 方法确保给定数字保持在指定范围内。如果数字小于最小值,则返回最小值。如果数字大于最大值,则返回最大值。

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

Number::currency()

Number::currency 方法返回给定值的货币表示形式(字符串)。

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 €

Number::defaultCurrency()

Number::defaultCurrency 方法返回 Number 类使用的默认货币。

1use Illuminate\Support\Number;
2 
3$currency = Number::defaultCurrency();
4 
5// USD

Number::defaultLocale()

Number::defaultLocale 方法返回 Number 类使用的默认语言环境。

1use Illuminate\Support\Number;
2 
3$locale = Number::defaultLocale();
4 
5// en

Number::fileSize()

Number::fileSize 方法返回给定字节值的文件大小表示形式(字符串)。

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

Number::forHumans()

Number::forHumans 方法返回所提供数值的人类可读格式。

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

Number::format()

Number::format 方法将给定数字格式化为特定语言环境的字符串。

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

Number::ordinal()

Number::ordinal 方法返回数字的序数表示形式。

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

Number::pairs()

Number::pairs 方法根据指定的范围和步长值生成数字对(子范围)数组。此方法有助于将较大的数字范围划分为较小、易于管理的子范围,以用于分页或批量处理任务。pairs 方法返回数组的数组,其中每个内部数组代表一个数字对(子范围)。

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]]

Number::parseInt()

Number::parseInt 方法根据指定的语言环境将字符串解析为整数。

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

Number::parseFloat()

Number::parseFloat 方法根据指定的语言环境将字符串解析为浮点数。

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

Number::percentage()

Number::percentage 方法返回给定值的百分比表示形式(字符串)。

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%

Number::spell()

Number::spell 方法将给定数字转换为单词字符串。

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

after 参数允许你指定一个值,在此值之后所有数字都应拼写出来。

1$number = Number::spell(10, after: 10);
2 
3// 10
4 
5$number = Number::spell(11, after: 10);
6 
7// eleven

until 参数允许你指定一个值,在此值之前所有数字都应拼写出来。

1$number = Number::spell(5, until: 10);
2 
3// five
4 
5$number = Number::spell(10, until: 10);
6 
7// 10

Number::spellOrdinal()

Number::spellOrdinal 方法将数字的序数表示形式作为单词字符串返回。

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

Number::trim()

Number::trim 方法移除给定数字小数点后任何多余的零。

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

Number::useLocale()

Number::useLocale 方法全局设置默认数字语言环境,这会影响后续调用 Number 类方法时数字和货币的格式化方式。

1use Illuminate\Support\Number;
2 
3/**
4 * Bootstrap any application services.
5 */
6public function boot(): void
7{
8 Number::useLocale('de');
9}

Number::withLocale()

Number::withLocale 方法使用指定的语言环境执行给定的闭包,并在回调执行后恢复原始语言环境。

1use Illuminate\Support\Number;
2 
3$number = Number::withLocale('de', function () {
4 return Number::format(1500);
5});

Number::useCurrency()

Number::useCurrency 方法全局设置默认数字货币,这会影响后续调用 Number 类方法时货币的格式化方式。

1use Illuminate\Support\Number;
2 
3/**
4 * Bootstrap any application services.
5 */
6public function boot(): void
7{
8 Number::useCurrency('GBP');
9}

Number::withCurrency()

Number::withCurrency 方法使用指定的货币执行给定的闭包,并在回调执行后恢复原始货币。

1use Illuminate\Support\Number;
2 
3$number = Number::withCurrency('GBP', function () {
4 // ...
5});

路径

app_path()

app_path 函数返回应用程序 app 目录的完全限定路径。你也可以使用 app_path 函数生成相对于应用程序目录的文件的完全限定路径。

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

base_path()

base_path 函数返回应用程序根目录的完全限定路径。你也可以使用 base_path 函数生成相对于项目根目录的给定文件的完全限定路径。

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

config_path()

config_path 函数返回应用程序 config 目录的完全限定路径。你也可以使用 config_path 函数生成应用程序配置目录中给定文件的完全限定路径。

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

database_path()

database_path 函数返回应用程序 database 目录的完全限定路径。你也可以使用 database_path 函数生成数据库目录中给定文件的完全限定路径。

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

lang_path()

lang_path 函数返回应用程序 lang 目录的完全限定路径。你也可以使用 lang_path 函数生成目录内给定文件的完全限定路径。

1$path = lang_path();
2 
3$path = lang_path('en/messages.php');

默认情况下,Laravel 应用程序骨架不包含 lang 目录。如果您想自定义 Laravel 的语言文件,可以通过 lang:publish Artisan 命令发布它们。

public_path()

public_path 函数返回应用程序 public 目录的完全限定路径。你也可以使用 public_path 函数生成公共目录内给定文件的完全限定路径。

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

resource_path()

resource_path 函数返回应用程序 resources 目录的完全限定路径。你也可以使用 resource_path 函数生成资源目录内给定文件的完全限定路径。

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

storage_path()

storage_path 函数返回应用程序 storage 目录的完全限定路径。你也可以使用 storage_path 函数生成存储目录内给定文件的完全限定路径。

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

URLs

action()

action 函数为给定的控制器动作生成 URL。

1use App\Http\Controllers\HomeController;
2 
3$url = action([HomeController::class, 'index']);

如果该方法接受路由参数,可以将它们作为第二个参数传递给该方法。

1$url = action([UserController::class, 'profile'], ['id' => 1]);

asset()

asset 函数使用当前请求的方案(HTTP 或 HTTPS)为资产生成 URL。

1$url = asset('img/photo.jpg');

你可以通过在 .env 文件中设置 ASSET_URL 变量来配置资产 URL 主机。如果你将资产托管在 Amazon S3 或其他 CDN 等外部服务上,这会很有用。

1// ASSET_URL=http://example.com/assets
2 
3$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg

route()

route 函数为给定的 命名路由 生成 URL。

1$url = route('route.name');

如果路由接受参数,可以将它们作为第二个参数传递给函数。

1$url = route('route.name', ['id' => 1]);

默认情况下,route 函数生成绝对 URL。如果你想生成相对 URL,可以将 false 作为第三个参数传递给函数。

1$url = route('route.name', ['id' => 1], false);

secure_asset()

secure_asset 函数使用 HTTPS 为资产生成 URL。

1$url = secure_asset('img/photo.jpg');

secure_url()

secure_url 函数为给定路径生成完全限定的 HTTPS URL。额外的 URL 片段可以作为函数的第二个参数传递。

1$url = secure_url('user/profile');
2 
3$url = secure_url('user/profile', [1]);

to_action()

to_action 函数为给定的控制器动作生成 重定向 HTTP 响应

1use App\Http\Controllers\UserController;
2 
3return to_action([UserController::class, 'show'], ['user' => 1]);

如果需要,你可以将应分配给重定向的 HTTP 状态代码以及任何额外的响应头作为第三和第四个参数传递给 to_action 方法。

1return to_action(
2 [UserController::class, 'show'],
3 ['user' => 1],
4 302,
5 ['X-Framework' => 'Laravel']
6);

to_route()

to_route 函数为给定的 命名路由 生成 重定向 HTTP 响应

1return to_route('users.show', ['user' => 1]);

如果需要,你可以将应分配给重定向的 HTTP 状态代码以及任何额外的响应头作为第三和第四个参数传递给 to_route 方法。

1return to_route('users.show', ['user' => 1], 302, ['X-Framework' => 'Laravel']);

uri()

uri 函数为给定 URI 生成一个 流式 URI 实例

1$uri = uri('https://example.com')
2 ->withPath('/users')
3 ->withQuery(['page' => 1]);

如果 uri 函数接收到一个包含可调用控制器和方法对的数组,该函数将为控制器方法的路由路径创建一个 Uri 实例。

1use App\Http\Controllers\UserController;
2 
3$uri = uri([UserController::class, 'show'], ['user' => $user]);

如果控制器是可调用的,你只需提供控制器类名即可。

1use App\Http\Controllers\UserIndexController;
2 
3$uri = uri(UserIndexController::class);

如果传递给 uri 函数的值匹配 命名路由 的名称,则会为该路由的路径生成一个 Uri 实例。

1$uri = uri('users.show', ['user' => $user]);

url()

url 函数为给定路径生成完全限定的 URL。

1$url = url('user/profile');
2 
3$url = url('user/profile', [1]);

如果没有提供路径,则返回 Illuminate\Routing\UrlGenerator 实例。

1$current = url()->current();
2 
3$full = url()->full();
4 
5$previous = url()->previous();

有关使用 url 函数的更多信息,请查阅 URL 生成文档

杂项

abort()

abort 函数抛出 一个 HTTP 异常,该异常将由 异常处理器 渲染。

1abort(403);

你还可以提供异常消息和应发送到浏览器的自定义 HTTP 响应头。

1abort(403, 'Unauthorized.', $headers);

abort_if()

如果给定的布尔表达式计算结果为 trueabort_if 函数将抛出 HTTP 异常。

1abort_if(! Auth::user()->isAdmin(), 403);

abort 方法一样,你也可以提供异常的响应文本作为第三个参数,并将自定义响应头的数组作为第四个参数传递给函数。

abort_unless()

如果给定的布尔表达式计算结果为 falseabort_unless 函数将抛出 HTTP 异常。

1abort_unless(Auth::user()->isAdmin(), 403);

abort 方法一样,你也可以提供异常的响应文本作为第三个参数,并将自定义响应头的数组作为第四个参数传递给函数。

app()

app 函数返回 服务容器 实例。

1$container = app();

你可以传递类或接口名称以从容器中解析它。

1$api = app('HelpSpot\API');

auth()

auth 函数返回一个 身份验证器 实例。你可以将其用作 Auth 门面的替代方案。

1$user = auth()->user();

如果需要,你可以指定想要访问的守卫实例。

1$user = auth('admin')->user();

back()

back 函数生成一个 重定向 HTTP 响应 到用户的前一个位置。

1return back($status = 302, $headers = [], $fallback = '/');
2 
3return back();

bcrypt()

bcrypt 函数使用 Bcrypt 对给定值进行 哈希处理。你可以将此函数用作 Hash 门面的替代方案。

1$password = bcrypt('my-secret-password');

blank()

blank 函数确定给定值是否为“空白”。

1blank('');
2blank(' ');
3blank(null);
4blank(collect());
5 
6// true
7 
8blank(0);
9blank(true);
10blank(false);
11 
12// false

关于 blank 的反向函数,请参见 filled 函数。

broadcast()

broadcast 函数将给定的 事件 广播 给它的监听器。

1broadcast(new UserRegistered($user));
2 
3broadcast(new UserRegistered($user))->toOthers();

broadcast_if()

如果给定的布尔表达式计算结果为 truebroadcast_if 函数将 广播 给定的 事件 给它的监听器。

1broadcast_if($user->isActive(), new UserRegistered($user));
2 
3broadcast_if($user->isActive(), new UserRegistered($user))->toOthers();

broadcast_unless()

如果给定的布尔表达式计算结果为 falsebroadcast_unless 函数将 广播 给定的 事件 给它的监听器。

1broadcast_unless($user->isBanned(), new UserRegistered($user));
2 
3broadcast_unless($user->isBanned(), new UserRegistered($user))->toOthers();

cache()

cache 函数可用于从 缓存 中获取值。如果给定键不存在于缓存中,则返回可选的默认值。

1$value = cache('key');
2 
3$value = cache('key', 'default');

你可以通过将键值对数组传递给函数来将项添加到缓存中。你还应该传递缓存值被视为有效的秒数或持续时间。

1cache(['key' => 'value'], 300);
2 
3cache(['key' => 'value'], now()->plus(seconds: 10));

class_uses_recursive()

class_uses_recursive 函数返回类使用的所有 trait,包括其所有父类使用的 trait。

1$traits = class_uses_recursive(App\Models\User::class);

collect()

collect 函数从给定值创建一个 集合 实例。

1$collection = collect(['Taylor', 'Abigail']);

config()

config 函数获取 配置 变量的值。配置值可以使用“点”语法访问,其中包括文件名和你想访问的选项。你也可以提供默认值,如果配置选项不存在,则返回该值。

1$value = config('app.timezone');
2 
3$value = config('app.timezone', $default);

你可以通过传递键值对数组在运行时设置配置变量。但是,请注意,此函数仅影响当前请求的配置值,并不会更新你的实际配置值。

1config(['app.debug' => true]);

context()

context 函数从当前 上下文 获取值。你也可以提供一个默认值,如果上下文键不存在,则返回该值。

1$value = context('trace_id');
2 
3$value = context('trace_id', $default);

你可以通过传递键值对数组来设置上下文值。

1use Illuminate\Support\Str;
2 
3context(['trace_id' => Str::uuid()->toString()]);

cookie 函数创建一个新的 Cookie 实例。

1$cookie = cookie('name', 'value', $minutes);

csrf_field()

csrf_field 函数生成一个包含 CSRF 令牌值的 HTML hidden 输入字段。例如,使用 Blade 语法

1{{ csrf_field() }}

csrf_token()

csrf_token 函数检索当前 CSRF 令牌的值。

1$token = csrf_token();

decrypt()

decrypt 函数对给定值进行 解密。你可以将此函数用作 Crypt 门面的替代方案。

1$password = decrypt($value);

关于 decrypt 的反向函数,请参见 encrypt 函数。

dd()

dd 函数转储给定的变量并终止脚本的执行。

1dd($value);
2 
3dd($value1, $value2, $value3, ...);

如果你不想停止脚本的执行,请改用 dump 函数。

dispatch()

dispatch 函数将给定的 作业 推送到 Laravel 作业队列

1dispatch(new App\Jobs\SendEmails);

dispatch_sync()

dispatch_sync 函数将给定的作业推送到 同步 队列,以便立即处理。

1dispatch_sync(new App\Jobs\SendEmails);

dump()

dump 函数转储给定的变量。

1dump($value);
2 
3dump($value1, $value2, $value3, ...);

如果你想在转储变量后停止执行脚本,请改用 dd 函数。

encrypt()

encrypt 函数对给定值进行 加密。你可以将此函数用作 Crypt 门面的替代方案。

1$secret = encrypt('my-secret-value');

关于 encrypt 的反向函数,请参见 decrypt 函数。

env()

env 函数检索 环境变量 的值或返回默认值。

1$env = env('APP_ENV');
2 
3$env = env('APP_ENV', 'production');

如果你在部署过程中执行了 config:cache 命令,请确保仅从配置内部调用 env 函数。一旦配置被缓存,将不会加载 .env 文件,所有对 env 函数的调用都将返回外部环境变量(如服务器级或系统级环境变量)或 null

event()

event 函数将给定的 事件 分发给它的监听器。

1event(new UserRegistered($user));

fake()

fake 函数从容器中解析 Faker 单例,这在创建模型工厂、数据库种子、测试和原型视图中的假数据时非常有用。

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

默认情况下,fake 函数将利用 config/app.php 配置中的 app.faker_locale 配置选项。通常,此配置选项通过 APP_FAKER_LOCALE 环境变量设置。你也可以通过将语言环境传递给 fake 函数来指定它。每个语言环境都将解析一个单独的单例。

1fake('nl_NL')->name()

filled()

filled 函数确定给定值是否“非空白”。

1filled(0);
2filled(true);
3filled(false);
4 
5// true
6 
7filled('');
8filled(' ');
9filled(null);
10filled(collect());
11 
12// false

关于 filled 的反向函数,请参见 blank 函数。

info()

info 函数将信息写入应用程序的 日志

1info('Some helpful information!');

上下文数据数组也可以传递给该函数。

1info('User login attempt failed.', ['id' => $user->id]);

literal()

literal 函数使用给定的命名参数作为属性创建一个新的 stdClass 实例。

1$obj = literal(
2 name: 'Joe',
3 languages: ['PHP', 'Ruby'],
4);
5 
6$obj->name; // 'Joe'
7$obj->languages; // ['PHP', 'Ruby']

logger()

logger 函数可用于将 debug 级别消息写入 日志

1logger('Debug message');

上下文数据数组也可以传递给该函数。

1logger('User has logged in.', ['id' => $user->id]);

如果没有传递值给函数,则返回一个 记录器 实例。

1logger()->error('You are not allowed here.');

method_field()

method_field 函数生成一个 HTML hidden 输入字段,其中包含表单 HTTP 动词的欺骗值。例如,使用 Blade 语法

1<form method="POST">
2 {{ method_field('DELETE') }}
3</form>

now()

now 函数为当前时间创建一个新的 Illuminate\Support\Carbon 实例。

1$now = now();

old()

old 函数 检索 闪存到会话中的 旧输入 值。

1$value = old('value');
2 
3$value = old('value', 'default');

由于作为 old 函数第二个参数提供的“默认值”通常是 Eloquent 模型的属性,Laravel 允许你简单地将整个 Eloquent 模型作为第二个参数传递给 old 函数。执行此操作时,Laravel 将假定提供给 old 函数的第一个参数是应被视为“默认值”的 Eloquent 属性名称。

1{{ old('name', $user->name) }}
2 
3// Is equivalent to...
4 
5{{ old('name', $user) }}

once()

once 函数执行给定的回调,并将结果在内存中缓存整个请求期间。任何后续使用相同回调对 once 函数的调用都将返回之前缓存的结果。

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)

当从对象实例内执行 once 函数时,缓存的结果将是该对象实例独有的。

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)

optional()

optional 函数接受任何参数,并允许你访问该对象的属性或调用方法。如果给定对象为 null,属性和方法将返回 null 而不会导致错误。

1return optional($user->address)->street;
2 
3{!! old('name', optional($user)->name) !!}

optional 函数还接受一个闭包作为其第二个参数。如果作为第一个参数提供的值不为 null,则将调用该闭包。

1return optional(User::find($id), function (User $user) {
2 return $user->name;
3});

policy()

policy 方法检索给定类的 策略 实例。

1$policy = policy(App\Models\User::class);

redirect()

redirect 函数返回一个 重定向 HTTP 响应,或者在没有参数调用的情况下返回重定向器实例。

1return redirect($to = null, $status = 302, $headers = [], $secure = null);
2 
3return redirect('/home');
4 
5return redirect()->route('route.name');

report()

report 函数将使用你的 异常处理器 报告异常。

1report($e);

report 函数还接受字符串作为参数。当函数接收到字符串时,该函数将创建一个以给定字符串为消息的异常。

1report('Something went wrong.');

report_if()

如果给定的布尔表达式计算结果为 truereport_if 函数将使用你的 异常处理器 报告异常。

1report_if($shouldReport, $e);
2 
3report_if($shouldReport, 'Something went wrong.');

report_unless()

如果给定的布尔表达式计算结果为 falsereport_unless 函数将使用你的 异常处理器 报告异常。

1report_unless($reportingDisabled, $e);
2 
3report_unless($reportingDisabled, 'Something went wrong.');

request()

request 函数返回当前的 请求 实例或从当前请求中获取输入字段的值。

1$request = request();
2 
3$value = request('key', $default);

rescue()

rescue 函数执行给定的闭包并捕获其执行过程中发生的任何异常。所有被捕获的异常都将被发送到你的 异常处理器;但是,请求将继续处理。

1return rescue(function () {
2 return $this->method();
3});

你也可以将第二个参数传递给 rescue 函数。此参数将是如果在执行闭包时发生异常而应返回的“默认”值。

1return rescue(function () {
2 return $this->method();
3}, false);
4 
5return rescue(function () {
6 return $this->method();
7}, function () {
8 return $this->failure();
9});

report 参数可以提供给 rescue 函数,以确定是否应通过 report 函数报告异常。

1return rescue(function () {
2 return $this->method();
3}, report: function (Throwable $throwable) {
4 return $throwable instanceof InvalidArgumentException;
5});

resolve()

resolve 函数使用 服务容器 将给定的类或接口名称解析为实例。

1$api = resolve('HelpSpot\API');

response()

response 函数创建一个 响应 实例或获取响应工厂的实例。

1return response('Hello World', 200, $headers);
2 
3return response()->json(['foo' => 'bar'], 200, $headers);

retry()

retry 函数尝试执行给定的回调,直到达到给定的最大尝试阈值。如果回调未抛出异常,则返回其返回值。如果回调抛出异常,它将自动重试。如果超过最大尝试次数,则抛出异常。

1return retry(5, function () {
2 // Attempt 5 times while resting 100ms between attempts...
3}, 100);

如果你想手动计算尝试之间的休眠毫秒数,可以将闭包作为第三个参数传递给 retry 函数。

1use Exception;
2 
3return retry(5, function () {
4 // ...
5}, function (int $attempt, Exception $exception) {
6 return $attempt * 100;
7});

为方便起见,你可以提供一个数组作为第一个参数给 retry 函数。此数组将用于确定后续尝试之间休眠的毫秒数。

1return retry([100, 200], function () {
2 // Sleep for 100ms on first retry, 200ms on second retry...
3});

要仅在特定条件下重试,你可以将闭包作为第四个参数传递给 retry 函数。

1use App\Exceptions\TemporaryException;
2use Exception;
3 
4return retry(5, function () {
5 // ...
6}, 100, function (Exception $exception) {
7 return $exception instanceof TemporaryException;
8});

session()

session 函数可用于获取或设置 会话 值。

1$value = session('key');

你可以通过将键值对数组传递给函数来设置值。

1session(['chairs' => 7, 'instruments' => 3]);

如果没有传递值给函数,则返回会话存储。

1$value = session()->get('key');
2 
3session()->put('key', $value);

tap()

tap 函数接受两个参数:一个任意的 $value 和一个闭包。$value 将被传递给闭包,然后由 tap 函数返回。闭包的返回值无关紧要。

1$user = tap(User::first(), function (User $user) {
2 $user->name = 'Taylor';
3 
4 $user->save();
5});

如果没有闭包传递给 tap 函数,你可以调用给定 $value 上的任何方法。无论方法定义中实际返回什么,所调用方法的返回值都将始终是 $value。例如,Eloquent 的 update 方法通常返回一个整数。但是,我们可以通过将 update 方法调用链式连接到 tap 函数中,强制该方法返回模型本身。

1$user = tap($user)->update([
2 'name' => $name,
3 'email' => $email,
4]);

要将 tap 方法添加到类中,可以将 Illuminate\Support\Traits\Tappable trait 添加到该类中。此 trait 的 tap 方法接受一个闭包作为其唯一参数。对象实例本身将被传递给闭包,然后由 tap 方法返回。

1return $user->tap(function (User $user) {
2 // ...
3});

throw_if()

如果给定的布尔表达式计算结果为 truethrow_if 函数抛出给定的异常。

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_unless()

如果给定的布尔表达式计算结果为 falsethrow_unless 函数抛出给定的异常。

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);

today()

today 函数为当前日期创建一个新的 Illuminate\Support\Carbon 实例。

1$today = today();

trait_uses_recursive()

trait_uses_recursive 函数返回一个 trait 使用的所有 trait。

1$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);

transform()

如果值不为 blanktransform 函数将在给定值上执行闭包,然后返回闭包的返回值。

1$callback = function (int $value) {
2 return $value * 2;
3};
4 
5$result = transform(5, $callback);
6 
7// 10

可以将默认值或闭包作为第三个参数传递给函数。如果给定值为空白,则返回该值。

1$result = transform(null, $callback, 'The value is blank');
2 
3// The value is blank

validator()

validator 函数使用给定的参数创建一个新的 验证器 实例。你可以将其用作 Validator 门面的替代方案。

1$validator = validator($data, $rules, $messages);

value()

value 函数返回它给定的值。但是,如果你传递一个闭包给该函数,则会执行该闭包并返回其返回的值。

1$result = value(true);
2 
3// true
4 
5$result = value(function () {
6 return false;
7});
8 
9// false

额外的参数可以传递给 value 函数。如果第一个参数是闭包,则额外的参数将作为参数传递给闭包,否则它们将被忽略。

1$result = value(function (string $name) {
2 return $name;
3}, 'Taylor');
4 
5// 'Taylor'

view()

view 函数检索一个 视图 实例。

1return view('auth.login');

with()

with 函数返回它给定的值。如果闭包作为第二个参数传递给该函数,则会执行该闭包并返回其返回的值。

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

when()

如果给定的条件计算结果为 truewhen 函数返回它给定的值。否则,返回 null。如果闭包作为第二个参数传递给该函数,则会执行该闭包并返回其返回的值。

1$value = when(true, 'Hello World');
2 
3$value = when(true, fn () => 'Hello World');

when 函数主要用于有条件地渲染 HTML 属性。

1<div {!! when($condition, 'wire:poll="calculate"') !!}>
2 ...
3</div>

其他工具

基准测试 (Benchmarking)

有时你可能希望快速测试应用程序某些部分的性能。在这些情况下,你可以利用 Benchmark 支持类来测量给定回调完成所需的毫秒数。

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]);

默认情况下,给定的回调将执行一次(一次迭代),其持续时间将显示在浏览器/控制台中。

要多次调用回调,你可以将回调应调用的迭代次数作为方法的第二个参数指定。多次执行回调时,Benchmark 类将返回在所有迭代中执行回调所需的平均毫秒数。

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

有时,你可能想对回调的执行进行基准测试,同时仍获取回调返回的值。value 方法将返回一个元组,其中包含回调返回的值以及执行回调所需的毫秒数。

1[$count, $duration] = Benchmark::value(fn () => User::count());

日期和时间

Laravel 包含 Carbon,这是一个强大的日期和时间操作库。要创建新的 Carbon 实例,可以调用 now 函数。此函数在你的 Laravel 应用程序中是全局可用的。

1$now = now();

或者,你可以使用 Illuminate\Support\Carbon 类创建新的 Carbon 实例。

1use Illuminate\Support\Carbon;
2 
3$now = Carbon::now();

Laravel 还通过 plusminus 方法增强了 Carbon 实例,允许轻松操作实例的日期和时间。

1return now()->plus(minutes: 5);
2return now()->plus(hours: 8);
3return now()->plus(weeks: 4);
4 
5return now()->minus(minutes: 5);
6return now()->minus(hours: 8);
7return now()->minus(weeks: 4);

关于 Carbon 及其功能的深入讨论,请查阅 官方 Carbon 文档

间隔函数

Laravel 还提供了 millisecondssecondsminuteshoursdaysweeksmonthsyears 函数,它们返回 CarbonInterval 实例,这些实例扩展了 PHP 的 DateInterval 类。这些函数可以在 Laravel 接受 DateInterval 实例的任何地方使用。

1use Illuminate\Support\Facades\Cache;
2 
3use function Illuminate\Support\{minutes};
4 
5Cache::put('metrics', $metrics, minutes(10));

延迟函数 (Deferred Functions)

虽然 Laravel 的 队列作业 允许你将任务排队以进行后台处理,但有时你可能有一些简单的任务想要延迟,而无需配置或维护长时间运行的队列工作程序。

延迟函数允许你将闭包的执行延迟到 HTTP 响应发送给用户之后,从而使你的应用程序感觉快速且响应灵敏。要延迟闭包的执行,只需将闭包传递给 Illuminate\Support\defer 函数。

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});

默认情况下,仅当调用 Illuminate\Support\defer 的 HTTP 响应、Artisan 命令或排队作业成功完成时,才会执行延迟函数。这意味着如果请求导致 4xx5xx HTTP 响应,则不会执行延迟函数。如果你希望延迟函数始终执行,可以将 always 方法链式连接到你的延迟函数上。

1defer(fn () => Metrics::reportOrder($order))->always();

如果你安装了 Swoole PHP 扩展,Laravel 的 defer 函数可能会与 Swoole 自身的全局 defer 函数冲突,从而导致 Web 服务器错误。请确保通过显式命名空间调用 Laravel 的 defer 辅助函数:use function Illuminate\Support\defer;

取消延迟函数

如果需要在延迟函数执行前取消它,可以使用 forget 方法按名称取消函数。要命名延迟函数,请为 Illuminate\Support\defer 函数提供第二个参数。

1defer(fn () => Metrics::report(), 'reportMetrics');
2 
3defer()->forget('reportMetrics');

在测试中禁用延迟函数

编写测试时,禁用延迟函数可能很有用。你可以在测试中调用 withoutDefer,指示 Laravel 立即调用所有延迟函数。

1test('without defer', function () {
2 $this->withoutDefer();
3 
4 // ...
5});
1use Tests\TestCase;
2 
3class ExampleTest extends TestCase
4{
5 public function test_without_defer(): void
6 {
7 $this->withoutDefer();
8 
9 // ...
10 }
11}

如果你想为测试用例中的所有测试禁用延迟函数,可以在基本 TestCase 类的 setUp 方法中调用 withoutDefer 方法。

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}

抽奖 (Lottery)

Laravel 的抽奖类可用于根据一组给定的几率执行回调。当你只想为部分传入请求执行代码时,这特别有用。

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

你可以将 Laravel 的抽奖类与其他 Laravel 功能相结合。例如,你可能只想向异常处理器报告一小部分慢查询。而且,由于抽奖类是可调用的,我们可以将类的实例传递给任何接受可调用对象的函数。

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);

测试抽奖

Laravel 提供了一些简单的方法,允许你轻松测试应用程序的抽奖调用。

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();

管道 (Pipeline)

Laravel 的 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);

如你所见,管道中的每个可调用类或闭包都会获得输入和一个 $next 闭包。调用 $next 闭包将调用管道中的下一个可调用对象。如你所注意到的,这与 中间件 非常相似。

当管道中的最后一个可调用对象调用 $next 闭包时,将调用提供给 then 方法的可调用对象。通常,此可调用对象将简单地返回给定的输入。为方便起见,如果你只想在处理后返回输入,可以使用 thenReturn 方法。

当然,如前所述,你并不局限于为管道提供闭包。你也可以提供可调用类。如果提供了类名,则该类将通过 Laravel 的 服务容器 进行实例化,从而允许将依赖项注入到可调用类中。

1$user = Pipeline::send($user)
2 ->through([
3 GenerateProfilePhoto::class,
4 ActivateSubscription::class,
5 SendWelcomeEmail::class,
6 ])
7 ->thenReturn();

可以在管道上调用 withinTransaction 方法,以自动将管道的所有步骤包装在单个数据库事务中。

1$user = Pipeline::send($user)
2 ->withinTransaction()
3 ->through([
4 ProcessOrder::class,
5 TransferFunds::class,
6 UpdateInventory::class,
7 ])
8 ->thenReturn();

休眠 (Sleep)

Laravel 的 Sleep 类是对 PHP 原生 sleepusleep 函数的轻量级包装,提供了更好的可测试性,同时还公开了开发人员友好的时间处理 API。

1use Illuminate\Support\Sleep;
2 
3$waiting = true;
4 
5while ($waiting) {
6 Sleep::for(1)->second();
7 
8 $waiting = /* ... */;
9}

Sleep 类提供了多种方法,允许你处理不同的时间单位。

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()->plus(minutes: 1));
21 
22// Alias of PHP's native "sleep" function...
23Sleep::sleep(2);
24 
25// Alias of PHP's native "usleep" function...
26Sleep::usleep(5000);

要轻松组合时间单位,可以使用 and 方法。

1Sleep::for(1)->second()->and(10)->milliseconds();

测试休眠

在测试使用 Sleep 类或 PHP 原生休眠函数的代码时,你的测试将暂停执行。如你所料,这会使你的测试套件变慢很多。例如,假设你正在测试以下代码:

1$waiting = /* ... */;
2 
3$seconds = 1;
4 
5while ($waiting) {
6 Sleep::for($seconds++)->seconds();
7 
8 $waiting = /* ... */;
9}

通常,测试此代码至少需要一秒钟。幸运的是,Sleep 类允许我们“伪造”休眠,从而使我们的测试套件保持快速。

1it('waits until ready', function () {
2 Sleep::fake();
3 
4 // ...
5});
1public function test_it_waits_until_ready()
2{
3 Sleep::fake();
4 
5 // ...
6}

伪造 Sleep 类时,实际的执行暂停会被绕过,从而导致测试大幅加快。

一旦 Sleep 类被伪造,就可以对预期的“休眠”进行断言。为了说明这一点,让我们假设我们正在测试代码,该代码暂停执行三次,每次暂停增加一秒。使用 assertSequence 方法,我们可以断言我们的代码在保持测试快速的同时,休眠了适当的时间。

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}
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}

当然,Sleep 类在测试时提供了多种其他可用的断言。

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();

有时,每当发生伪造休眠时执行操作可能会很有用。为实现这一点,你可以为 whenFakingSleep 方法提供一个回调。在下面的示例中,我们使用 Laravel 的 时间操作辅助函数 来根据每次休眠的持续时间瞬间推进时间。

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});

由于推进时间是常见需求,fake 方法接受一个 syncWithCarbon 参数,以便在测试中休眠时保持 Carbon 同步。

1Sleep::fake(syncWithCarbon: true);
2 
3$start = now();
4 
5Sleep::for(1)->second();
6 
7$start->diffForHumans(); // 1 second ago

只要暂停执行,Laravel 内部就会使用 Sleep 类。例如,retry 辅助函数在休眠时使用 Sleep 类,从而在使用该辅助函数时提供了改进的可测试性。

时间盒 (Timebox)

Laravel 的 Timebox 类确保给定回调执行始终需要固定的时间,即使其实际执行更快完成。这对于加密操作和用户身份验证检查特别有用,因为攻击者可能会利用执行时间的差异来推断敏感信息。

如果执行超过固定持续时间,Timebox 不会产生任何影响。由开发人员选择足够长的时间作为固定持续时间,以应对最坏的情况。

call 方法接受一个闭包和微秒为单位的时间限制,然后执行闭包并等待直到达到时间限制。

1use Illuminate\Support\Timebox;
2 
3(new Timebox)->call(function ($timebox) {
4 // ...
5}, microseconds: 10000);

如果在闭包内抛出异常,此类将遵循定义的延迟,并在延迟后重新抛出异常。

URI

Laravel 的 Uri 类提供了用于创建和操作 URI 的便捷且流式的接口。此类封装了底层 League URI 包提供的功能,并与 Laravel 的路由系统无缝集成。

你可以使用静态方法轻松创建 Uri 实例。

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()->plus(minutes: 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();

一旦有了 URI 实例,就可以流畅地修改它。

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 类还允许你轻松检查底层 URI 的各种组件。

1$scheme = $uri->scheme();
2$authority = $uri->authority();
3$host = $uri->host();
4$port = $uri->port();
5$path = $uri->path();
6$segments = $uri->pathSegments();
7$query = $uri->query();
8$fragment = $uri->fragment();

操作查询字符串

Uri 类提供了几种可用于操作 URI 查询字符串的方法。withQuery 方法可用于将额外的查询字符串参数合并到现有查询字符串中。

1$uri = $uri->withQuery(['sort' => 'name']);

如果给定键在查询字符串中尚不存在,则 withQueryIfMissing 方法可用于将额外的查询字符串参数合并到现有查询字符串中。

1$uri = $uri->withQueryIfMissing(['page' => 1]);

replaceQuery 方法可用于用新查询字符串完全替换现有查询字符串。

1$uri = $uri->replaceQuery(['page' => 1]);

pushOntoQuery 方法可用于将额外参数推送到具有数组值的查询字符串参数上。

1$uri = $uri->pushOntoQuery('filter', ['active', 'pending']);

withoutQuery 方法可用于从查询字符串中移除参数。

1$uri = $uri->withoutQuery(['page']);

从 URI 生成响应

redirect 方法可用于生成到给定 URI 的 RedirectResponse 实例。

1$uri = Uri::of('https://example.com');
2 
3return $uri->redirect();

或者,你可以简单地从路由或控制器动作返回 Uri 实例,这将自动生成到返回 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});