辅助函数

简介
可用方法
其他实用工具

简介

Laravel 包含各种全局「辅助」PHP 函数。其中许多函数被框架本身使用；但是，如果您觉得方便，可以在自己的应用程序中自由使用它们。

可用方法

数组与对象

数字

路径

app_path base_path config_path database_path lang_path public_path resource_path storage_path

URL

action asset route secure_asset secure_url to_action to_route uri url

杂项

数组与对象

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

Arr::array 方法使用「点」符号从深层嵌套数组中检索值（就像 Arr::get() 一样），但如果请求的值不是 array，则抛出 InvalidArgumentException：

php

use Illuminate\Support\Arr;

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

$value = Arr::array($array, 'languages');

// ['PHP', 'Ruby']

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

// 抛出 InvalidArgumentException

`Arr::boolean()`

Arr::boolean 方法使用「点」符号从深层嵌套数组中检索值（就像 Arr::get() 一样），但如果请求的值不是 boolean，则抛出 InvalidArgumentException：

php

use Illuminate\Support\Arr;

$array = ['name' => 'Joe', 'available' => true];

$value = Arr::boolean($array, 'available');

// true

$value = Arr::boolean($array, 'name');

// 抛出 InvalidArgumentException

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

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

php

use Illuminate\Support\Arr;

$array = [1, 2, 3];

Arr::every($array, fn ($i) => $i > 0);

// true

Arr::every($array, fn ($i) => $i > 2);

// false

`Arr::except()`

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

php

use Illuminate\Support\Arr;

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

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

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

`Arr::exceptValues()`

Arr::exceptValues 方法从数组中删除指定的值：

php

use Illuminate\Support\Arr;

$array = ['foo', 'bar', 'baz', 'qux'];

$filtered = Arr::exceptValues($array, ['foo', 'baz']);

// ['bar', 'qux']

您还可以向 strict 参数传递 true 以在过滤时使用严格类型比较：

php

use Illuminate\Support\Arr;

$array = [1, '1', 2, '2'];

$filtered = Arr::exceptValues($array, [1, 2], strict: true);

// ['1', '2']

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

Arr::float 方法使用「点」符号从深层嵌套数组中检索值（就像 Arr::get() 一样），但如果请求的值不是 float，则抛出 InvalidArgumentException：

php

use Illuminate\Support\Arr;

$array = ['name' => 'Joe', 'balance' => 123.45];

$value = Arr::float($array, 'balance');

// 123.45

$value = Arr::float($array, 'name');

// 抛出 InvalidArgumentException

`Arr::forget()`

Arr::forget 方法使用「点」符号从深层嵌套数组中删除给定的键/值对：

php

use Illuminate\Support\Arr;

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

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

// ['products' => []]

`Arr::from()`

Arr::from 方法将各种输入类型转换为普通 PHP 数组。它支持一系列输入类型，包括数组、对象和几个常见的 Laravel 接口，如 Arrayable、Enumerable、Jsonable 和 JsonSerializable。此外，它还处理 Traversable 和 WeakMap 实例：

php

use Illuminate\Support\Arr;

Arr::from((object) ['foo' => 'bar']); // ['foo' => 'bar']

class TestJsonableObject implements Jsonable
{
    public function toJson($options = 0)
    {
        return json_encode(['foo' => 'bar']);
    }
}

Arr::from(new TestJsonableObject); // ['foo' => 'bar']

`Arr::get()`

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

Arr::hasAll 方法使用「点」符号确定所有指定的键是否存在于给定数组中：

php

use Illuminate\Support\Arr;

$array = ['name' => 'Taylor', 'language' => 'PHP'];

Arr::hasAll($array, ['name']); // true
Arr::hasAll($array, ['name', 'language']); // true
Arr::hasAll($array, ['name', 'IDE']); // false

`Arr::hasAny()`

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

Arr::integer 方法使用「点」符号从深层嵌套数组中检索值（就像 Arr::get() 一样），但如果请求的值不是 int，则抛出 InvalidArgumentException：

php

use Illuminate\Support\Arr;

$array = ['name' => 'Joe', 'age' => 42];

$value = Arr::integer($array, 'age');

// 42

$value = Arr::integer($array, 'name');

// 抛出 InvalidArgumentException

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

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

php

use Illuminate\Support\Arr;

$array = ['foo', 'bar', 'baz', 'qux'];

$filtered = Arr::onlyValues($array, ['foo', 'baz']);

// ['foo', 'baz']

您还可以向 strict 参数传递 true 以在过滤时使用严格类型比较：

php

use Illuminate\Support\Arr;

$array = [1, '1', 2, '2'];

$filtered = Arr::onlyValues($array, [1, 2], strict: true);

// [1, 2]

`Arr::partition()`

Arr::partition 方法可以与 PHP 数组解构结合使用，将数组分为两个数组，一个包含通过给定真值测试的元素，另一个不包含：

php

use Illuminate\Support\Arr;

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

[$even, $odd] = Arr::partition($array, fn ($i) => $i % 2 === 0);

// $even: [2, 4]
// $odd: [1, 3]

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

Arr::push 方法将项推送到数组的末尾：

php

use Illuminate\Support\Arr;

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

Arr::push($array, 'three', 'four');

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

`Arr::query()`

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

php

use Illuminate\Support\Arr;

$array = ['name' => 'Taylor', 'order' => ['column' => 'created_at', 'direction' => 'desc']];

$query = 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::reject()`

Arr::reject 方法使用给定的闭包从数组中过滤元素：

php

use Illuminate\Support\Arr;

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

$filtered = Arr::reject($array, fn ($value, $key) => $value > 2);

// [1, 2]

`Arr::select()`

Arr::select 方法从数组中的对象或数组中选择特定键：

php

use Illuminate\Support\Arr;

$users = [
    ['name' => 'Taylor Otwell', 'role' => 'Developer', 'status' => 'active'],
    ['name' => 'Victoria Faith', 'role' => 'Researcher', 'status' => 'active'],
];

$selected = Arr::select($users, ['name', 'role']);

/*
    [
        ['name' => 'Taylor Otwell', 'role' => 'Developer'],
        ['name' => 'Victoria Faith', 'role' => 'Researcher'],
    ]
*/

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

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

php

use Illuminate\Support\Arr;

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

$sole = Arr::sole($array, fn ($value, $key) => $value === 2);

// 2

如果数组中有多个元素通过真值测试，将抛出 MultipleItemsFoundException 异常。如果没有元素通过真值测试，将抛出 ItemNotFoundException 异常。

`Arr::some()`

Arr::some 方法确定数组中是否有任何元素通过给定的真值测试：

php

use Illuminate\Support\Arr;

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

$hasEven = Arr::some($array, fn ($value, $key) => $value % 2 === 0);

// true

`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, fn ($value) => $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, fn ($value) => $value['name']));

/*
    [
        ['name' => 'Table'],
        ['name' => 'Desk'],
        ['name' => 'Chair'],
    ]
*/

`Arr::sortRecursive()`

Arr::sortRecursive 方法递归地对数组进行排序：

php

use Illuminate\Support\Arr;

$array = [
    ['PHP', 'Ruby', 'JavaScript'],
    ['one' => 1, 'two' => 2, 'three' => 3],
];

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

/*
    [
        ['JavaScript', 'PHP', 'Ruby'],
        ['one' => 1, 'three' => 3, 'two' => 2],
    ]
*/

`Arr::string()`

Arr::string 方法使用「点」符号从深层嵌套数组中检索值（就像 Arr::get() 一样），但如果请求的值不是 string，则抛出 InvalidArgumentException：

php

use Illuminate\Support\Arr;

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

$value = Arr::string($array, 'name');

// 'Joe'

$value = Arr::string($array, 'languages');

// 抛出 InvalidArgumentException

`Arr::take()`

Arr::take 方法从数组中返回指定数量的项目：

php

use Illuminate\Support\Arr;

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

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

// [1, 2, 3]

您可以传递负数以从数组末尾获取指定数量的项目：

php

use Illuminate\Support\Arr;

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

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

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

此方法为 Laravel 的功能 Blade 组件提供动力，如 @class Blade 指令。

`Arr::toCssStyles()`

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

php

use Illuminate\Support\Arr;

$hasColor = true;

$array = ['font-weight: bold', 'color: blue' => $hasColor];

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

/*
    'font-weight: bold; color: blue;'
*/

此方法为 Laravel 的功能 Blade 组件提供动力，如 @style Blade 指令。

`Arr::undot()`

Arr::undot 方法将使用「点」符号的单维数组扩展为多维数组：

php

use Illuminate\Support\Arr;

$array = [
    'user.name' => 'Taylor',
    'user.age' => 30,
    'user.city' => 'New York',
];

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

/*
    [
        'user' => [
            'name' => 'Taylor',
            'age' => 30,
            'city' => 'New York',
        ],
    ]
*/

`Arr::where()`

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

php

use Illuminate\Support\Arr;

$array = [100, '200', 300, '400'];

$filtered = Arr::where($array, fn ($value, $key) => 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'];

`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

默认情况下，该方法将数字四舍五入到最接近的整数。但是，您可以使用 precision 命名参数指定精度：

php

use Illuminate\Support\Number;

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

// 489.94K

`Number::clamp()`

Number::clamp 方法确保给定数字在指定范围内。如果数字超出范围，将返回范围的边界值：

php

use Illuminate\Support\Number;

$number = Number::clamp(105, min: 1, max: 100);

// 100

$number = Number::clamp(5, min: 1, max: 100);

// 5

`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

您还可以使用 precision 命名参数指定精度：

php

use Illuminate\Support\Number;

$currency = Number::currency(1000, precision: 0);

// $1,000

`Number::defaultCurrency()`

Number::defaultCurrency 方法返回应用程序的默认货币：

php

use Illuminate\Support\Number;

$currency = Number::defaultCurrency();

// USD

`Number::defaultLocale()`

Number::defaultLocale 方法返回应用程序的默认区域设置：

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

您可以使用 precision 命名参数指定精度：

php

use Illuminate\Support\Number;

$size = Number::fileSize(1024 * 1024, precision: 2);

// 1.00 MB

`Number::forHumans()`

Number::forHumans 方法将给定数字格式化为人类可读的格式：

php

use Illuminate\Support\Number;

$number = Number::forHumans(1000);

// 1 thousand

$number = Number::forHumans(489939);

// 490 thousand

您可以使用 precision 命名参数指定精度：

php

use Illuminate\Support\Number;

$number = Number::forHumans(489939, precision: 2);

// 489.94 thousand

`Number::format()`

Number::format 方法将给定数字格式化为区域设置感知的字符串：

php

use Illuminate\Support\Number;

$number = Number::format(100000);

// 100,000

$number = Number::format(100000, locale: 'de');

// 100.000

您可以使用 precision 命名参数指定精度：

php

use Illuminate\Support\Number;

$number = Number::format(100000.123, precision: 2);

// 100,000.12

`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 方法将数字分解为范围对：

php

use Illuminate\Support\Number;

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

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

`Number::parseInt()`

Number::parseInt 方法从字符串中解析整数：

php

use Illuminate\Support\Number;

$number = Number::parseInt('1,000');

// 1000

`Number::parseFloat()`

Number::parseFloat 方法从字符串中解析浮点数：

php

use Illuminate\Support\Number;

$number = Number::parseFloat('1,000.50');

// 1000.5

`Number::percentage()`

Number::percentage 方法将给定值格式化为百分比：

php

use Illuminate\Support\Number;

$percentage = Number::percentage(50);

// 50%

$percentage = Number::percentage(50.123, precision: 2);

// 50.12%

`Number::spell()`

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

php

use Illuminate\Support\Number;

$number = Number::spell(100);

// one hundred

$number = Number::spell(100, in: 'de');

// einhundert

您可以使用 until 命名参数指定应拼写的最大数字：

php

use Illuminate\Support\Number;

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

// 100

`Number::spellOrdinal()`

Number::spellOrdinal 方法将给定数字转换为序数单词：

php

use Illuminate\Support\Number;

$number = Number::spellOrdinal(1);

// first

$number = Number::spellOrdinal(2);

// second

`Number::trim()`

Number::trim 方法删除给定数字末尾的任何零：

php

use Illuminate\Support\Number;

$number = Number::trim(100.00);

// 100

$number = Number::trim(100.50);

// 100.5

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

NOTE

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

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

URL

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

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

php

use App\Http\Controllers\UserController;

return to_action([UserController::class, 'show'], ['user' => 1]);

如有必要，您可以传递应分配给重定向的 HTTP 状态码和任何额外的响应头作为 to_action 方法的第三个和第四个参数：

php

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

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

`uri()`

uri 函数为给定 URI 生成流畅的 URI 实例：

php

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

如果 uri 函数被给定一个包含可调用控制器和方法对的数组，该函数将为控制器方法的路由路径创建一个 Uri 实例：

php

use App\Http\Controllers\UserController;

$uri = uri([UserController::class, 'show'], ['user' => $user]);

如果控制器是可调用的，您可以简单地提供控制器类名：

php

use App\Http\Controllers\UserIndexController;

$uri = uri(UserIndexController::class);

如果传递给 uri 函数的值与命名路由的名称匹配，将为该路由的路径生成一个 Uri 实例：

php

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

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

有关使用 url 函数的更多信息，请参阅 URL 生成文档。

杂项

`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 门面的替代：

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 门面的替代：

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

`broadcast_if()`

broadcast_if 函数在给定的布尔表达式求值为 true 时将给定的事件广播给其监听器：

php

broadcast_if($user->isActive(), new UserRegistered($user));

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

`broadcast_unless()`

broadcast_unless 函数在给定的布尔表达式求值为 false 时将给定的事件广播给其监听器：

php

broadcast_unless($user->isBanned(), new UserRegistered($user));

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

`cache()`

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

php

$value = cache('key');

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

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

php

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

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

`class_uses_recursive()`

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

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 函数生成一个包含 CSRF 令牌值的 HTML hidden 输入字段。例如，使用 Blade 语法：

blade

{{ csrf_field() }}

`csrf_token()`

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

php

$token = csrf_token();

`decrypt()`

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

php

$password = decrypt($value);

对于 decrypt 的反向，请参阅 encrypt 函数。

`dd()`

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

php

dd($value);

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

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

`dispatch()`

dispatch 函数将给定的任务推送到 Laravel 任务队列：

php

dispatch(new App\Jobs\SendEmails);

`dispatch_sync()`

dispatch_sync 函数将给定任务推送到 sync 队列，以便立即处理：

php

dispatch_sync(new App\Jobs\SendEmails);

`dump()`

dump 函数转储给定的变量：

php

dump($value);

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

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

`encrypt()`

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

php

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

对于 encrypt 的反向，请参阅 decrypt 函数。

`env()`

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

php

$env = env('APP_ENV');

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

WARNING

如果您在部署过程中执行 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>Name</dt>
        <dd>{{ fake()->name() }}</dd>

        <dt>Email</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('Some helpful information!');

还可以向函数传递上下文数据数组：

```php
info('User login attempt', ['id' => $user->id]);

`logger()`

logger 函数可以将 debug 级别的消息写入日志：

php

logger('Debug message');

还可以向函数传递上下文数据数组：

php

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

如果函数没有传递值，将返回日志器实例：

php

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

`literal()`

literal 函数使用命名参数作为键和值创建一个新的匿名类实例。与创建匿名类相比，此函数提供了一种更符合人体工程学的方式来创建对象：

php

$obj = literal(
    name: 'Joe',
    language: 'PHP',
);

// $obj->name: 'Joe'
// $obj->language: 'PHP'

`method_field()`

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

blade

<form action="/foo/bar" method="POST">
    <input type="hidden" name="_method" value="PUT">
    <input type="hidden" name="_token" value="{{ csrf_token() }}">
</form>

您可以使用 method_field 辅助函数生成 _method 输入：

blade

<form action="/foo/bar" method="POST">
    {{ method_field('PUT') }}
    {{ csrf_field() }}
</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 属性或模型属性的名称，该属性名称将用作默认值：

blade

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

// 等同于...

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

`once()`

once 函数在请求期间仅执行给定的回调一次。对该函数的后续调用将返回第一次调用的结果：

php

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

random(); // 123
random(); // 123
random(); // 123

`optional()`

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

php

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

return optional($user->address)->street ?? 'Not specified';

return optional(User::find($id), function ($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($exception);

您也可以将字符串作为参数传递给 report 函数。当给定字符串时，该函数将创建一个以该字符串为消息的异常并报告它：

php

report('Something went wrong.');

`report_if()`

report_if 函数在给定条件为 true 时报告异常：

php

report_if($shouldReport, $exception);

您也可以将字符串作为第二个参数传递给 report_if 函数：

php

report_if($shouldReport, 'Something went wrong.');

`report_unless()`

report_unless 函数在给定条件为 false 时报告异常：

php

report_unless($reportingDisabled, $exception);

您也可以将字符串作为第二个参数传递给 report_unless 函数：

php

report_unless($reportingDisabled, 'Something went wrong.');

`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->failureMethod();
});

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

php

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

`resolve()`

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

php

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

`response()`

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

php

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

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

`retry()`

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

php

return retry(5, function () {
    // 尝试 5 次，每次尝试之间休息 100ms...
}, 100);

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

php

use Exception;

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

为了方便起见，您可以将数组作为第一个参数传递给 retry 函数，以指示每次尝试之间休眠的毫秒数：

php

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

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

php

use Exception;

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

`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 方法通常返回整数。但是，我们可以通过 tap 函数强制 update 方法返回模型本身：

php

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

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

php

<?php

namespace App\Models;

use Illuminate\Support\Traits\Tappable;

class User extends Model
{
    use Tappable;
}

现在，您可以在不将闭包传递给 tap 方法的情况下调用模型的 tap 方法：

php

$user = User::find(1)->tap(fn (User $user) => $user->update(['name' => 'Taylor']));

`throw_if()`

throw_if 函数在给定布尔表达式求值为 true 时抛出给定的异常：

php

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

throw_if(
    ! Auth::user()->isAdmin(),
    AuthorizationException::class,
    'You are not allowed to access this page.'
);

`throw_unless()`

throw_unless 函数在给定布尔表达式求值为 false 时抛出给定的异常：

php

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

throw_unless(
    Auth::user()->isAdmin(),
    AuthorizationException::class,
    'You are not allowed to access this page.'
);

`today()`

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

php

$today = today();

`trait_uses_recursive()`

trait_uses_recursive 函数返回 trait 使用的所有 trait，包括其所有父 trait 使用的 trait：

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, 'The value is blank');

// The value is blank

`validator()`

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

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

可以向视图传递数据：

php

return view('home', ['city' => 'Tokyo']);

`with()`

with 函数执行给定的闭包，并将值注入闭包，然后返回闭包的结果：

php

$callback = function (mixed $value) {
    return is_numeric($value) ? $value * 2 : 0;
};

$result = with(5, $callback);

// 10

`when()`

when 函数在给定条件为 true 时执行给定的闭包，并返回闭包的结果：

php

$result = when(true, function () {
    return 'Hello World';
});

// 'Hello World'

$result = when(false, function () {
    return 'Hello World';
});

// null

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

php

$result = when(false, function () {
    return 'Hello World';
}, function () {
    return 'Goodbye World';
});

// 'Goodbye World'

其他实用工具

基准测试

您可以测量应用程序关键部分的执行速度，使用 Benchmark 辅助类：

php

use Illuminate\Support\Benchmark;

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

Benchmark::dd([
    'Scenario 1' => fn () => User::with('posts')->find(1), // 0.5 ms
    'Scenario 2' => fn () => User::with('posts')->find(1), // 0.5 ms
]);

要仅在回调执行后检索基准数据，请使用 measure 方法：

php

use Illuminate\Support\Benchmark;

$time = Benchmark::measure(fn () => User::find(1));

// 0.1 ms

$times = Benchmark::measure([
    'Scenario 1' => fn () => User::with('posts')->find(1), // 0.5 ms
    'Scenario 2' => fn () => User::with('posts')->find(1), // 0.5 ms
]);

要确保特定的回调在一定时间内执行，可以使用 ddWhenSlow 方法：

php

use Illuminate\Support\Benchmark;

Benchmark::ddWhenSlow(100, fn () => User::find(1));

// 如果回调执行时间超过 100 毫秒，将转储并终止

日期和时间

Laravel 包含 Carbon，一个强大的日期和时间操作库。您可以通过 now 函数创建新的 Carbon 实例：

php

$now = now();

或者，您可以使用 today 函数创建今天的日期：

php

$today = today();

Carbon 提供了各种方法来操作和格式化日期：

php

$now = now();

$now->addDay();
$now->subWeek();
$now->format('Y-m-d H:i:s');
$now->isWeekend();
$now->diffForHumans();

有关使用 Carbon 的更多信息，请参阅 Carbon 文档。

延迟函数

Laravel 的 defer 函数允许您推迟执行给定的闭包，直到 HTTP 响应发送到浏览器之后：

php

use Illuminate\Support\defer;

defer(function () {
    // 在响应发送后执行...
});

您可以为延迟函数指定名称，以便在需要时取消它：

php

use Illuminate\Support\defer;

defer(function () {
    // ...
}, 'my-deferred-function');

defer()->forget('my-deferred-function');

抽奖

Laravel 的抽奖类可用于根据一组给定的赔率执行回调。当您只想执行一部分代码时，这可能特别有用：

php

use Illuminate\Support\Lottery;

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

您也可以将抽奖与其他功能结合使用，例如延迟函数：

php

use Illuminate\Support\defer;
use Illuminate\Support\Lottery;

defer(fn () => Lottery::odds(1, 20)
    ->winner(fn () => report('User won!'))
    ->loser(fn () => report('User lost.'))
    ->choose()
);

管道

Laravel 的管道类允许您将一系列可调用对象（管道）传递给给定的输入值：

php

use Illuminate\Support\Pipeline;

$result = Pipeline::send($value)
    ->through([
        function ($value, $next) {
            $value = $value + 1;

            return $next($value);
        },
        function ($value, $next) {
            $value = $value * 2;

            return $next($value);
        },
    ])
    ->then(function ($value) {
        return $value - 1;
    });

// $result = (($value + 1) * 2) - 1

睡眠

Laravel 的 Sleep 类是对 PHP 原生 sleep 和 usleep 函数的轻量级封装，提供更好的可测试性和流畅的 API：

php

use Illuminate\Support\Sleep;

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

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

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

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

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

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

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

您也可以组合不同的时间单位：

php

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

Sleep 类还提供了各种方法来暂停执行直到特定时间：

php

Sleep::until(now()->addMinute());

Sleep::until(timestamp: 1700000000);

在测试中，您可以使用 fake 方法来伪造睡眠：

php

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

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

    Sleep::assertSleptTimes(1);
}

时间盒

Laravel 的时间盒类用于在给定时间内执行代码块。如果代码块执行时间不足，时间盒将等待剩余时间：

php

use Illuminate\Support\Timebox;

(new Timebox)->call(function () {
    // 执行一些操作...
}, 1000); // 至少执行 1000 毫秒

这对于确保某些操作（如第三方 API 调用）花费一致的时间以防止时序攻击很有用。

URI

Laravel 的 Uri 类提供了一个流畅的接口来构建和操作 URI：

php

use Illuminate\Support\Uri;

$uri = Uri::of('https://laravel.com')
    ->withScheme('https')
    ->withHost('laravel.com')
    ->withPath('/docs')
    ->withQuery(['page' => 1]);

// https://laravel.com/docs?page=1

您可以使用 uri 辅助函数创建 Uri 实例：

php

$uri = uri('https://laravel.com')
    ->withPath('/docs')
    ->withQuery(['page' => 1]);

Uri 类提供了各种方法来操作 URI 的不同部分：

php

$uri = Uri::of('https://laravel.com/docs?page=1');

$uri->scheme(); // 'https'
$uri->host(); // 'laravel.com'
$uri->path(); // '/docs'
$uri->query(); // 'page=1'
$uri->query('page'); // '1'

您也可以使用 withoutQuery 方法删除查询参数：

php

$uri = Uri::of('https://laravel.com/docs?page=1')
    ->withoutQuery('page');

// https://laravel.com/docs

辅助函数 ​

简介 ​

可用方法 ​

数组与对象 ​

数字 ​

路径 ​

URL ​

杂项 ​

数组与对象 ​

Arr::accessible() ​

Arr::add() ​

Arr::array() ​

Arr::boolean() ​

Arr::collapse() ​

Arr::crossJoin() ​

Arr::divide() ​

Arr::dot() ​

Arr::every() ​

Arr::except() ​

Arr::exceptValues() ​

Arr::exists() ​

Arr::first() ​

Arr::flatten() ​

Arr::float() ​

Arr::forget() ​

Arr::from() ​

Arr::get() ​

Arr::has() ​

Arr::hasAll() ​

Arr::hasAny() ​

Arr::integer() ​

Arr::isAssoc() ​

Arr::isList() ​

Arr::join() ​

Arr::keyBy() ​

Arr::last() ​

Arr::map() ​

Arr::mapSpread() ​

Arr::mapWithKeys() ​

Arr::only() ​

Arr::onlyValues() ​

Arr::partition() ​

Arr::pluck() ​

Arr::prepend() ​

Arr::prependKeysWith() ​

Arr::pull() ​

Arr::push() ​

Arr::query() ​

Arr::random() ​

Arr::reject() ​

Arr::select() ​

Arr::set() ​

Arr::shuffle() ​

Arr::sole() ​

Arr::some() ​

Arr::sort() ​

Arr::sortDesc() ​

Arr::sortRecursive() ​

Arr::string() ​

Arr::take() ​

Arr::toCssClasses() ​

Arr::toCssStyles() ​

Arr::undot() ​

Arr::where() ​

Arr::whereNotNull() ​

Arr::wrap() ​

data_fill() ​

data_get() ​

data_set() ​

data_forget() ​

head() ​

last() ​

数字 ​

Number::abbreviate() ​

Number::clamp() ​

Number::currency() ​

Number::defaultCurrency() ​

Number::defaultLocale() ​

Number::fileSize() ​

Number::forHumans() ​

辅助函数

简介

可用方法

数组与对象

数字

路径

URL

杂项

数组与对象

`Arr::accessible()`

`Arr::add()`

`Arr::array()`

`Arr::boolean()`

`Arr::collapse()`

`Arr::crossJoin()`

`Arr::divide()`

`Arr::dot()`

`Arr::every()`

`Arr::except()`

`Arr::exceptValues()`

`Arr::exists()`

`Arr::first()`

`Arr::flatten()`

`Arr::float()`

`Arr::forget()`

`Arr::from()`

`Arr::get()`

`Arr::has()`

`Arr::hasAll()`

`Arr::hasAny()`

`Arr::integer()`

`Arr::isAssoc()`

`Arr::isList()`

`Arr::join()`

`Arr::keyBy()`

`Arr::last()`

`Arr::map()`

`Arr::mapSpread()`

`Arr::mapWithKeys()`

`Arr::only()`

`Arr::onlyValues()`

`Arr::partition()`

`Arr::pluck()`

`Arr::prepend()`

`Arr::prependKeysWith()`

`Arr::pull()`

`Arr::push()`

`Arr::query()`

`Arr::random()`

`Arr::reject()`

`Arr::select()`

`Arr::set()`

`Arr::shuffle()`

`Arr::sole()`

`Arr::some()`

`Arr::sort()`

`Arr::sortDesc()`

`Arr::sortRecursive()`

`Arr::string()`

`Arr::take()`

`Arr::toCssClasses()`

`Arr::toCssStyles()`

`Arr::undot()`

`Arr::where()`

`Arr::whereNotNull()`

`Arr::wrap()`

`data_fill()`

`data_get()`

`data_set()`

`data_forget()`

`head()`

`last()`

数字

`Number::abbreviate()`

`Number::clamp()`

`Number::currency()`

`Number::defaultCurrency()`

`Number::defaultLocale()`

`Number::fileSize()`

`Number::forHumans()`