辅助工具

介绍
可用方法
其他工具

介绍

Laravel 包含多种全局“助手”PHP函数。许多这些函数被框架本身使用；然而，如果你觉得它们方便，你可以在自己的应用程序中自由使用它们。

可用方法

数组与对象

杂项

数组与对象

`Arr::accessible()`

Arr::accessible 方法确定给定值是否可以作为数组访问：

php

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

Arr::add 方法在数组中添加给定的键/值对，如果给定的键在数组中不存在或设置为 null：

php

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::collapse()`

Arr::collapse 方法将数组的数组合并为一个单一数组：

php

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

Arr::crossJoin 方法交叉连接给定的数组，返回所有可能排列的笛卡尔积：

php

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

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

php

use Illuminate\Support\Arr;

[$keys, $values] = Arr::divide(['name' => 'Desk']);

// $keys: ['name']

// $values: ['Desk']

`Arr::dot()`

Arr::dot 方法将多维数组扁平化为单层数组，使用“点”表示法指示深度：

php

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

$flattened = Arr::dot($array);

// ['products.desk.price' => 100]

`Arr::except()`

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

php

use Illuminate\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100];

$filtered = Arr::except($array, ['price']);

// ['name' => 'Desk']

`Arr::exists()`

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

php

use Illuminate\Support\Arr;

$array = ['name' => 'John Doe', 'age' => 17];

$exists = Arr::exists($array, 'name');

// true

$exists = Arr::exists($array, 'salary');

// false

`Arr::first()`

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

php

use Illuminate\Support\Arr;

$array = [100, 200, 300];

$first = Arr::first($array, function (int $value, int $key) {
    return $value >= 150;
});

// 200

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

php

use Illuminate\Support\Arr;

$first = Arr::first($array, $callback, $default);

`Arr::flatten()`

Arr::flatten 方法将多维数组扁平化为单层数组：

php

use Illuminate\Support\Arr;

$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];

$flattened = Arr::flatten($array);

// ['Joe', 'PHP', 'Ruby']

`Arr::forget()`

Arr::forget 方法使用“点”表示法从深层嵌套数组中移除给定的键/值对：

php

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

Arr::forget($array, 'products.desk');

// ['products' => []]

`Arr::get()`

Arr::get 方法使用“点”表示法从深层嵌套数组中检索值：

php

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

$price = Arr::get($array, 'products.desk.price');

// 100

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

php

use Illuminate\Support\Arr;

$discount = Arr::get($array, 'products.desk.discount', 0);

// 0

`Arr::has()`

Arr::has 方法检查给定项或项是否存在于数组中，使用“点”表示法：

php

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::hasAny()`

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

php

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::isAssoc()`

Arr::isAssoc 方法返回 true 如果给定数组是关联数组。一个数组被认为是“关联的”，如果它没有从零开始的顺序数字键：

php

use Illuminate\Support\Arr;

$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);

// true

$isAssoc = Arr::isAssoc([1, 2, 3]);

// false

`Arr::isList()`

Arr::isList 方法返回 true 如果给定数组的键是从零开始的顺序整数：

php

use Illuminate\Support\Arr;

$isList = Arr::isList(['foo', 'bar', 'baz']);

// true

$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);

// false

`Arr::join()`

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

php

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

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

php

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

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

php

use Illuminate\Support\Arr;

$array = [100, 200, 300, 110];

$last = Arr::last($array, function (int $value, int $key) {
    return $value >= 150;
});

// 300

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

php

use Illuminate\Support\Arr;

$last = Arr::last($array, $callback, $default);

`Arr::map()`

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

php

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

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

php

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

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

php

use Illuminate\Support\Arr;

$array = [
    [
        'name' => 'John',
        'department' => 'Sales',
        'email' => 'john@example.com',
    ],
    [
        'name' => 'Jane',
        'department' => 'Marketing',
        'email' => 'jane@example.com',
    ]
];

$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
    return [$item['email'] => $item['name']];
});

/*
    [
        'john@example.com' => 'John',
        'jane@example.com' => 'Jane',
    ]
*/

`Arr::only()`

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

php

use Illuminate\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];

$slice = Arr::only($array, ['name', 'price']);

// ['name' => 'Desk', 'price' => 100]

`Arr::pluck()`

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

php

use Illuminate\Support\Arr;

$array = [
    ['developer' => ['id' => 1, 'name' => 'Taylor']],
    ['developer' => ['id' => 2, 'name' => 'Abigail']],
];

$names = Arr::pluck($array, 'developer.name');

// ['Taylor', 'Abigail']

你还可以指定希望结果列表的键：

php

use Illuminate\Support\Arr;

$names = Arr::pluck($array, 'developer.name', 'developer.id');

// [1 => 'Taylor', 2 => 'Abigail']

`Arr::prepend()`

Arr::prepend 方法将一个项推送到数组的开头：

php

use Illuminate\Support\Arr;

$array = ['one', 'two', 'three', 'four'];

$array = Arr::prepend($array, 'zero');

// ['zero', 'one', 'two', 'three', 'four']

如果需要，你可以指定应使用的值的键：

php

use Illuminate\Support\Arr;

$array = ['price' => 100];

$array = Arr::prepend($array, 'Desk', 'name');

// ['name' => 'Desk', 'price' => 100]

`Arr::prependKeysWith()`

Arr::prependKeysWith 将关联数组的所有键名用给定前缀进行前缀化：

php

use Illuminate\Support\Arr;

$array = [
    'name' => 'Desk',
    'price' => 100,
];

$keyed = Arr::prependKeysWith($array, 'product.');

/*
    [
        'product.name' => 'Desk',
        'product.price' => 100,
    ]
*/

`Arr::pull()`

Arr::pull 方法返回并移除数组中的键/值对：

php

use Illuminate\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100];

$name = Arr::pull($array, 'name');

// $name: Desk

// $array: ['price' => 100]

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

php

use Illuminate\Support\Arr;

$value = Arr::pull($array, $key, $default);

`Arr::query()`

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

php

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

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

php

use Illuminate\Support\Arr;

$array = [1, 2, 3, 4, 5];

$random = Arr::random($array);

// 4 - (随机获取)

你还可以指定作为可选第二个参数返回的项数。请注意，提供此参数将返回一个数组，即使只想要一个项：

php

use Illuminate\Support\Arr;

$items = Arr::random($array, 2);

// [2, 5] - (随机获取)

`Arr::set()`

Arr::set 方法使用“点”表示法在深层嵌套数组中设置值：

php

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

Arr::set($array, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 200]]]

`Arr::shuffle()`

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

php

use Illuminate\Support\Arr;

$array = Arr::shuffle([1, 2, 3, 4, 5]);

// [3, 2, 5, 1, 4] - (随机生成)

`Arr::sort()`

Arr::sort 方法按值对数组进行排序：

php

use Illuminate\Support\Arr;

$array = ['Desk', 'Table', 'Chair'];

$sorted = Arr::sort($array);

// ['Chair', 'Desk', 'Table']

你还可以按给定闭包的结果对数组进行排序：

php

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

Arr::sortDesc 方法按值对数组进行降序排序：

php

use Illuminate\Support\Arr;

$array = ['Desk', 'Table', 'Chair'];

$sorted = Arr::sortDesc($array);

// ['Table', 'Desk', 'Chair']

你还可以按给定闭包的结果对数组进行排序：

php

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

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

php

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'],
    ]
*/

如果你希望结果按降序排序，可以使用 Arr::sortRecursiveDesc 方法。

php

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

`Arr::take()`

Arr::take 方法返回一个新数组，其中包含指定数量的项：

php

use Illuminate\Support\Arr;

$array = [0, 1, 2, 3, 4, 5];

$chunk = Arr::take($array, 3);

// [0, 1, 2]

你还可以传递一个负整数，从数组的末尾获取指定数量的项：

php

$array = [0, 1, 2, 3, 4, 5];

$chunk = Arr::take($array, -2);

// [4, 5]

`Arr::toCssClasses()`

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

php

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

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

php

use Illuminate\Support\Arr;

$hasColor = true;

$array = ['background-color: blue', 'color: blue' => $hasColor];

$classes = Arr::toCssStyles($array);

/*
    'background-color: blue; color: blue;'
*/

该方法为 Laravel 的功能提供支持，允许与 Blade 组件的属性包合并类以及 @class Blade 指令。

`Arr::undot()`

Arr::undot 方法将使用“点”表示法的单维数组扩展为多维数组：

php

use Illuminate\Support\Arr;

$array = [
    'user.name' => 'Kevin Malone',
    'user.occupation' => 'Accountant',
];

$array = Arr::undot($array);

// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]

`Arr::where()`

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

php

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

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

php

use Illuminate\Support\Arr;

$array = [0, null];

$filtered = Arr::whereNotNull($array);

// [0 => 0]

`Arr::wrap()`

Arr::wrap 方法将给定值包装在数组中。如果给定值已经是数组，则将其返回而不修改：

php

use Illuminate\Support\Arr;

$string = 'Laravel';

$array = Arr::wrap($string);

// ['Laravel']

如果给定值为 null，则将返回一个空数组：

php

use Illuminate\Support\Arr;

$array = Arr::wrap(null);

// []

`data_fill()`

data_fill 函数使用“点”表示法在嵌套数组或对象中设置缺失值：

php

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

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

php

$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()`

data_get 函数使用“点”表示法从嵌套数组或对象中检索值：

php

$data = ['products' => ['desk' => ['price' => 100]]];

$price = data_get($data, 'products.desk.price');

// 100

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

php

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

// 0

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

php

$data = [
    'product-one' => ['name' => 'Desk 1', 'price' => 100],
    'product-two' => ['name' => 'Desk 2', 'price' => 150],
];

data_get($data, '*.name');

// ['Desk 1', 'Desk 2'];

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

php

$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()`

data_set 函数使用“点”表示法在嵌套数组或对象中设置值：

php

$data = ['products' => ['desk' => ['price' => 100]]];

data_set($data, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 200]]]

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

php

$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],
        ],
    ]
*/

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

php

$data = ['products' => ['desk' => ['price' => 100]]];

data_set($data, 'products.desk.price', 200, overwrite: false);

// ['products' => ['desk' => ['price' => 100]]]

`data_forget()`

data_forget 函数使用“点”表示法在嵌套数组或对象中移除值：

php

$data = ['products' => ['desk' => ['price' => 100]]];

data_forget($data, 'products.desk.price');

// ['products' => ['desk' => []]]

该函数还接受使用星号的通配符，并将值相应地从目标中移除：

php

$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()`

head 函数返回给定数组中的第一个元素：

php

$array = [100, 200, 300];

$first = head($array);

// 100

`last()`

last 函数返回给定数组中的最后一个元素：

php

$array = [100, 200, 300];

$last = last($array);

// 300

数字

`Number::abbreviate()`

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

php

use Illuminate\Support\Number;

$number = Number::abbreviate(1000);

// 1K

$number = Number::abbreviate(489939);

// 490K

$number = Number::abbreviate(1230000, precision: 2);

// 1.23M

`Number::clamp()`

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

php

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

Number::currency 方法返回给定值的货币表示形式，作为字符串：

php

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 €

`Number::defaultCurrency()`

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

php

use Illuminate\Support\Number;

$currency = Number::defaultCurrency();

// USD

`Number::defaultLocale()`

Number::defaultLocale 方法返回 Number 类使用的默认区域设置：

php

use Illuminate\Support\Number;

$locale = Number::defaultLocale();

// en

`Number::fileSize()`

Number::fileSize 方法返回给定字节值的文件大小表示形式，作为字符串：

php

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

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

php

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

Number::format 方法将给定数字格式化为特定于区域的字符串：

php

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

Number::ordinal 方法返回数字的序数表示：

php

use Illuminate\Support\Number;

$number = Number::ordinal(1);

// 1st

$number = Number::ordinal(2);

// 2nd

$number = Number::ordinal(21);

// 21st

`Number::pairs()`

Number::pairs 方法根据指定范围和步长生成数字对（子范围）数组。此方法对于将较大数字范围划分为较小的可管理子范围（例如分页或批处理任务）非常有用。pairs 方法返回一个数组的数组，其中每个内部数组表示一对（子范围）数字：

php

use Illuminate\Support\Number;

$result = Number::pairs(25, 10);

// [[1, 10], [11, 20], [21, 25]]

$result = Number::pairs(25, 10, offset: 0);

// [[0, 10], [10, 20], [20, 25]]

`Number::percentage()`

Number::percentage 方法返回给定值的百分比表示，作为字符串：

php

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

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

php

use Illuminate\Support\Number;

$number = Number::spell(102);

// one hundred and two

$number = Number::spell(88, locale: 'fr');

// quatre-vingt-huit

after 参数允许你指定一个值，在该值之后所有数字都应拼写出来：

php

$number = Number::spell(10, after: 10);

// 10

$number = Number::spell(11, after: 10);

// eleven

until 参数允许你指定一个值，在该值之前所有数字都应拼写出来：

php

$number = Number::spell(5, until: 10);

// five

$number = Number::spell(10, until: 10);

// 10

`Number::trim()`

Number::trim 方法移除给定数字的小数点后任何尾随零：

php

use Illuminate\Support\Number;

$number = Number::trim(12.0);

// 12

$number = Number::trim(12.30);

// 12.3

`Number::useLocale()`

Number::useLocale 方法全局设置默认数字区域，这会影响后续调用 Number 类方法时数字和货币的格式化：

php

use Illuminate\Support\Number;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Number::useLocale('de');
}

`Number::withLocale()`

Number::withLocale 方法使用指定的区域执行给定的闭包，然后在回调执行后恢复原始区域：

php

use Illuminate\Support\Number;

$number = Number::withLocale('de', function () {
    return Number::format(1500);
});

`Number::useCurrency()`

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

php

use Illuminate\Support\Number;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Number::useCurrency('GBP');
}

`Number::withCurrency()`

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

php

use Illuminate\Support\Number;

$number = Number::withCurrency('GBP', function () {
    // ...
});

`app_path()`

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

php

$path = app_path();

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

`base_path()`

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

php

$path = base_path();

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

`config_path()`

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

php

$path = config_path();

$path = config_path('app.php');

`database_path()`

database_path 函数返回应用程序 database 目录的完整路径。您还可以使用 database_path 函数生成数据库目录中给定文件的完整路径：

php

$path = database_path();

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

`lang_path()`

lang_path 函数返回应用程序 lang 目录的完整路径。您还可以使用 lang_path 函数生成目录中给定文件的完整路径：

php

$path = lang_path();

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

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

`mix()`

mix 函数返回版本化 Mix 文件的路径：

php

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

`public_path()`

public_path 函数返回应用程序 public 目录的完整路径。您还可以使用 public_path 函数生成公共目录中给定文件的完整路径：

php

$path = public_path();

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

`resource_path()`

resource_path 函数返回应用程序 resources 目录的完整路径。您还可以使用 resource_path 函数生成资源目录中给定文件的完整路径：

php

$path = resource_path();

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

`storage_path()`

storage_path 函数返回应用程序 storage 目录的完整路径。您还可以使用 storage_path 函数生成存储目录中给定文件的完整路径：

php

$path = storage_path();

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

URLs

`action()`

action 函数为给定的控制器操作生成一个 URL：

php

use App\Http\Controllers\HomeController;

$url = action([HomeController::class, 'index']);

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

php

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

`asset()`

asset 函数使用当前请求的方案（HTTP 或 HTTPS）生成资产的 URL：

php

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

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

php

// ASSET_URL=http://example.com/assets

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

`route()`

route 函数为给定的命名路由生成一个 URL：

php

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

如果路由接受参数，您可以将它们作为第二个参数传递给该函数：

php

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

默认情况下，route 函数生成绝对 URL。如果您希望生成相对 URL，可以将 false 作为第三个参数传递给该函数：

php

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

`secure_asset()`

secure_asset 函数生成一个使用 HTTPS 的资产 URL：

php

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

`secure_url()`

secure_url 函数为给定路径生成一个完整的 HTTPS URL。可以将额外的 URL 段作为函数的第二个参数传递：

php

$url = secure_url('user/profile');

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

`to_route()`

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

php

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

如果需要，您可以将应分配给重定向的 HTTP 状态代码和任何附加响应头作为第三和第四个参数传递给 to_route 方法：

php

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

`url()`

url 函数为给定路径生成一个完整的 URL：

php

$url = url('user/profile');

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

如果未提供路径，将返回一个 Illuminate\Routing\UrlGenerator 实例：

php

$current = url()->current();

$full = url()->full();

$previous = url()->previous();

杂项

`abort()`

abort 函数抛出一个 HTTP 异常，该异常将由异常处理程序渲染：

php

abort(403);

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

php

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

`abort_if()`

abort_if 函数在给定布尔表达式评估为 true 时抛出 HTTP 异常：

php

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

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

`abort_unless()`

abort_unless 函数在给定布尔表达式评估为 false 时抛出 HTTP 异常：

php

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

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

`app()`

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

php

$container = app();

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

php

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

`auth()`

auth 函数返回一个认证器实例。您可以将其用作 Auth facade 的替代：

php

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

如果需要，您可以指定要访问的守卫实例：

php

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

`back()`

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

php

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

return back();

`bcrypt()`

bcrypt 函数使用 Bcrypt 哈希给定值。您可以将此函数用作 Hash facade 的替代：

php

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

`blank()`

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

php

blank('');
blank('   ');
blank(null);
blank(collect());

// true

blank(0);
blank(true);
blank(false);

// false

有关 blank 的反义词，请参见 filled 方法。

`broadcast()`

broadcast 函数广播给定的事件给其监听者：

php

broadcast(new UserRegistered($user));

broadcast(new UserRegistered($user))->toOthers();

`cache()`

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

php

$value = cache('key');

$value = cache('key', 'default');

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

php

cache(['key' => 'value'], 300);

cache(['key' => 'value'], now()->addSeconds(10));

`class_uses_recursive()`

class_uses_recursive 函数返回类使用的所有特性，包括其所有父类使用的特性：

php

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

`collect()`

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

php

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

`config()`

config 函数获取配置变量的值。可以使用“点”语法访问配置值，其中包括文件的名称和您希望访问的选项。可以指定默认值，如果配置选项不存在，则返回该值：

php

$value = config('app.timezone');

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

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

php

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

`context()`

context 函数从当前上下文获取值。如果上下文键不存在，可以指定默认值并返回：

php

$value = context('trace_id');

$value = context('trace_id', $default);

您可以通过传递键/值对的数组来设置上下文值：

php

use Illuminate\Support\Str;

context(['trace_id' => Str::uuid()->toString()]);

`cookie()`

cookie 函数创建一个新的 cookie 实例：

php

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

`csrf_field()`

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

php

{{ csrf_field() }}

`csrf_token()`

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

php

$token = csrf_token();

`decrypt()`

decrypt 函数解密给定值。您可以将此函数用作 Crypt facade 的替代：

php

$password = decrypt($value);

`dd()`

dd 函数转储给定变量并结束脚本的执行：

php

dd($value);

dd($value1, $value2, $value3, ...);

如果您不想在转储变量后停止脚本的执行，请使用 dump 函数。

`dispatch()`

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

php

dispatch(new App\Jobs\SendEmails);

`dispatch_sync()`

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

php

dispatch_sync(new App\Jobs\SendEmails);

`dump()`

dump 函数转储给定变量：

php

dump($value);

dump($value1, $value2, $value3, ...);

如果您希望在转储变量后停止脚本的执行，请使用 dd 函数。

`encrypt()`

encrypt 函数加密给定值。您可以将此函数用作 Crypt facade 的替代：

php

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

`env()`

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

php

$env = env('APP_ENV');

$env = env('APP_ENV', 'production');

如果您在部署过程中执行 config:cache 命令，则应确保仅在配置文件中调用 env 函数。一旦配置被缓存，.env 文件将不会被加载，所有对 env 函数的调用将返回 null。

`event()`

event 函数将给定的事件分派给其监听者：

php

event(new UserRegistered($user));

`fake()`

fake 函数从容器中解析一个 Faker 单例，这在创建模型工厂、数据库填充、测试和原型视图时非常有用：

blade

@for($i = 0; $i < 10; $i++)
    <dl>
        <dt>姓名</dt>
        <dd>{{ fake()->name() }}</dd>

        <dt>电子邮件</dt>
        <dd>{{ fake()->unique()->safeEmail() }}</dd>
    </dl>
@endfor

默认情况下，fake 函数将利用 config/app.php 配置中的 app.faker_locale 配置选项。通常，此配置选项通过 APP_FAKER_LOCALE 环境变量设置。您还可以通过将其传递给 fake 函数来指定区域设置。每个区域设置将解析一个单独的单例：

php

fake('nl_NL')->name()

`filled()`

filled 函数确定给定值是否不是“空”：

php

filled(0);
filled(true);
filled(false);

// true

filled('');
filled('   ');
filled(null);
filled(collect());

// false

有关 filled 的反义词，请参见 blank 方法。

`info()`

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

php

info('一些有用的信息！');

还可以将上下文数据的数组传递给该函数：

php

info('用户登录尝试失败。', ['id' => $user->id]);

`literal()`

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

php

$obj = literal(
    name: 'Joe',
    languages: ['PHP', 'Ruby'],
);

$obj->name; // 'Joe'
$obj->languages; // ['PHP', 'Ruby']

`logger()`

logger 函数可用于向日志写入 debug 级别的消息：

php

logger('调试消息');

还可以将上下文数据的数组传递给该函数：

php

logger('用户已登录。', ['id' => $user->id]);

如果未传递值，则将返回一个 logger 实例：

php

logger()->error('您不被允许在此处。');

`method_field()`

method_field 函数生成一个 HTML hidden 输入字段，包含表单 HTTP 动词的伪造值。例如，使用 Blade 语法：

php

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

`now()`

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

php

$now = now();

`old()`

old 函数检索旧输入值，该值已闪存到会话中：

php

$value = old('value');

$value = old('value', 'default');

由于提供给 old 函数的“默认值”作为第二个参数通常是 Eloquent 模型的属性，因此 Laravel 允许您简单地将整个 Eloquent 模型作为 old 函数的第二个参数传递。在这样做时，Laravel 将假定提供给 old 函数的第一个参数是应视为“默认值”的 Eloquent 属性的名称：

php

{{ old('name', $user->name) }}

// 等同于...

{{ old('name', $user) }}

`once()`

once 函数执行给定的回调并在请求期间将结果缓存到内存中。对同一回调的后续调用将返回先前缓存的结果：

php

function random(): int
{
    return once(function () {
        return random_int(1, 1000);
    });
}

random(); // 123
random(); // 123 (缓存结果)
random(); // 123 (缓存结果)

当 once 函数从对象实例中执行时，缓存的结果将是该对象实例唯一的：

php

<?php

class NumberService
{
    public function all(): array
    {
        return once(fn () => [1, 2, 3]);
    }
}

$service = new NumberService;

$service->all();
$service->all(); // (缓存结果)

$secondService = new NumberService;

$secondService->all();
$secondService->all(); // (缓存结果)

`optional()`

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

php

return optional($user->address)->street;

{!! old('name', optional($user)->name) !!}

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

php

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

`policy()`

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

php

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

`redirect()`

redirect 函数返回一个重定向 HTTP 响应，或者在没有参数时返回重定向器实例：

php

return redirect($to = null, $status = 302, $headers = [], $https = null);

return redirect('/home');

return redirect()->route('route.name');

`report()`

report 函数将使用您的异常处理程序报告异常：

php

report($e);

report 函数还接受一个字符串作为参数。当给定字符串时，该函数将创建一个异常，其消息为给定字符串：

php

report('发生了错误。');

`report_if()`

report_if 函数将在给定条件为 true 时使用您的异常处理程序报告异常：

php

report_if($shouldReport, $e);

report_if($shouldReport, '发生了错误。');

`report_unless()`

report_unless 函数将在给定条件为 false 时使用您的异常处理程序报告异常：

php

report_unless($reportingDisabled, $e);

report_unless($reportingDisabled, '发生了错误。');

`request()`

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

php

$request = request();

$value = request('key', $default);

`rescue()`

rescue 函数执行给定的闭包并捕获其执行过程中发生的任何异常。所有捕获的异常将发送到您的异常处理程序；但是，请求将继续处理：

php

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

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

php

return rescue(function () {
    return $this->method();
}, false);

return rescue(function () {
    return $this->method();
}, function () {
    return $this->failure();
});

可以向 rescue 函数提供一个 report 参数，以确定是否应通过 report 函数报告异常：

php

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

`resolve()`

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

php

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

`response()`

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

php

return response('Hello World', 200, $headers);

return response()->json(['foo' => 'bar'], 200, $headers);

`retry()`

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

php

return retry(5, function () {
    // 尝试 5 次，每次间隔 100 毫秒...
}, 100);

如果您希望手动计算尝试之间的毫秒数，可以将闭包作为第三个参数传递给 retry 函数：

php

use Exception;

return retry(5, function () {
    // ...
}, function (int $attempt, Exception $exception) {
    return $attempt * 100;
});

为了方便，您可以将数组作为 retry 函数的第一个参数。此数组将用于确定在后续尝试之间睡眠多少毫秒：

php

return retry([100, 200], function () {
    // 第一次重试睡眠 100 毫秒，第二次重试睡眠 200 毫秒...
});

要仅在特定条件下重试，您可以将闭包作为 retry 函数的第四个参数传递：

php

use Exception;

return retry(5, function () {
    // ...
}, 100, function (Exception $exception) {
    return $exception instanceof RetryException;
});

`session()`

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

php

$value = session('key');

您可以通过传递键/值对的数组来设置值：

php

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

如果未传递值，则将返回会话存储：

php

$value = session()->get('key');

session()->put('key', $value);

`tap()`

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

php

$user = tap(User::first(), function (User $user) {
    $user->name = 'taylor';

    $user->save();
});

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

php

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

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

php

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

`throw_if()`

throw_if 函数在给定布尔表达式评估为 true 时抛出给定异常：

php

throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);

throw_if(
    ! Auth::user()->isAdmin(),
    AuthorizationException::class,
    '您不被允许访问此页面。'
);

`throw_unless()`

throw_unless 函数在给定布尔表达式评估为 false 时抛出给定异常：

php

throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);

throw_unless(
    Auth::user()->isAdmin(),
    AuthorizationException::class,
    '您不被允许访问此页面。'
);

`today()`

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

php

$today = today();

`trait_uses_recursive()`

trait_uses_recursive 函数返回特性使用的所有特性：

php

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

`transform()`

transform 函数在给定值上执行闭包（如果该值不是空），然后返回闭包的返回值：

php

$callback = function (int $value) {
    return $value * 2;
};

$result = transform(5, $callback);

// 10

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

php

$result = transform(null, $callback, '该值为空');

// 该值为空

`validator()`

validator 函数使用给定参数创建一个新的验证器实例。您可以将其用作 Validator facade 的替代：

php

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

`value()`

value 函数返回它所给的值。但是，如果您传递一个闭包给该函数，则将执行该闭包并返回其返回值：

php

$result = value(true);

// true

$result = value(function () {
    return false;
});

// false

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

php

$result = value(function (string $name) {
    return $name;
}, 'Taylor');

// 'Taylor'

`view()`

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

php

return view('auth.login');

`with()`

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

php

$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()`

when 函数返回给定条件为 true 时所给的值。否则，返回 null。如果将闭包作为第二个参数传递给该函数，则将执行该闭包并返回其返回值：

php

$value = when(true, 'Hello World');

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

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

blade

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

其他实用工具

基准测试

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

php

<?php

use App\Models\User;
use Illuminate\Support\Benchmark;

Benchmark::dd(fn () => User::find(1)); // 0.1 ms

Benchmark::dd([
    '场景 1' => fn () => User::count(), // 0.5 ms
    '场景 2' => fn () => User::all()->count(), // 20.0 ms
]);

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

要调用回调多次，您可以将回调应调用的迭代次数作为第二个参数传递给该方法。当执行回调多次时，Benchmark 类将返回在所有迭代中执行回调所需的平均毫秒数：

php

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

有时，您可能希望在仍然获得回调返回值的情况下基准测试回调的执行。value 方法将返回一个元组，包含回调返回的值和执行回调所需的毫秒数：

php

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

日期

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

php

$now = now();

或者，您可以使用 Illuminate\Support\Carbon 类创建一个新的 Carbon 实例：

php

use Illuminate\Support\Carbon;

$now = Carbon::now();

有关 Carbon 及其功能的详细讨论，请参阅官方 Carbon 文档。

延迟函数

延迟函数目前处于测试阶段，我们正在收集社区反馈。

虽然 Laravel 的队列作业允许您将任务排队以进行后台处理，但有时您可能希望延迟执行某些简单任务，而无需配置或维护长时间运行的队列工作者。

延迟函数允许您在 HTTP 响应发送给用户后延迟执行闭包，从而使您的应用程序感觉快速和响应。要延迟执行闭包，只需将闭包传递给 Illuminate\Support\defer 函数：

php

use App\Services\Metrics;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use function Illuminate\Support\defer;

Route::post('/orders', function (Request $request) {
    // 创建订单...

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

    return $order;
});

默认情况下，延迟函数仅在调用 Illuminate\Support\defer 的 HTTP 响应、Artisan 命令或队列作业成功完成时执行。这意味着，如果请求导致 4xx 或 5xx HTTP 响应，则不会执行延迟函数。如果您希望延迟函数始终执行，可以将 always 方法链接到您的延迟函数：

php

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

取消延迟函数

如果您需要在延迟函数执行之前取消它，可以使用 forget 方法通过其名称取消该函数。要为延迟函数命名，请将第二个参数提供给 Illuminate\Support\defer 函数：

php

defer(fn () => Metrics::report(), 'reportMetrics');

defer()->forget('reportMetrics');

延迟函数兼容性

如果您从 Laravel 10.x 升级到 Laravel 11.x 应用程序，并且您的应用程序骨架仍包含 app/Http/Kernel.php 文件，则应将 InvokeDeferredCallbacks 中间件添加到内核的 $middleware 属性的开头：

php

protected $middleware = [
    \Illuminate\Foundation\Http\Middleware\InvokeDeferredCallbacks::class, 
    \App\Http\Middleware\TrustProxies::class,
    // ...
];

在测试中禁用延迟函数

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

PestPHPUnit

php

test('without defer', function () {
    $this->withoutDefer();

    // ...
});

php

use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_without_defer(): void
    {
        $this->withoutDefer();

        // ...
    }
}

如果您希望在测试用例中的所有测试中禁用延迟函数，可以在基类 TestCase 类的 setUp 方法中调用 withoutDefer 方法：

php

<?php

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    protected function setUp(): void// [tl! add:start]
    {
        parent::setUp();

        $this->withoutDefer();
    }// [tl! add:end]
}

彩票

Laravel 的彩票类可用于根据给定的几率执行回调。这在您只想为一定比例的传入请求执行代码时特别有用：

php

use Illuminate\Support\Lottery;

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

您可以将 Laravel 的彩票类与其他 Laravel 功能结合使用。例如，您可能希望仅报告一小部分慢查询到您的异常处理程序。由于彩票类是可调用的，因此我们可以将该类的实例传递给任何接受可调用的函数：

php

use Carbon\CarbonInterval;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Lottery;

DB::whenQueryingForLongerThan(
    CarbonInterval::seconds(2),
    Lottery::odds(1, 100)->winner(fn () => report('查询 > 2 秒。')),
);

测试彩票

Laravel 提供了一些简单的方法，允许您轻松测试应用程序的彩票调用：

php

// 彩票将始终获胜...
Lottery::alwaysWin();

// 彩票将始终失败...
Lottery::alwaysLose();

// 彩票将先获胜再失败，最后恢复正常行为...
Lottery::fix([true, false]);

// 彩票将恢复正常行为...
Lottery::determineResultsNormally();

管道

Laravel 的 Pipeline facade 提供了一种方便的方式来将给定的输入通过一系列可调用的类、闭包或可调用对象进行“管道化”，使每个类都有机会检查或修改输入并调用管道中的下一个可调用对象：

php

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

如您所见，管道中的每个可调用类或闭包都提供了输入和一个 $next 闭包。调用 $next 闭包将调用管道中的下一个可调用对象。正如您可能注意到的，这与中间件非常相似。

当管道中的最后一个可调用对象调用 $next 闭包时，将调用提供给 then 方法的可调用对象。通常，这个可调用对象将简单地返回给定的输入。

当然，正如之前讨论的，您并不局限于向管道提供闭包。您还可以提供可调用类。如果提供了类名，Laravel 的服务容器将实例化该类，从而允许将依赖项注入到可调用类中：

php

$user = Pipeline::send($user)
            ->through([
                GenerateProfilePhoto::class,
                ActivateSubscription::class,
                SendWelcomeEmail::class,
            ])
            ->then(fn (User $user) => $user);

睡眠

Laravel 的 Sleep 类是 PHP 原生 sleep 和 usleep 函数的轻量级封装，提供了更好的可测试性，同时还提供了一个开发者友好的 API 来处理时间：

php

use Illuminate\Support\Sleep;

$waiting = true;

while ($waiting) {
    Sleep::for(1)->second();

    $waiting = /* ... */;
}

Sleep 类提供了多种方法，允许您使用不同的时间单位：

php

// 在睡眠后返回一个值...
$result = Sleep::for(1)->second()->then(fn () => 1 + 1);

// 在给定值为 true 时睡眠...
Sleep::for(1)->second()->while(fn () => shouldKeepSleeping());

// 暂停执行 90 秒...
Sleep::for(1.5)->minutes();

// 暂停执行 2 秒...
Sleep::for(2)->seconds();

// 暂停执行 500 毫秒...
Sleep::for(500)->milliseconds();

// 暂停执行 5,000 微秒...
Sleep::for(5000)->microseconds();

// 暂停执行直到给定时间...
Sleep::until(now()->addMinute());

// PHP 原生 "sleep" 函数的别名...
Sleep::sleep(2);

// PHP 原生 "usleep" 函数的别名...
Sleep::usleep(5000);

要轻松组合时间单位，您可以使用 and 方法：

php

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

测试睡眠

在测试使用 Sleep 类或 PHP 原生睡眠函数的代码时，您的测试将暂停执行。正如您所预期的，这会使您的测试套件显著变慢。例如，假设您正在测试以下代码：

php

$waiting = /* ... */;

$seconds = 1;

while ($waiting) {
    Sleep::for($seconds++)->seconds();

    $waiting = /* ... */;
}

通常，测试这段代码将至少需要一秒钟。幸运的是，Sleep 类允许我们“伪造”睡眠，以便我们的测试套件保持快速：

PestPHPUnit

php

it('waits until ready', function () {
    Sleep::fake();

    // ...
});

php

public function test_it_waits_until_ready()
{
    Sleep::fake();

    // ...
}

伪造 Sleep 类时，实际的执行暂停被绕过，从而使测试速度大大加快。

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

PestPHPUnit

php

it('checks if ready three times', function () {
    Sleep::fake();

    // ...

    Sleep::assertSequence([
        Sleep::for(1)->second(),
        Sleep::for(2)->seconds(),
        Sleep::for(3)->seconds(),
    ]);
}

php

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(),
    ]);
}

当然，Sleep 类还提供了多种其他断言供您在测试时使用：

php

use Carbon\CarbonInterval as Duration;
use Illuminate\Support\Sleep;

// 断言睡眠被调用了 3 次...
Sleep::assertSleptTimes(3);

// 断言睡眠的持续时间...
Sleep::assertSlept(function (Duration $duration): bool {
    return /* ... */;
}, times: 1);

// 断言 Sleep 类从未被调用...
Sleep::assertNeverSlept();

// 断言即使调用了 Sleep，也没有执行暂停发生...
Sleep::assertInsomniac();

有时，在您的应用代码中每当发生伪造睡眠时执行某个操作可能是有用的。为此，您可以向 whenFakingSleep 方法提供一个回调。在以下示例中，我们使用 Laravel 的时间操作助手来立即推进时间，直到每次睡眠的持续时间：

php

use Carbon\CarbonInterval as Duration;

$this->freezeTime();

Sleep::fake();

Sleep::whenFakingSleep(function (Duration $duration) {
    // 在伪造睡眠时推进时间...
    $this->travel($duration->totalMilliseconds)->milliseconds();
});

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

php

Sleep::fake(syncWithCarbon: true);

$start = now();

Sleep::for(1)->second();

$start->diffForHumans(); // 1 秒前

Laravel 在暂停执行时内部使用 Sleep 类。例如，retry 辅助函数在睡眠时使用 Sleep 类，从而在使用该辅助函数时提高了可测试性。

辅助工具 ​

介绍 ​

可用方法 ​

数组与对象 ​

数字 ​

路径 ​

URLs ​

杂项 ​

数组与对象 ​

Arr::accessible() ​

Arr::add() ​

Arr::collapse() ​

Arr::crossJoin() ​

Arr::divide() ​

Arr::dot() ​

Arr::except() ​

Arr::exists() ​

Arr::first() ​

Arr::flatten() ​

Arr::forget() ​

Arr::get() ​

Arr::has() ​

Arr::hasAny() ​

Arr::isAssoc() ​

Arr::isList() ​

Arr::join() ​

Arr::keyBy() ​

Arr::last() ​

Arr::map() ​

Arr::mapSpread() ​

Arr::mapWithKeys() ​

Arr::only() ​

Arr::pluck() ​

Arr::prepend() ​

Arr::prependKeysWith() ​

Arr::pull() ​

Arr::query() ​

Arr::random() ​

Arr::set() ​

Arr::shuffle() ​

Arr::sort() ​

Arr::sortDesc() ​

Arr::sortRecursive() ​

Arr::take() ​

Arr::toCssClasses() ​

Arr::toCssStyles() ​

Arr::undot() ​

Arr::where() ​

Arr::whereNotNull() ​

Arr::wrap() ​

data_fill() ​

data_get() ​

data_set() ​

data_forget() ​

head() ​

last() ​

数字 ​

Number::abbreviate() ​

Number::clamp() ​

Number::currency() ​

Number::defaultCurrency() ​

Number::defaultLocale() ​

Number::fileSize() ​

Number::forHumans() ​

Number::format() ​

Number::ordinal() ​

Number::pairs() ​

Number::percentage() ​

Number::spell() ​

Number::trim() ​

Number::useLocale() ​

Number::withLocale() ​

Number::useCurrency() ​

Number::withCurrency() ​

app_path() ​

base_path() ​

config_path() ​

database_path() ​

lang_path() ​

mix() ​

辅助工具

介绍

可用方法

数组与对象

数字

路径

URLs

杂项

数组与对象

`Arr::accessible()`

`Arr::add()`

`Arr::collapse()`

`Arr::crossJoin()`

`Arr::divide()`

`Arr::dot()`

`Arr::except()`

`Arr::exists()`

`Arr::first()`

`Arr::flatten()`

`Arr::forget()`

`Arr::get()`

`Arr::has()`

`Arr::hasAny()`

`Arr::isAssoc()`

`Arr::isList()`

`Arr::join()`

`Arr::keyBy()`

`Arr::last()`

`Arr::map()`

`Arr::mapSpread()`

`Arr::mapWithKeys()`

`Arr::only()`

`Arr::pluck()`

`Arr::prepend()`

`Arr::prependKeysWith()`

`Arr::pull()`

`Arr::query()`

`Arr::random()`

`Arr::set()`

`Arr::shuffle()`

`Arr::sort()`

`Arr::sortDesc()`

`Arr::sortRecursive()`

`Arr::take()`

`Arr::toCssClasses()`

`Arr::toCssStyles()`

`Arr::undot()`

`Arr::where()`

`Arr::whereNotNull()`

`Arr::wrap()`

`data_fill()`

`data_get()`

`data_set()`

`data_forget()`

`head()`

`last()`

数字

`Number::abbreviate()`

`Number::clamp()`

`Number::currency()`

`Number::defaultCurrency()`

`Number::defaultLocale()`

`Number::fileSize()`

`Number::forHumans()`

`Number::format()`

`Number::ordinal()`

`Number::pairs()`

`Number::percentage()`

`Number::spell()`

`Number::trim()`

`Number::useLocale()`

`Number::withLocale()`

`Number::useCurrency()`

`Number::withCurrency()`

`app_path()`

`base_path()`

`config_path()`

`database_path()`

`lang_path()`

`mix()`